blob: e6023c03b8c915e7cf8c94dbd2e500315888347e [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().
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003740 * struct {
3741 * opaque hostname<0..2^16-1>;
3742 * uint64 ticket_reception_time;
3743 * uint32 ticket_lifetime;
3744 * opaque ticket<1..2^16-1>;
3745 * } ClientOnlyData;
3746 *
3747 * struct {
3748 * uint32 ticket_age_add;
3749 * uint8 ticket_flags;
3750 * opaque resumption_key<0..255>;
3751 * uint32 max_early_data_size;
3752 * uint16 record_size_limit;
3753 * select ( endpoint ) {
3754 * case client: ClientOnlyData;
3755 * case server: uint64 ticket_creation_time;
3756 * };
3757 * } serialized_session_tls13;
3758 *
David Horstmanne59f9702024-02-29 16:08:57 +00003759 */
3760#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3761MBEDTLS_CHECK_RETURN_CRITICAL
3762static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3763 unsigned char *buf,
3764 size_t buf_len,
3765 size_t *olen)
3766{
3767 unsigned char *p = buf;
3768#if defined(MBEDTLS_SSL_CLI_C) && \
3769 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3770 size_t hostname_len = (session->hostname == NULL) ?
3771 0 : strlen(session->hostname) + 1;
3772#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003773
3774#if defined(MBEDTLS_SSL_SRV_C) && \
3775 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003776 const uint8_t alpn_len = (session->ticket_alpn == NULL) ?
3777 0 : (uint8_t) strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003778#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003779 size_t needed = 4 /* ticket_age_add */
3780 + 1 /* ticket_flags */
3781 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003782
David Horstmanne59f9702024-02-29 16:08:57 +00003783 *olen = 0;
3784
3785 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3786 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3787 }
3788 needed += session->resumption_key_len; /* resumption_key */
3789
3790#if defined(MBEDTLS_SSL_EARLY_DATA)
3791 needed += 4; /* max_early_data_size */
3792#endif
3793#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3794 needed += 2; /* record_size_limit */
3795#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3796
3797#if defined(MBEDTLS_HAVE_TIME)
3798 needed += 8; /* ticket_creation_time or ticket_reception_time */
3799#endif
3800
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003801#if defined(MBEDTLS_SSL_SRV_C)
3802 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3803#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3804 needed += 1 /* alpn_len */
3805 + alpn_len; /* alpn */
3806#endif
3807 }
3808#endif /* MBEDTLS_SSL_SRV_C */
3809
David Horstmanne59f9702024-02-29 16:08:57 +00003810#if defined(MBEDTLS_SSL_CLI_C)
3811 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3812#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3813 needed += 2 /* hostname_len */
3814 + hostname_len; /* hostname */
3815#endif
3816
3817 needed += 4 /* ticket_lifetime */
3818 + 2; /* ticket_len */
3819
3820 /* Check size_t overflow */
3821 if (session->ticket_len > SIZE_MAX - needed) {
3822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3823 }
3824
3825 needed += session->ticket_len; /* ticket */
3826 }
3827#endif /* MBEDTLS_SSL_CLI_C */
3828
3829 *olen = needed;
3830 if (needed > buf_len) {
3831 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3832 }
3833
3834 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3835 p[4] = session->ticket_flags;
3836
3837 /* save resumption_key */
3838 p[5] = session->resumption_key_len;
3839 p += 6;
3840 memcpy(p, session->resumption_key, session->resumption_key_len);
3841 p += session->resumption_key_len;
3842
3843#if defined(MBEDTLS_SSL_EARLY_DATA)
3844 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3845 p += 4;
3846#endif
3847#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3848 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3849 p += 2;
3850#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3851
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003852#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003853 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003854#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003855 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3856 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003857#endif /* MBEDTLS_HAVE_TIME */
3858
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003859#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3860 *p++ = alpn_len;
3861 if (alpn_len > 0) {
3862 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003863 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003864 p += alpn_len;
3865 }
3866#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3867 }
3868#endif /* MBEDTLS_SSL_SRV_C */
3869
David Horstmanne59f9702024-02-29 16:08:57 +00003870#if defined(MBEDTLS_SSL_CLI_C)
3871 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3872#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3873 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3874 p += 2;
3875 if (hostname_len > 0) {
3876 /* save host name */
3877 memcpy(p, session->hostname, hostname_len);
3878 p += hostname_len;
3879 }
3880#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3881
3882#if defined(MBEDTLS_HAVE_TIME)
3883 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3884 p += 8;
3885#endif
3886 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3887 p += 4;
3888
3889 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3890 p += 2;
3891
3892 if (session->ticket != NULL && session->ticket_len > 0) {
3893 memcpy(p, session->ticket, session->ticket_len);
3894 p += session->ticket_len;
3895 }
3896 }
3897#endif /* MBEDTLS_SSL_CLI_C */
3898 return 0;
3899}
3900
3901MBEDTLS_CHECK_RETURN_CRITICAL
3902static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3903 const unsigned char *buf,
3904 size_t len)
3905{
3906 const unsigned char *p = buf;
3907 const unsigned char *end = buf + len;
3908
3909 if (end - p < 6) {
3910 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3911 }
3912 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3913 session->ticket_flags = p[4];
3914
3915 /* load resumption_key */
3916 session->resumption_key_len = p[5];
3917 p += 6;
3918
3919 if (end - p < session->resumption_key_len) {
3920 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3921 }
3922
3923 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3924 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3925 }
3926 memcpy(session->resumption_key, p, session->resumption_key_len);
3927 p += session->resumption_key_len;
3928
3929#if defined(MBEDTLS_SSL_EARLY_DATA)
3930 if (end - p < 4) {
3931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3932 }
3933 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3934 p += 4;
3935#endif
3936#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3937 if (end - p < 2) {
3938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3939 }
3940 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3941 p += 2;
3942#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3943
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003944#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003945 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003946#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003947 if (end - p < 8) {
3948 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3949 }
3950 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3951 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003952#endif /* MBEDTLS_HAVE_TIME */
3953
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003954#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3955 uint8_t alpn_len;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003957
3958 if (end - p < 1) {
3959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3960 }
3961 alpn_len = *p++;
3962
3963 if (end - p < alpn_len) {
3964 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3965 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003966
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003967 if (alpn_len > 0) {
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003968 ret = mbedtls_ssl_session_set_alpn(session, (const char *) p);
3969 if (ret != 0) {
3970 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003971 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003972 p += alpn_len;
3973 }
3974#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3975 }
3976#endif /* MBEDTLS_SSL_SRV_C */
3977
David Horstmanne59f9702024-02-29 16:08:57 +00003978#if defined(MBEDTLS_SSL_CLI_C)
3979 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3980#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3981 size_t hostname_len;
3982 /* load host name */
3983 if (end - p < 2) {
3984 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3985 }
3986 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3987 p += 2;
3988
3989 if (end - p < (long int) hostname_len) {
3990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3991 }
3992 if (hostname_len > 0) {
3993 session->hostname = mbedtls_calloc(1, hostname_len);
3994 if (session->hostname == NULL) {
3995 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3996 }
3997 memcpy(session->hostname, p, hostname_len);
3998 p += hostname_len;
3999 }
4000#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4001
4002#if defined(MBEDTLS_HAVE_TIME)
4003 if (end - p < 8) {
4004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4005 }
4006 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4007 p += 8;
4008#endif
4009 if (end - p < 4) {
4010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4011 }
4012 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4013 p += 4;
4014
4015 if (end - p < 2) {
4016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4017 }
4018 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4019 p += 2;
4020
4021 if (end - p < (long int) session->ticket_len) {
4022 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4023 }
4024 if (session->ticket_len > 0) {
4025 session->ticket = mbedtls_calloc(1, session->ticket_len);
4026 if (session->ticket == NULL) {
4027 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4028 }
4029 memcpy(session->ticket, p, session->ticket_len);
4030 p += session->ticket_len;
4031 }
4032 }
4033#endif /* MBEDTLS_SSL_CLI_C */
4034
4035 return 0;
4036
4037}
4038#else /* MBEDTLS_SSL_SESSION_TICKETS */
4039MBEDTLS_CHECK_RETURN_CRITICAL
4040static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4041 unsigned char *buf,
4042 size_t buf_len,
4043 size_t *olen)
4044{
4045 ((void) session);
4046 ((void) buf);
4047 ((void) buf_len);
4048 *olen = 0;
4049 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4050}
4051
4052static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4053 unsigned char *buf,
4054 size_t buf_len)
4055{
4056 ((void) session);
4057 ((void) buf);
4058 ((void) buf_len);
4059 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4060}
4061#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4062#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4063
Paul Bakker5121ce52009-01-03 21:22:43 +00004064/*
Hanno Beckera835da52019-05-16 12:39:07 +01004065 * Define ticket header determining Mbed TLS version
4066 * and structure of the ticket.
4067 */
4068
Hanno Becker94ef3b32019-05-16 12:50:45 +01004069/*
Hanno Becker50b59662019-05-28 14:30:45 +01004070 * Define bitflag determining compile-time settings influencing
4071 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004072 */
4073
Hanno Becker50b59662019-05-28 14:30:45 +01004074#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004075#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004076#else
Hanno Becker3e088662019-05-29 11:10:18 +01004077#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004078#endif /* MBEDTLS_HAVE_TIME */
4079
4080#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004081#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004082#else
Hanno Becker3e088662019-05-29 11:10:18 +01004083#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004084#endif /* MBEDTLS_X509_CRT_PARSE_C */
4085
David Horstmann5c5a32f2024-02-13 17:53:35 +00004086#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004087#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004088#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004089#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004090#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4091
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004093#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004094#else
Hanno Becker3e088662019-05-29 11:10:18 +01004095#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004096#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4097
4098#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004099#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#else
Hanno Becker3e088662019-05-29 11:10:18 +01004101#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004102#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4103
Hanno Becker94ef3b32019-05-16 12:50:45 +01004104#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004105#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004106#else
Hanno Becker3e088662019-05-29 11:10:18 +01004107#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004108#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4109
Hanno Becker94ef3b32019-05-16 12:50:45 +01004110#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4111#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4112#else
4113#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4114#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4115
David Horstmann92b258b2024-02-13 17:23:34 +00004116#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4117#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4118#else
4119#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4120#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4121
4122#if defined(MBEDTLS_SSL_EARLY_DATA)
4123#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4124#else
4125#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4126#endif /* MBEDTLS_SSL_EARLY_DATA */
4127
4128#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4129#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4130#else
4131#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4132#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4133
Waleed Elmelegy11025632024-03-07 15:25:52 +00004134#if defined(MBEDTLS_SSL_ALPN)
4135#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4136#else
4137#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4138#endif /* MBEDTLS_SSL_ALPN */
4139
Hanno Becker3e088662019-05-29 11:10:18 +01004140#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4141#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4142#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4143#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004144#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4145#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004146#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004147#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4148#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4149#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004150#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004151
Hanno Becker50b59662019-05-28 14:30:45 +01004152#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 ((uint16_t) ( \
4154 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4155 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4156 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4157 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4158 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4159 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004160 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004161 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4162 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004163 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4164 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4165 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4166 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004167 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
4168 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
4169 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004170
Chien Wong4e9683e2023-12-28 17:07:43 +08004171static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004172 MBEDTLS_VERSION_MAJOR,
4173 MBEDTLS_VERSION_MINOR,
4174 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4176 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004177};
Hanno Beckera835da52019-05-16 12:39:07 +01004178
4179/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004180 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004181 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004182 *
David Horstmanncb01b362024-02-29 17:31:46 +00004183 * TLS 1.2 session:
4184 *
4185 * struct {
4186 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4187 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4188 * uint32 ticket_lifetime;
4189 * #endif
4190 * } ClientOnlyData;
4191 *
4192 * struct {
4193 * #if defined(MBEDTLS_HAVE_TIME)
4194 * uint64 start_time;
4195 * #endif
4196 * uint8 session_id_len; // at most 32
4197 * opaque session_id[32];
4198 * opaque master[48]; // fixed length in the standard
4199 * uint32 verify_result;
4200 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4201 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4202 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004203 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004204 * opaque peer_cert_digest<0..2^8-1>
4205 * #endif
4206 * select (endpoint) {
4207 * case client: ClientOnlyData;
4208 * case server: uint64 ticket_creation_time;
4209 * };
4210 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4211 * uint8 mfl_code; // up to 255 according to standard
4212 * #endif
4213 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4214 * uint8 encrypt_then_mac; // 0 or 1
4215 * #endif
4216 * } serialized_session_tls12;
4217 *
4218 *
4219 * TLS 1.3 Session:
4220 *
4221 * struct {
4222 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4223 * opaque hostname<0..2^16-1>;
4224 * #endif
4225 * #if defined(MBEDTLS_HAVE_TIME)
4226 * uint64 ticket_reception_time;
4227 * #endif
4228 * uint32 ticket_lifetime;
4229 * opaque ticket<1..2^16-1>;
4230 * } ClientOnlyData;
4231 *
4232 * struct {
4233 * uint32 ticket_age_add;
4234 * uint8 ticket_flags;
4235 * opaque resumption_key<0..255>;
4236 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4237 * uint32 max_early_data_size;
4238 * #endif
4239 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4240 * uint16 record_size_limit;
4241 * #endif
4242 * select ( endpoint ) {
4243 * case client: ClientOnlyData;
4244 * #if defined(MBEDTLS_HAVE_TIME)
4245 * case server: uint64 ticket_creation_time;
4246 * #endif
4247 * };
4248 * } serialized_session_tls13;
4249 *
4250 *
4251 * SSL session:
4252 *
4253 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004254 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004255 * opaque mbedtls_version[3]; // library version: major, minor, patch
4256 * opaque session_format[2]; // library-version specific 16-bit field
4257 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004258 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004259 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004260 * Note: When updating the format, remember to keep
4261 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004262 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 * // In this version, `session_format` determines
4264 * // the setting of those compile-time
4265 * // configuration options which influence
4266 * // the structure of mbedtls_ssl_session.
4267 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004268 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004269 * // - TLS 1.2 (0x0303)
4270 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004271 * uint8_t endpoint;
4272 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004273 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004274 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004275 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004276 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004277 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004278 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004279 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004280 *
4281 * };
4282 *
4283 * } serialized_session;
4284 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004285 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004286
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004288static int ssl_session_save(const mbedtls_ssl_session *session,
4289 unsigned char omit_header,
4290 unsigned char *buf,
4291 size_t buf_len,
4292 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004293{
4294 unsigned char *p = buf;
4295 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004296 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004297#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4298 size_t out_len;
4299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4300#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (session == NULL) {
4302 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4303 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004304
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004306 /*
4307 * Add Mbed TLS version identifier
4308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 if (used <= buf_len) {
4312 memcpy(p, ssl_serialized_session_header,
4313 sizeof(ssl_serialized_session_header));
4314 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004315 }
4316 }
4317
4318 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004319 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004320 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004321 used += 1 /* TLS version */
4322 + 1 /* endpoint */
4323 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (used <= buf_len) {
4325 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004326 *p++ = session->endpoint;
4327 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4328 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 }
4330
4331 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004332 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004334#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 case MBEDTLS_SSL_VERSION_TLS1_2:
4336 used += ssl_tls12_session_save(session, p, remaining_len);
4337 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004338#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4339
Jerry Yu251a12e2022-07-13 15:15:48 +08004340#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 case MBEDTLS_SSL_VERSION_TLS1_3:
4342 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4343 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4344 return ret;
4345 }
4346 used += out_len;
4347 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004348#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 default:
4351 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004352 }
4353
4354 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (used > buf_len) {
4356 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4357 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004360}
4361
4362/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004363 * Public wrapper for ssl_session_save()
4364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004365int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4366 unsigned char *buf,
4367 size_t buf_len,
4368 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004369{
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004371}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004372
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004373/*
4374 * Deserialize session, see mbedtls_ssl_session_save() for format.
4375 *
4376 * This internal version is wrapped by a public function that cleans up in
4377 * case of error, and has an extra option omit_header.
4378 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004380static int ssl_session_load(mbedtls_ssl_session *session,
4381 unsigned char omit_header,
4382 const unsigned char *buf,
4383 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004384{
4385 const unsigned char *p = buf;
4386 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004387 size_t remaining_len;
4388
4389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (session == NULL) {
4391 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4392 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004395 /*
4396 * Check Mbed TLS version identifier
4397 */
4398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004401 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004402
4403 if (memcmp(p, ssl_serialized_session_header,
4404 sizeof(ssl_serialized_session_header)) != 0) {
4405 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4406 }
4407 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004408 }
4409
4410 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004411 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004412 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004413 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4415 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004416 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004417 session->endpoint = *p++;
4418 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4419 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004420
4421 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004422 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004424#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 case MBEDTLS_SSL_VERSION_TLS1_2:
4426 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004427#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4428
Jerry Yu438ddd82022-07-07 06:55:50 +00004429#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 case MBEDTLS_SSL_VERSION_TLS1_3:
4431 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 default:
4435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004436 }
4437}
4438
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004439/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004440 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004441 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004442int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4443 const unsigned char *buf,
4444 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004445{
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (ret != 0) {
4449 mbedtls_ssl_session_free(session);
4450 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004453}
4454
4455/*
Paul Bakker1961b702013-01-25 14:49:24 +01004456 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004457 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004459static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004460{
4461 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4462
Ronald Cron66dbf912022-02-02 15:33:46 +01004463 /*
4464 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004465 * that were written into the output buffer by the previous handshake step,
4466 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004467 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4468 * We proceed to the next handshake step only when all data from the
4469 * previous one have been sent to the peer, thus we make sure that this is
4470 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4471 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4472 * we have to wait before to go ahead.
4473 * In the case of TLS 1.3, handshake step handlers do not send data to the
4474 * peer. Data are only sent here and through
4475 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004476 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4479 return ret;
4480 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004481
4482#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4484 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4485 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4486 return ret;
4487 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004488 }
4489#endif /* MBEDTLS_SSL_PROTO_DTLS */
4490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004492}
4493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004495{
Hanno Becker41934dd2021-08-07 19:13:43 +01004496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004499 ssl->conf == NULL ||
4500 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4502 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004503 }
4504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 ret = ssl_prepare_handshake_step(ssl);
4506 if (ret != 0) {
4507 return ret;
4508 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 ret = mbedtls_ssl_handle_pending_alert(ssl);
4511 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004512 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 }
Jerry Yue7047812021-09-13 19:26:39 +08004514
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004515 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4516 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4517 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004519#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4521 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004522 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004525 case MBEDTLS_SSL_HELLO_REQUEST:
4526 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004527 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004528 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004529
Ronald Cron9f0fba32022-02-10 16:45:15 +01004530 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004532 break;
4533
4534 default:
4535#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4537 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4538 } else {
4539 ret = mbedtls_ssl_handshake_client_step(ssl);
4540 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004541#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004543#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004545#endif
4546 }
Jerry Yub9930e72021-08-06 17:11:51 +08004547 }
Ronald Cron6291b232023-03-08 15:51:25 +01004548#endif /* MBEDTLS_SSL_CLI_C */
4549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004552#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4553 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004555 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 ret = mbedtls_ssl_handshake_server_step(ssl);
4557 }
Ronald Cron6291b232023-03-08 15:51:25 +01004558#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4559 ret = mbedtls_ssl_handshake_server_step(ssl);
4560#else
4561 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004562#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004563 }
4564#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004567 /* handshake_step return error. And it is same
4568 * with alert_reason.
4569 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (ssl->send_alert) {
4571 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004572 goto cleanup;
4573 }
4574 }
4575
4576cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004578}
4579
4580/*
4581 * Perform the SSL handshake
4582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004583int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004584{
4585 int ret = 0;
4586
Hanno Beckera817ea42020-10-20 15:20:23 +01004587 /* Sanity checks */
4588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (ssl == NULL || ssl->conf == NULL) {
4590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4591 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004592
Hanno Beckera817ea42020-10-20 15:20:23 +01004593#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4595 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4596 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4597 "mbedtls_ssl_set_timer_cb() for DTLS"));
4598 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004599 }
4600#endif /* MBEDTLS_SSL_PROTO_DTLS */
4601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004603
Hanno Beckera817ea42020-10-20 15:20:23 +01004604 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4606 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004609 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 }
Paul Bakker1961b702013-01-25 14:49:24 +01004611 }
4612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004614
Gilles Peskine449bd832023-01-11 14:50:10 +01004615 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004616}
4617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618#if defined(MBEDTLS_SSL_RENEGOTIATION)
4619#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004620/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004621 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004622 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004623MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004624static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004625{
Janos Follath865b3eb2019-12-16 11:46:15 +00004626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004629
4630 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4632 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4635 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4636 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004637 }
4638
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004642}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004644
4645/*
4646 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004647 * - any side: calling mbedtls_ssl_renegotiate(),
4648 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4649 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004650 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004651 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004652 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004655{
Janos Follath865b3eb2019-12-16 11:46:15 +00004656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004657
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if ((ret = ssl_handshake_init(ssl)) != 0) {
4661 return ret;
4662 }
Paul Bakker48916f92012-09-16 19:57:18 +00004663
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004664 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4665 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4668 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4669 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004670 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004672 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004674 }
4675#endif
4676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004677 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4678 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4681 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4682 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004683 }
4684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004688}
4689
4690/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004691 * Renegotiate current connection on client,
4692 * or request renegotiation on server
4693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004695{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004696 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (ssl == NULL || ssl->conf == NULL) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004702#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004703 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4705 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4707 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004709 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004710
4711 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (ssl->out_left != 0) {
4713 return mbedtls_ssl_flush_output(ssl);
4714 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004717 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004720#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004721 /*
4722 * On client, either start the renegotiation process or,
4723 * if already in progress, continue the handshake
4724 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4726 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004728 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004729
4730 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4731 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4732 return ret;
4733 }
4734 } else {
4735 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4736 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4737 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004738 }
4739 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004741
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004743}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004744#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004745
Gilles Peskine449bd832023-01-11 14:50:10 +01004746void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004747{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004748 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004751 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004753
Valerio Setti6f0441d2023-07-03 12:11:36 +02004754#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004755#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->handshake->group_list_heap_allocated) {
4757 mbedtls_free((void *) handshake->group_list);
4758 }
Brett Warrene0edc842021-08-17 09:53:13 +01004759 handshake->group_list = NULL;
4760#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004761#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004762
Ronald Crone68ab4f2022-10-05 12:46:29 +02004763#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004764#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (ssl->handshake->sig_algs_heap_allocated) {
4766 mbedtls_free((void *) handshake->sig_algs);
4767 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004768 handshake->sig_algs = NULL;
4769#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (ssl->handshake->certificate_request_context) {
4772 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004773 }
4774#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004775#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004776
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004777#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4779 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004780 handshake->async_in_progress = 0;
4781 }
4782#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4783
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004784#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004785#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004787#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004788 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004789#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004790#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004791#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004792#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004794#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004795 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004796#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004797#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004801#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004802#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004803 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004805#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004806
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004807#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004808#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004810 /*
4811 * Opaque keys are not stored in the handshake's data and it's the user
4812 * responsibility to destroy them. Clear ones, instead, are created by
4813 * the TLS library and should be destroyed at the same level
4814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4816 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004817 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004818 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4819#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004821#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004822#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004824 handshake->ecjpake_cache = NULL;
4825 handshake->ecjpake_cache_len = 0;
4826#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004827#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004828
Valerio Setti7aeec542023-07-05 18:57:21 +02004829#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004830 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004831 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004832 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004834#endif
4835
Ronald Cron73fe8df2022-10-05 14:31:43 +02004836#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004837#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004839 /* The maintenance of the external PSK key slot is the
4840 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (ssl->handshake->psk_opaque_is_internal) {
4842 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004843 ssl->handshake->psk_opaque_is_internal = 0;
4844 }
4845 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4846 }
Neil Armstronge952a302022-05-03 10:22:14 +02004847#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004849 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004850 }
Neil Armstronge952a302022-05-03 10:22:14 +02004851#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004852#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004854#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4855 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004856 /*
4857 * Free only the linked list wrapper, not the keys themselves
4858 * since the belong to the SNI callback
4859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004861#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004862
Gilles Peskineeccd8882020-03-10 12:19:08 +01004863#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4865 if (handshake->ecrs_peer_cert != NULL) {
4866 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4867 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004868 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004869#endif
4870
Hanno Becker75173122019-02-06 16:18:31 +00004871#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4872 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004874#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4875
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004876#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4878 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004879#endif /* MBEDTLS_SSL_CLI_C &&
4880 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004881
4882#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 mbedtls_ssl_flight_free(handshake->flight);
4884 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004885#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004886
Valerio Settiea59c432023-07-25 11:14:03 +02004887#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004888 if (handshake->xxdh_psa_privkey_is_external == 0) {
4889 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 }
Valerio Settiea59c432023-07-25 11:14:03 +02004891#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004892
Ronald Cron6f135e12021-12-08 16:57:54 +01004893#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 mbedtls_ssl_transform_free(handshake->transform_handshake);
4895 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004896#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4898 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004899#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004900#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004901
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004902
4903#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4904 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4905 * processes datagrams and the fact that a datagram is allowed to have
4906 * several records in it, it is possible that the I/O buffers are not
4907 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4909 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004910#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004911
Jerry Yuba9c7272021-10-30 11:54:10 +08004912 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 mbedtls_platform_zeroize(handshake,
4914 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004915}
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004918{
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004920 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004925#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004926
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004927#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004928#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4929 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004931#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004932 mbedtls_free(session->ticket);
4933#endif
4934
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004935#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4936 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004937 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004938#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004941}
4942
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004943#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004944
4945#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4946#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4947#else
4948#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4949#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4950
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004951#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004952
4953#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4954#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4955#else
4956#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4957#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4958
4959#if defined(MBEDTLS_SSL_ALPN)
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4961#else
4962#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4963#endif /* MBEDTLS_SSL_ALPN */
4964
4965#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4966#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4967#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4969
4970#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 ((uint32_t) ( \
4972 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4973 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4974 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4975 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4976 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4977 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4978 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4979 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004980
Chien Wong4e9683e2023-12-28 17:07:43 +08004981static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004982 MBEDTLS_VERSION_MAJOR,
4983 MBEDTLS_VERSION_MINOR,
4984 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4986 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4987 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4988 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4989 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004990};
4991
Paul Bakker5121ce52009-01-03 21:22:43 +00004992/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004993 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004994 *
4995 * The format of the serialized data is:
4996 * (in the presentation language of TLS, RFC 8446 section 3)
4997 *
4998 * // header
4999 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005000 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005001 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005002 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005003 * Note: When updating the format, remember to keep these
5004 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005005 *
5006 * // session sub-structure
5007 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5008 * // transform sub-structure
5009 * uint8 random[64]; // ServerHello.random+ClientHello.random
5010 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5011 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5012 * // fields from ssl_context
5013 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5014 * uint64 in_window_top; // DTLS: last validated record seq_num
5015 * uint64 in_window; // DTLS: bitmask for replay protection
5016 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5017 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5018 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5019 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5020 *
5021 * Note that many fields of the ssl_context or sub-structures are not
5022 * serialized, as they fall in one of the following categories:
5023 *
5024 * 1. forced value (eg in_left must be 0)
5025 * 2. pointer to dynamically-allocated memory (eg session, transform)
5026 * 3. value can be re-derived from other data (eg session keys from MS)
5027 * 4. value was temporary (eg content of input buffer)
5028 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005030int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5031 unsigned char *buf,
5032 size_t buf_len,
5033 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005034{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005035 unsigned char *p = buf;
5036 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005037 size_t session_len;
5038 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005039
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005040 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005041 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5042 * this function's documentation.
5043 *
5044 * These are due to assumptions/limitations in the implementation. Some of
5045 * them are likely to stay (no handshake in progress) some might go away
5046 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005047 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005048 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5050 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005052 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (ssl->handshake != NULL) {
5054 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005056 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005057 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if (ssl->transform == NULL || ssl->session == NULL) {
5059 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005061 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005062 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (mbedtls_ssl_check_pending(ssl) != 0) {
5064 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005066 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->out_left != 0) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005070 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005071 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5073 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005075 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005076 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5078 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005080 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005081 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5083 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5084 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005085 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005086 /* Renegotiation must not be enabled */
5087#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5089 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005091 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005092#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005093
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005094 /*
5095 * Version and format identifier
5096 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005098
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if (used <= buf_len) {
5100 memcpy(p, ssl_serialized_context_header,
5101 sizeof(ssl_serialized_context_header));
5102 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005103 }
5104
5105 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005106 * Session (length + data)
5107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5109 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5110 return ret;
5111 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005112
5113 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (used <= buf_len) {
5115 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005116 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 ret = ssl_session_save(ssl->session, 1,
5119 p, session_len, &session_len);
5120 if (ret != 0) {
5121 return ret;
5122 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005123
5124 p += session_len;
5125 }
5126
5127 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005128 * Transform
5129 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 used += sizeof(ssl->transform->randbytes);
5131 if (used <= buf_len) {
5132 memcpy(p, ssl->transform->randbytes,
5133 sizeof(ssl->transform->randbytes));
5134 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005135 }
5136
5137#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005138 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005140 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005142 p += ssl->transform->in_cid_len;
5143
5144 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005146 p += ssl->transform->out_cid_len;
5147 }
5148#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5149
5150 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005151 * Saved fields from top-level ssl_context structure
5152 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005153 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if (used <= buf_len) {
5155 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005156 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005157 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005158
5159#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5160 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 if (used <= buf_len) {
5162 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005163 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005164
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005166 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005167 }
5168#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5169
5170#if defined(MBEDTLS_SSL_PROTO_DTLS)
5171 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005173 *p++ = ssl->disable_datagram_packing;
5174 }
5175#endif /* MBEDTLS_SSL_PROTO_DTLS */
5176
Jerry Yuae0b2e22021-10-08 15:21:19 +08005177 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 if (used <= buf_len) {
5179 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005180 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005181 }
5182
5183#if defined(MBEDTLS_SSL_PROTO_DTLS)
5184 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (used <= buf_len) {
5186 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005187 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005188 }
5189#endif /* MBEDTLS_SSL_PROTO_DTLS */
5190
5191#if defined(MBEDTLS_SSL_ALPN)
5192 {
5193 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005195 : 0;
5196
5197 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005199 *p++ = alpn_len;
5200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (ssl->alpn_chosen != NULL) {
5202 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005203 p += alpn_len;
5204 }
5205 }
5206 }
5207#endif /* MBEDTLS_SSL_ALPN */
5208
5209 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005210 * Done
5211 */
5212 *olen = used;
5213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 if (used > buf_len) {
5215 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5216 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005221}
5222
5223/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005224 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005225 *
5226 * This internal version is wrapped by a public function that cleans up in
5227 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005228 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005229MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005230static int ssl_context_load(mbedtls_ssl_context *ssl,
5231 const unsigned char *buf,
5232 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005233{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005234 const unsigned char *p = buf;
5235 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005236 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005237 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005238#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005239 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005240#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005241
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005242 /*
5243 * The context should have been freshly setup or reset.
5244 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005245 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005246 * renegotiating, or if the user mistakenly loaded a session first.)
5247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5249 ssl->session != NULL) {
5250 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005251 }
5252
5253 /*
5254 * We can't check that the config matches the initial one, but we can at
5255 * least check it matches the requirements for serializing.
5256 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005257 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005258#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005259 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005260#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005261 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5262 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5263 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5264 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005266 }
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005269
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005270 /*
5271 * Check version identifier
5272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005275 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005276
5277 if (memcmp(p, ssl_serialized_context_header,
5278 sizeof(ssl_serialized_context_header)) != 0) {
5279 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5280 }
5281 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005282
5283 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005284 * Session
5285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if ((size_t) (end - p) < 4) {
5287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5288 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005289
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005290 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005291 p += 4;
5292
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005293 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005294 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005295 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005296 ssl->session_in = ssl->session;
5297 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005298 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if ((size_t) (end - p) < session_len) {
5301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5302 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 ret = ssl_session_load(ssl->session, 1, p, session_len);
5305 if (ret != 0) {
5306 mbedtls_ssl_session_free(ssl->session);
5307 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005308 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005309
5310 p += session_len;
5311
5312 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005313 * Transform
5314 */
5315
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005316 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005317 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005318#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005319 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005320 ssl->transform_in = ssl->transform;
5321 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005322 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005323#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005324
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5327 if (prf_func == NULL) {
5328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5329 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005330
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005331 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5334 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 ret = ssl_tls12_populate_transform(ssl->transform,
5337 ssl->session->ciphersuite,
5338 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005339#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005341#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 prf_func,
5343 p, /* currently pointing to randbytes */
5344 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5345 ssl->conf->endpoint,
5346 ssl);
5347 if (ret != 0) {
5348 return ret;
5349 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005350#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005352
5353#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5354 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if ((size_t) (end - p) < 1) {
5356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5357 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005358
5359 ssl->transform->in_cid_len = *p++;
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5363 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005364
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005366 p += ssl->transform->in_cid_len;
5367
5368 ssl->transform->out_cid_len = *p++;
5369
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5371 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5372 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005375 p += ssl->transform->out_cid_len;
5376#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5377
5378 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005379 * Saved fields from top-level ssl_context structure
5380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if ((size_t) (end - p) < 4) {
5382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5383 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005384
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005385 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005386 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387
5388#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005389 if ((size_t) (end - p) < 16) {
5390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5391 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005392
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005393 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005394 p += 8;
5395
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005396 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005397 p += 8;
5398#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5399
5400#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if ((size_t) (end - p) < 1) {
5402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5403 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005404
5405 ssl->disable_datagram_packing = *p++;
5406#endif /* MBEDTLS_SSL_PROTO_DTLS */
5407
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5410 }
5411 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5412 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005413
5414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if ((size_t) (end - p) < 2) {
5416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5417 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005418
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005419 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005420 p += 2;
5421#endif /* MBEDTLS_SSL_PROTO_DTLS */
5422
5423#if defined(MBEDTLS_SSL_ALPN)
5424 {
5425 uint8_t alpn_len;
5426 const char **cur;
5427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 if ((size_t) (end - p) < 1) {
5429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5430 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005431
5432 alpn_len = *p++;
5433
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005435 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5437 if (strlen(*cur) == alpn_len &&
5438 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005439 ssl->alpn_chosen = *cur;
5440 break;
5441 }
5442 }
5443 }
5444
5445 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5447 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5448 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005449
5450 p += alpn_len;
5451 }
5452#endif /* MBEDTLS_SSL_ALPN */
5453
5454 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005455 * Forced fields from top-level ssl_context structure
5456 *
5457 * Most of them already set to the correct value by mbedtls_ssl_init() and
5458 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5459 */
5460 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005461 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005462
Hanno Becker361b10d2019-08-30 10:42:49 +01005463 /* Adjust pointers for header fields of outgoing records to
5464 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005466
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005467#if defined(MBEDTLS_SSL_PROTO_DTLS)
5468 ssl->in_epoch = 1;
5469#endif
5470
5471 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5472 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005473 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5474 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 if (ssl->handshake != NULL) {
5476 mbedtls_ssl_handshake_free(ssl);
5477 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005478 ssl->handshake = NULL;
5479 }
5480
5481 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005482 * Done - should have consumed entire buffer
5483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 if (p != end) {
5485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5486 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005487
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005489}
5490
5491/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005492 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5495 const unsigned char *buf,
5496 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005497{
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 if (ret != 0) {
5501 mbedtls_ssl_free(context);
5502 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005505}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005506#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005507
5508/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005509 * Free an SSL context
5510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005511void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005512{
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005514 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005518
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005520#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5521 size_t out_buf_len = ssl->out_buf_len;
5522#else
5523 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5524#endif
5525
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005526 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005527 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005528 }
5529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005531#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5532 size_t in_buf_len = ssl->in_buf_len;
5533#else
5534 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5535#endif
5536
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005537 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005538 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005539 }
5540
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 if (ssl->transform) {
5542 mbedtls_ssl_transform_free(ssl->transform);
5543 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005544 }
5545
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 if (ssl->handshake) {
5547 mbedtls_ssl_handshake_free(ssl);
5548 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005549
5550#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5552 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005553#endif
5554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 mbedtls_ssl_session_free(ssl->session_negotiate);
5556 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005557 }
5558
Ronald Cron6f135e12021-12-08 16:57:54 +01005559#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 mbedtls_ssl_transform_free(ssl->transform_application);
5561 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005562#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005563
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 if (ssl->session) {
5565 mbedtls_ssl_session_free(ssl->session);
5566 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005567 }
5568
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005569#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005571 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005572 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005573#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005574
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005575#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005577#endif
5578
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005580
Paul Bakker86f04f42013-02-14 11:20:09 +01005581 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005583}
5584
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005585/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005586 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005588void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005589{
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005591}
5592
Gilles Peskineae270bf2021-06-02 00:05:29 +02005593/* The selection should be the same as mbedtls_x509_crt_profile_default in
5594 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005595 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005596 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005597 * about this list.
5598 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005599static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005600#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005601 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005602#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005604 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005607 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005608#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005609#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005610 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005612#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005613 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005614#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005615#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005616 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005617#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005618#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005619 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005620#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005621#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005622 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005623#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005624#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005625 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5626 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5627 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5628 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5629 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5630#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005631 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005632};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005633
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005634static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005635 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5636 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5637 0
5638};
5639
Ronald Crone68ab4f2022-10-05 12:46:29 +02005640#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005641
Jerry Yu909df7b2022-01-22 11:56:27 +08005642/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005643 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005644 * rules SHOULD be upheld.
5645 * - No duplicate entries.
5646 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005647 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005648 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005649 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005650static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005651
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005652#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005653 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005654 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005655 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005656 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5657#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005658
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005659#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005660 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005661 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005662 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005663 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5664#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005665
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005666#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005667 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005668 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005669 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005670 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5671#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005672
Yanray Wang1136fad2023-11-22 16:54:31 +08005673#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005674 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005675#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005676
Yanray Wang1136fad2023-11-22 16:54:31 +08005677#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005678 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005679#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005680
Yanray Wang1136fad2023-11-22 16:54:31 +08005681#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005682 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005683#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005684
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005685#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005686 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005687#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005688
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005689#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005690 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005691#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005692
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005693#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005694 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005695#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005696
Gabor Mezei15b95a62022-05-09 16:37:58 +02005697 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005698};
5699
5700/* NOTICE: see above */
5701#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5702static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005703
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005704#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005705#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005707#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005708#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5709 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005710#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005711#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005713#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005714#endif /* MBEDTLS_MD_CAN_SHA512 */
5715
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005716#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005717#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005719#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005720#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5721 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005722#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005723#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005726#endif /* MBEDTLS_MD_CAN_SHA384 */
5727
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005728#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005729#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005731#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005732#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5733 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005734#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005735#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005737#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005738#endif /* MBEDTLS_MD_CAN_SHA256 */
5739
Gabor Mezei15b95a62022-05-09 16:37:58 +02005740 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005741};
5742#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005743
Jerry Yu909df7b2022-01-22 11:56:27 +08005744/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005745static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005746
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005747#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005748 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005749 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005750 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005751 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5752#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005753
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005754#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005755 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005756 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005757 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005758 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5759#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005760
Gabor Mezei15b95a62022-05-09 16:37:58 +02005761 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005762};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005763
Jerry Yu909df7b2022-01-22 11:56:27 +08005764/* NOTICE: see above */
5765#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5766static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005767
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005768#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005769#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005771#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005772#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005773
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005774#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005775#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005777#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005778#endif /* MBEDTLS_MD_CAN_SHA384 */
5779
Gabor Mezei15b95a62022-05-09 16:37:58 +02005780 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005781};
Jerry Yu909df7b2022-01-22 11:56:27 +08005782#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5783
Ronald Crone68ab4f2022-10-05 12:46:29 +02005784#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005785
Chien Wong4e9683e2023-12-28 17:07:43 +08005786static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005787#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005788 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005789#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005790#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005791 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005792#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005793 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005794};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005795
Ronald Crone68ab4f2022-10-05 12:46:29 +02005796#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005797/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005798 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005799MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005800static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005801{
5802 size_t i, j;
5803 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5806 for (j = 0; j < i; j++) {
5807 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005808 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 }
5810 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5811 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5812 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005813 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005814 }
5815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005817}
5818
Ronald Crone68ab4f2022-10-05 12:46:29 +02005819#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005820
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005821/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005822 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005824int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5825 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005826{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005827#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005829#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005830
Ronald Crone68ab4f2022-10-05 12:46:29 +02005831#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5833 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5834 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005835 }
5836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5838 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5839 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005840 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005841
5842#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5844 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5845 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005846 }
5847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5849 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5850 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005851 }
5852#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005853#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005854
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005855 /* Use the functions here so that they are covered in tests,
5856 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 mbedtls_ssl_conf_endpoint(conf, endpoint);
5858 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005859
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005860 /*
5861 * Things that are common to all presets
5862 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005863#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005865 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5866#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5867 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5868#endif
5869 }
5870#endif
5871
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005872#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5873 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5874#endif
5875
5876#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5877 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5878#endif
5879
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005880#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005881 conf->f_cookie_write = ssl_cookie_write_dummy;
5882 conf->f_cookie_check = ssl_cookie_check_dummy;
5883#endif
5884
5885#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5886 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5887#endif
5888
Janos Follath088ce432017-04-10 12:42:31 +01005889#if defined(MBEDTLS_SSL_SRV_C)
5890 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005891 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005892#endif
5893
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005894#if defined(MBEDTLS_SSL_PROTO_DTLS)
5895 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5896 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5897#endif
5898
5899#if defined(MBEDTLS_SSL_RENEGOTIATION)
5900 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 memset(conf->renego_period, 0x00, 2);
5902 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005903#endif
5904
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005905#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005907 const unsigned char dhm_p[] =
5908 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5909 const unsigned char dhm_g[] =
5910 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005911
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5913 dhm_p, sizeof(dhm_p),
5914 dhm_g, sizeof(dhm_g))) != 0) {
5915 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005916 }
5917 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005918#endif
5919
Ronald Cron6f135e12021-12-08 16:57:54 +01005920#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005921
5922#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005923 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005924#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005925 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005926#endif
5927#endif /* MBEDTLS_SSL_EARLY_DATA */
5928
Jerry Yud0766ec2022-09-22 10:46:57 +08005929#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005930 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005932#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005933 /*
5934 * Allow all TLS 1.3 key exchange modes by default.
5935 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005936 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005937#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005940#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005941 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005942 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005943#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005945#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005947#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005948 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5949 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005950#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5951 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5952 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5953#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5954 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5955 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5956#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005958#endif
5959 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005960
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005961 /*
5962 * Preset-specific defaults
5963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005965 /*
5966 * NSA Suite B
5967 */
5968 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005969
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005970 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005971
5972#if defined(MBEDTLS_X509_CRT_PARSE_C)
5973 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005974#endif
5975
Ronald Crone68ab4f2022-10-05 12:46:29 +02005976#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005977#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005979 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005981#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005983#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005984
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005985#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005986 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005987#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005988 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005989 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005990
5991 /*
5992 * Default
5993 */
5994 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005995
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005996 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005997
5998#if defined(MBEDTLS_X509_CRT_PARSE_C)
5999 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6000#endif
6001
Ronald Crone68ab4f2022-10-05 12:46:29 +02006002#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006003#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006005 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006007#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006009#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006010
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006011#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006012 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006013#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006014 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006015
6016#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6017 conf->dhm_min_bitlen = 1024;
6018#endif
6019 }
6020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006022}
6023
6024/*
6025 * Free mbedtls_ssl_config
6026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006027void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006028{
6029#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 mbedtls_mpi_free(&conf->dhm_P);
6031 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006032#endif
6033
Ronald Cron73fe8df2022-10-05 14:31:43 +02006034#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006035#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006037 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6038 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006039#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006041 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006042 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006043 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006044 }
6045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006047 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006048 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006049 conf->psk_identity_len = 0;
6050 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006051#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006052
6053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006055#endif
6056
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006058}
6059
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006060#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006061 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006062/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006063 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006065unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006066{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006067#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6069 return MBEDTLS_SSL_SIG_RSA;
6070 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006071#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006072#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6074 return MBEDTLS_SSL_SIG_ECDSA;
6075 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006076#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006078}
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006081{
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006083 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006085 case MBEDTLS_PK_ECDSA:
6086 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006088 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006090 }
6091}
6092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006094{
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006096#if defined(MBEDTLS_RSA_C)
6097 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006099#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006100#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006101 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006103#endif
6104 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006106 }
6107}
Valerio Settie9646ec2023-08-02 20:02:28 +02006108#endif /* MBEDTLS_PK_C &&
6109 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006110
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006111/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006112 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006114mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006115{
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006117#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006118 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006120#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006121#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006122 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006124#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006125#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006126 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006128#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006129#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006130 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006132#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006133#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006134 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006136#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006137#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006138 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006140#endif
6141 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006143 }
6144}
6145
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006146/*
6147 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006149unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006150{
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006152#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006153 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006155#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006156#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006157 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006159#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006160#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006161 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006163#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006164#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006165 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006167#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006168#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006169 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006171#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006172#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006173 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006175#endif
6176 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006178 }
6179}
6180
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006181/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006182 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006183 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006185int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006186{
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 if (group_list == NULL) {
6190 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006191 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 for (; *group_list != 0; group_list++) {
6194 if (*group_list == tls_id) {
6195 return 0;
6196 }
6197 }
6198
6199 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006200}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006201
Valerio Setti49e69072023-06-27 17:27:51 +02006202#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006203/*
6204 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006206int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006207{
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006209
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006211 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006213
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006215}
Valerio Setti49e69072023-06-27 17:27:51 +02006216#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006217
Valerio Setti18c9fed2022-12-30 17:44:24 +01006218static const struct {
6219 uint16_t tls_id;
6220 mbedtls_ecp_group_id ecp_group_id;
6221 psa_ecc_family_t psa_family;
6222 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006223} tls_id_match_table[] =
6224{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006225#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006226 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006227#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006228#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006229 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006231#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006232 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006233#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006234#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006235 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006237#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006240#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006243#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006246#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006249#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006252#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006255#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006258#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006261#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006262 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006264 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006265};
6266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006268 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006270{
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6272 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006273 if (type != NULL) {
6274 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 }
6276 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006277 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006279 return PSA_SUCCESS;
6280 }
6281 }
6282
6283 return PSA_ERROR_NOT_SUPPORTED;
6284}
6285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006287{
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6289 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006290 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292 }
6293
6294 return MBEDTLS_ECP_DP_NONE;
6295}
6296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006298{
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6300 i++) {
6301 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006302 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006304 }
6305
6306 return 0;
6307}
6308
Valerio Setti67419f02023-01-04 16:12:42 +01006309#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006310static const struct {
6311 uint16_t tls_id;
6312 const char *name;
6313} tls_id_curve_name_table[] =
6314{
Valerio Setti54e23792023-07-07 10:49:27 +02006315 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6316 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6317 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6318 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6321 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6322 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6323 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6324 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6325 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6326 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6327 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006328 { 0, NULL },
6329};
6330
Gilles Peskine449bd832023-01-11 14:50:10 +01006331const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006332{
Valerio Settiacd32c02023-06-29 18:06:29 +02006333 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6334 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6335 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006337 }
6338
6339 return NULL;
6340}
Valerio Setti67419f02023-01-04 16:12:42 +01006341#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006343#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006344int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6345 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6346 int cert_endpoint,
6347 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006348{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006349 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006350 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006351 const char *ext_oid;
6352 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006355 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006357 case MBEDTLS_KEY_EXCHANGE_RSA:
6358 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006359 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006360 break;
6361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006362 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6363 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6364 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6365 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006366 break;
6367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006368 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6369 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006370 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006371 break;
6372
6373 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006374 case MBEDTLS_KEY_EXCHANGE_NONE:
6375 case MBEDTLS_KEY_EXCHANGE_PSK:
6376 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6377 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006378 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006379 usage = 0;
6380 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006382 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6383 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006384 }
6385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006387 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006388 ret = -1;
6389 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006390
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006392 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6394 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006395 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006397 }
6398
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006400 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006401 ret = -1;
6402 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006405}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006406#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006407
Jerry Yu148165c2021-09-24 23:20:59 +08006408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006409int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6410 const mbedtls_md_type_t md,
6411 unsigned char *dst,
6412 size_t dst_len,
6413 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006414{
Ronald Cronf6893e12022-01-07 22:09:01 +01006415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6416 psa_hash_operation_t *hash_operation_to_clone;
6417 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6418
Jerry Yu148165c2021-09-24 23:20:59 +08006419 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006422#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 case MBEDTLS_MD_SHA384:
6424 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6425 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006426#endif
6427
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006428#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 case MBEDTLS_MD_SHA256:
6430 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6431 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006432#endif
6433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 default:
6435 goto exit;
6436 }
6437
6438 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6439 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006440 goto exit;
6441 }
6442
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6444 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006445 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006447
6448exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006449#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6450 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006451 (void) ssl;
6452#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006453 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006454}
6455#else /* MBEDTLS_USE_PSA_CRYPTO */
6456
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006457#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006459static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6460 unsigned char *dst,
6461 size_t dst_len,
6462 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006463{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006464 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006465 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 if (dst_len < 48) {
6468 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6469 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006470
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006471 mbedtls_md_init(&sha384);
6472 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006473 if (ret != 0) {
6474 goto exit;
6475 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006476 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006477 if (ret != 0) {
6478 goto exit;
6479 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006480
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006481 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006482 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006483 goto exit;
6484 }
6485
6486 *olen = 48;
6487
6488exit:
6489
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006490 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006492}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006493#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006494
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006495#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006496MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006497static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6498 unsigned char *dst,
6499 size_t dst_len,
6500 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006501{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006502 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006503 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 if (dst_len < 32) {
6506 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6507 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006508
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006509 mbedtls_md_init(&sha256);
6510 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6511 if (ret != 0) {
6512 goto exit;
6513 }
6514 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6515 if (ret != 0) {
6516 goto exit;
6517 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006518
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006519 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6520 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006521 goto exit;
6522 }
6523
6524 *olen = 32;
6525
6526exit:
6527
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006528 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006530}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006531#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6534 const mbedtls_md_type_t md,
6535 unsigned char *dst,
6536 size_t dst_len,
6537 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006538{
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006540
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006541#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 case MBEDTLS_MD_SHA384:
6543 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006544#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006545
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006546#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 case MBEDTLS_MD_SHA256:
6548 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006549#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006552#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6553 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 (void) ssl;
6555 (void) dst;
6556 (void) dst_len;
6557 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006558#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006560 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006562}
XiaokangQian647719a2021-12-07 09:16:29 +00006563
Jerry Yu148165c2021-09-24 23:20:59 +08006564#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006565
Ronald Crone68ab4f2022-10-05 12:46:29 +02006566#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006567/* mbedtls_ssl_parse_sig_alg_ext()
6568 *
6569 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6570 * value (TLS 1.3 RFC8446):
6571 * enum {
6572 * ....
6573 * ecdsa_secp256r1_sha256( 0x0403 ),
6574 * ecdsa_secp384r1_sha384( 0x0503 ),
6575 * ecdsa_secp521r1_sha512( 0x0603 ),
6576 * ....
6577 * } SignatureScheme;
6578 *
6579 * struct {
6580 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6581 * } SignatureSchemeList;
6582 *
6583 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6584 * value (TLS 1.2 RFC5246):
6585 * enum {
6586 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6587 * sha512(6), (255)
6588 * } HashAlgorithm;
6589 *
6590 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6591 * SignatureAlgorithm;
6592 *
6593 * struct {
6594 * HashAlgorithm hash;
6595 * SignatureAlgorithm signature;
6596 * } SignatureAndHashAlgorithm;
6597 *
6598 * SignatureAndHashAlgorithm
6599 * supported_signature_algorithms<2..2^16-2>;
6600 *
6601 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6602 * generalization of the TLS 1.2 signature algorithm extension.
6603 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6604 * `SignatureScheme` field of TLS 1.3
6605 *
6606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006607int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6608 const unsigned char *buf,
6609 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006610{
6611 const unsigned char *p = buf;
6612 size_t supported_sig_algs_len = 0;
6613 const unsigned char *supported_sig_algs_end;
6614 uint16_t sig_alg;
6615 uint32_t common_idx = 0;
6616
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6618 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006619 p += 2;
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 memset(ssl->handshake->received_sig_algs, 0,
6622 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006625 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 while (p < supported_sig_algs_end) {
6627 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6628 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006629 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6631 sig_alg,
6632 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006633#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6635 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6636 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006637 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006638 }
6639#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006640
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6642 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006645 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6646 common_idx += 1;
6647 }
6648 }
6649 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 if (p != end) {
6651 MBEDTLS_SSL_DEBUG_MSG(1,
6652 ("Signature algorithms extension length misaligned"));
6653 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6654 MBEDTLS_ERR_SSL_DECODE_ERROR);
6655 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006656 }
6657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 if (common_idx == 0) {
6659 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6660 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6661 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6662 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006663 }
6664
Gabor Mezei15b95a62022-05-09 16:37:58 +02006665 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006667}
6668
Ronald Crone68ab4f2022-10-05 12:46:29 +02006669#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006670
Jerry Yudc7bd172022-02-17 13:44:15 +08006671#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6672
6673#if defined(MBEDTLS_USE_PSA_CRYPTO)
6674
Gilles Peskine449bd832023-01-11 14:50:10 +01006675static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6676 mbedtls_svc_key_id_t key,
6677 psa_algorithm_t alg,
6678 const unsigned char *raw_psk, size_t raw_psk_length,
6679 const unsigned char *seed, size_t seed_length,
6680 const unsigned char *label, size_t label_length,
6681 const unsigned char *other_secret,
6682 size_t other_secret_length,
6683 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006684{
6685 psa_status_t status;
6686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 status = psa_key_derivation_setup(derivation, alg);
6688 if (status != PSA_SUCCESS) {
6689 return status;
6690 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006691
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6693 status = psa_key_derivation_input_bytes(derivation,
6694 PSA_KEY_DERIVATION_INPUT_SEED,
6695 seed, seed_length);
6696 if (status != PSA_SUCCESS) {
6697 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006698 }
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 if (other_secret != NULL) {
6701 status = psa_key_derivation_input_bytes(derivation,
6702 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6703 other_secret, other_secret_length);
6704 if (status != PSA_SUCCESS) {
6705 return status;
6706 }
6707 }
6708
6709 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006710 status = psa_key_derivation_input_bytes(
6711 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 raw_psk, raw_psk_length);
6713 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006714 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 if (status != PSA_SUCCESS) {
6718 return status;
6719 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 status = psa_key_derivation_input_bytes(derivation,
6722 PSA_KEY_DERIVATION_INPUT_LABEL,
6723 label, label_length);
6724 if (status != PSA_SUCCESS) {
6725 return status;
6726 }
6727 } else {
6728 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006729 }
6730
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 status = psa_key_derivation_set_capacity(derivation, capacity);
6732 if (status != PSA_SUCCESS) {
6733 return status;
6734 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006737}
6738
Andrzej Kurek57d10632022-10-24 10:32:01 -04006739#if defined(PSA_WANT_ALG_SHA_384) || \
6740 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006741MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006742static int tls_prf_generic(mbedtls_md_type_t md_type,
6743 const unsigned char *secret, size_t slen,
6744 const char *label,
6745 const unsigned char *random, size_t rlen,
6746 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006747{
6748 psa_status_t status;
6749 psa_algorithm_t alg;
6750 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6751 psa_key_derivation_operation_t derivation =
6752 PSA_KEY_DERIVATION_OPERATION_INIT;
6753
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006755 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006757 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006759
6760 /* Normally a "secret" should be long enough to be impossible to
6761 * find by brute force, and in particular should not be empty. But
6762 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6763 * and for this use case it makes sense to have a 0-length "secret".
6764 * Since the key API doesn't allow importing a key of length 0,
6765 * keep master_key=0, which setup_psa_key_derivation() understands
6766 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006768 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6770 psa_set_key_algorithm(&key_attributes, alg);
6771 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006772
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6774 if (status != PSA_SUCCESS) {
6775 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6776 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006777 }
6778
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 status = setup_psa_key_derivation(&derivation,
6780 master_key, alg,
6781 NULL, 0,
6782 random, rlen,
6783 (unsigned char const *) label,
6784 (size_t) strlen(label),
6785 NULL, 0,
6786 dlen);
6787 if (status != PSA_SUCCESS) {
6788 psa_key_derivation_abort(&derivation);
6789 psa_destroy_key(master_key);
6790 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006791 }
6792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6794 if (status != PSA_SUCCESS) {
6795 psa_key_derivation_abort(&derivation);
6796 psa_destroy_key(master_key);
6797 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006798 }
6799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 status = psa_key_derivation_abort(&derivation);
6801 if (status != PSA_SUCCESS) {
6802 psa_destroy_key(master_key);
6803 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006804 }
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 if (!mbedtls_svc_key_id_is_null(master_key)) {
6807 status = psa_destroy_key(master_key);
6808 }
6809 if (status != PSA_SUCCESS) {
6810 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6811 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006814}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006815#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006816#else /* MBEDTLS_USE_PSA_CRYPTO */
6817
Andrzej Kurek57d10632022-10-24 10:32:01 -04006818#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006819 (defined(MBEDTLS_MD_CAN_SHA256) || \
6820 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006822static int tls_prf_generic(mbedtls_md_type_t md_type,
6823 const unsigned char *secret, size_t slen,
6824 const char *label,
6825 const unsigned char *random, size_t rlen,
6826 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006827{
6828 size_t nb;
6829 size_t i, j, k, md_len;
6830 unsigned char *tmp;
6831 size_t tmp_len = 0;
6832 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6833 const mbedtls_md_info_t *md_info;
6834 mbedtls_md_context_t md_ctx;
6835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6840 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6841 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 tmp_len = md_len + strlen(label) + rlen;
6846 tmp = mbedtls_calloc(1, tmp_len);
6847 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006848 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6849 goto exit;
6850 }
6851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 nb = strlen(label);
6853 memcpy(tmp + md_len, label, nb);
6854 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006855 nb += rlen;
6856
6857 /*
6858 * Compute P_<hash>(secret, label + random)[0..dlen]
6859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006861 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6865 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006866 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 }
6868 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6869 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006870 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 }
6872 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6873 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006874 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 for (i = 0; i < dlen; i += md_len) {
6878 ret = mbedtls_md_hmac_reset(&md_ctx);
6879 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006880 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 }
6882 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6883 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 }
6886 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6887 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006888 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 ret = mbedtls_md_hmac_reset(&md_ctx);
6892 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006893 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 }
6895 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6896 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006897 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 }
6899 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6900 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006901 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006907 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006909 }
6910
6911exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006913
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 if (tmp != NULL) {
6915 mbedtls_platform_zeroize(tmp, tmp_len);
6916 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006923}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006924#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006925#endif /* MBEDTLS_USE_PSA_CRYPTO */
6926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006928MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006929static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6930 const char *label,
6931 const unsigned char *random, size_t rlen,
6932 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006933{
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6935 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006936}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006937#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006939#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006940MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006941static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6942 const char *label,
6943 const unsigned char *random, size_t rlen,
6944 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006945{
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6947 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006948}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006949#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006950
Jerry Yuf009d862022-02-17 14:01:37 +08006951/*
6952 * Set appropriate PRF function and other SSL / TLS1.2 functions
6953 *
6954 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006955 * - hash associated with the ciphersuite (only used by TLS 1.2)
6956 *
6957 * Outputs:
6958 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6959 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006961static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6962 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006963{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006964#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006966 handshake->tls_prf = tls_prf_sha384;
6967 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6968 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006970#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006971#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006972 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006973 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006974 handshake->tls_prf = tls_prf_sha256;
6975 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6976 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6977 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006978#else
Jerry Yuf009d862022-02-17 14:01:37 +08006979 {
Jerry Yuf009d862022-02-17 14:01:37 +08006980 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006981 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006983 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006984#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006987}
Jerry Yud6ab2352022-02-17 14:03:43 +08006988
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006989/*
6990 * Compute master secret if needed
6991 *
6992 * Parameters:
6993 * [in/out] handshake
6994 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6995 * (PSA-PSK) ciphersuite_info, psk_opaque
6996 * [out] premaster (cleared)
6997 * [out] master
6998 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6999 * debug: conf->f_dbg, conf->p_dbg
7000 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007001 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007002 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007003MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007004static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7005 unsigned char *master,
7006 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007007{
7008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7009
7010 /* cf. RFC 5246, Section 8.1:
7011 * "The master secret is always exactly 48 bytes in length." */
7012 size_t const master_secret_len = 48;
7013
7014#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7015 unsigned char session_hash[48];
7016#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7017
7018 /* The label for the KDF used for key expansion.
7019 * This is either "master secret" or "extended master secret"
7020 * depending on whether the Extended Master Secret extension
7021 * is used. */
7022 char const *lbl = "master secret";
7023
Przemek Stekielae4ed302022-04-05 17:15:55 +02007024 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007025 * - If the Extended Master Secret extension is not used,
7026 * this is ClientHello.Random + ServerHello.Random
7027 * (see Sect. 8.1 in RFC 5246).
7028 * - If the Extended Master Secret extension is used,
7029 * this is the transcript of the handshake so far.
7030 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007031 unsigned char const *seed = handshake->randbytes;
7032 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007033
7034#if !defined(MBEDTLS_DEBUG_C) && \
7035 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7036 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007038 ssl = NULL; /* make sure we don't use it except for those cases */
7039 (void) ssl;
7040#endif
7041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 if (handshake->resume != 0) {
7043 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7044 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045 }
7046
7047#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007049 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007050 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007051 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7052 if (ret != 0) {
7053 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7054 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7057 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007059#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007060
Przemek Stekiel99114f32022-04-22 11:20:09 +02007061#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007062 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064 /* Perform PSK-to-MS expansion in a single step. */
7065 psa_status_t status;
7066 psa_algorithm_t alg;
7067 mbedtls_svc_key_id_t psk;
7068 psa_key_derivation_operation_t derivation =
7069 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007070 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007077 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007079 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007081
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007082 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007086 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007087 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007088 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007089 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007090 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007091 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007092 other_secret_len = 48;
7093 other_secret = handshake->premaster + 2;
7094 break;
7095 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007096 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007097 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7098 other_secret = handshake->premaster + 2;
7099 break;
7100 default:
7101 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007102 }
7103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 status = setup_psa_key_derivation(&derivation, psk, alg,
7105 ssl->conf->psk, ssl->conf->psk_len,
7106 seed, seed_len,
7107 (unsigned char const *) lbl,
7108 (size_t) strlen(lbl),
7109 other_secret, other_secret_len,
7110 master_secret_len);
7111 if (status != PSA_SUCCESS) {
7112 psa_key_derivation_abort(&derivation);
7113 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007114 }
7115
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 status = psa_key_derivation_output_bytes(&derivation,
7117 master,
7118 master_secret_len);
7119 if (status != PSA_SUCCESS) {
7120 psa_key_derivation_abort(&derivation);
7121 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007122 }
7123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 status = psa_key_derivation_abort(&derivation);
7125 if (status != PSA_SUCCESS) {
7126 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7127 }
7128 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007129#endif
7130 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007131#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7133 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007134 psa_status_t status;
7135 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7136 psa_key_derivation_operation_t derivation =
7137 PSA_KEY_DERIVATION_OPERATION_INIT;
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007140
7141 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 status = psa_key_derivation_setup(&derivation, alg);
7144 if (status != PSA_SUCCESS) {
7145 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007146 }
7147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 status = psa_key_derivation_set_capacity(&derivation,
7149 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7150 if (status != PSA_SUCCESS) {
7151 psa_key_derivation_abort(&derivation);
7152 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007153 }
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7156 &derivation);
7157 if (status != PSA_SUCCESS) {
7158 psa_key_derivation_abort(&derivation);
7159 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007160 }
7161
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 status = psa_key_derivation_output_bytes(&derivation,
7163 handshake->premaster,
7164 handshake->pmslen);
7165 if (status != PSA_SUCCESS) {
7166 psa_key_derivation_abort(&derivation);
7167 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7168 }
7169
7170 status = psa_key_derivation_abort(&derivation);
7171 if (status != PSA_SUCCESS) {
7172 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007173 }
7174 }
7175#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7177 lbl, seed, seed_len,
7178 master,
7179 master_secret_len);
7180 if (ret != 0) {
7181 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7182 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007183 }
7184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7186 handshake->premaster,
7187 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 mbedtls_platform_zeroize(handshake->premaster,
7190 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007191 }
7192
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007194}
7195
Gilles Peskine449bd832023-01-11 14:50:10 +01007196int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007197{
7198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7199 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7200 ssl->handshake->ciphersuite_info;
7201
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007203
7204 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007206 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 if (ret != 0) {
7208 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7209 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007210 }
7211
7212 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 ret = ssl_compute_master(ssl->handshake,
7214 ssl->session_negotiate->master,
7215 ssl);
7216 if (ret != 0) {
7217 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7218 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007219 }
7220
7221 /* Swap the client and server random values:
7222 * - MS derivation wanted client+server (RFC 5246 8.1)
7223 * - key derivation wants server+client (RFC 5246 6.3) */
7224 {
7225 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 memcpy(tmp, ssl->handshake->randbytes, 64);
7227 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7228 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7229 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007230 }
7231
7232 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7234 ssl->session_negotiate->ciphersuite,
7235 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007236#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007238#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 ssl->handshake->tls_prf,
7240 ssl->handshake->randbytes,
7241 ssl->tls_version,
7242 ssl->conf->endpoint,
7243 ssl);
7244 if (ret != 0) {
7245 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7246 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007247 }
7248
7249 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7251 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007252
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007256}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007259{
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007261#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007262 case MBEDTLS_SSL_HASH_SHA384:
7263 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7264 break;
7265#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007266#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007267 case MBEDTLS_SSL_HASH_SHA256:
7268 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7269 break;
7270#endif
7271 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007273 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007274#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7275 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007276 (void) ssl;
7277#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007279}
7280
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007281#if defined(MBEDTLS_USE_PSA_CRYPTO)
7282static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7283 const psa_hash_operation_t *hs_op,
7284 size_t buffer_size,
7285 unsigned char *hash,
7286 size_t *hlen)
7287{
7288 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007289 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007290
7291#if !defined(MBEDTLS_DEBUG_C)
7292 (void) ssl;
7293#endif
7294 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007295 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007296 if (status != PSA_SUCCESS) {
7297 goto exit;
7298 }
7299
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007300 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007301 if (status != PSA_SUCCESS) {
7302 goto exit;
7303 }
7304
7305 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7306 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7307
7308exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007309 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007310 return mbedtls_md_error_from_psa(status);
7311}
7312#else
7313static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7314 const mbedtls_md_context_t *hs_ctx,
7315 unsigned char *hash,
7316 size_t *hlen)
7317{
7318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007319 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007320
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007321 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007322
7323#if !defined(MBEDTLS_DEBUG_C)
7324 (void) ssl;
7325#endif
7326 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7327
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007328 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007329 if (ret != 0) {
7330 goto exit;
7331 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007332 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007333 if (ret != 0) {
7334 goto exit;
7335 }
7336
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007337 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007338 if (ret != 0) {
7339 goto exit;
7340 }
7341
7342 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7343
7344 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7345 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7346
7347exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007348 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007349 return ret;
7350}
7351#endif /* MBEDTLS_USE_PSA_CRYPTO */
7352
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007353#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007354int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7355 unsigned char *hash,
7356 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +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_sha256_psa, 32,
7360 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007361#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007362 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7363 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007364#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007365}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007366#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007367
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007368#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007369int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7370 unsigned char *hash,
7371 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007372{
7373#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007374 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7375 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007376#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7378 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007380}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007381#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007382
Neil Armstrong80f6f322022-05-03 17:56:38 +02007383#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7384 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007385int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007386{
7387 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007389 const unsigned char *psk = NULL;
7390 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007394 /*
7395 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007396 * checked before calling this function.
7397 *
7398 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007399 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7402 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7403 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007404 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007405 }
7406
7407 /*
7408 * PMS = struct {
7409 * opaque other_secret<0..2^16-1>;
7410 * opaque psk<0..2^16-1>;
7411 * };
7412 * with "other_secret" depending on the particular key exchange
7413 */
7414#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7416 if (end - p < 2) {
7417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7418 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007419
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007421 p += 2;
7422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (end < p || (size_t) (end - p) < psk_len) {
7424 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7425 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007428 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007430#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7431#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007433 /*
7434 * other_secret already set by the ClientKeyExchange message,
7435 * and is 48 bytes long
7436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (end - p < 2) {
7438 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7439 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007440
7441 *p++ = 0;
7442 *p++ = 48;
7443 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007445#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7446#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7449 size_t len;
7450
7451 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007453 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7455 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7456 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007457 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007459 p += 2 + len;
7460
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7462 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007463#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007464#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7467 size_t zlen;
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007470 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7472 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7473 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007474 }
7475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007477 p += 2 + zlen;
7478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7480 MBEDTLS_DEBUG_ECDH_Z);
7481 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007482#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007483 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7485 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007486 }
7487
7488 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (end - p < 2) {
7490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7491 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007494 p += 2;
7495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (end < p || (size_t) (end - p) < psk_len) {
7497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7498 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007501 p += psk_len;
7502
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007503 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007506}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007507#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007508
7509#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007511static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007512
7513#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007515{
7516 /* If renegotiation is not enforced, retransmit until we would reach max
7517 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007519 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7520 unsigned char doublings = 1;
7521
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007523 ++doublings;
7524 ratio >>= 1;
7525 }
7526
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 if (++ssl->renego_records_seen > doublings) {
7528 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7529 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007530 }
7531 }
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007534}
7535#endif
7536#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007537
Jerry Yud9526692022-02-17 14:23:47 +08007538/*
7539 * Handshake functions
7540 */
7541#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7542/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007544{
7545 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7546 ssl->handshake->ciphersuite_info;
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7551 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007552 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007554 }
7555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7557 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007558}
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007561{
7562 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7563 ssl->handshake->ciphersuite_info;
7564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7568 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007569 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007571 }
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7574 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007575}
7576
7577#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7578/* Some certificate support -> implement write and parse */
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007581{
7582 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7583 size_t i, n;
7584 const mbedtls_x509_crt *crt;
7585 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7586 ssl->handshake->ciphersuite_info;
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007589
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7591 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007592 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007594 }
7595
7596#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7598 if (ssl->handshake->client_auth == 0) {
7599 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007600 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007602 }
7603 }
7604#endif /* MBEDTLS_SSL_CLI_C */
7605#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7607 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007608 /* Should never happen because we shouldn't have picked the
7609 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007611 }
7612 }
7613#endif
7614
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007616
7617 /*
7618 * 0 . 0 handshake type
7619 * 1 . 3 handshake length
7620 * 4 . 6 length of all certs
7621 * 7 . 9 length of cert. 1
7622 * 10 . n-1 peer certificate
7623 * n . n+2 length of cert. 2
7624 * n+3 . ... upper level cert, etc.
7625 */
7626 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007630 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7632 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7633 " > %" MBEDTLS_PRINTF_SIZET,
7634 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7635 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007636 }
7637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7639 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7640 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007643 i += n; crt = crt->next;
7644 }
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7647 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7648 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007649
7650 ssl->out_msglen = i;
7651 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7652 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7653
7654 ssl->state++;
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7657 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7658 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007659 }
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007662
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007664}
7665
7666#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7667
7668#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007669MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007670static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7671 unsigned char *crt_buf,
7672 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007673{
7674 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (peer_crt == NULL) {
7677 return -1;
7678 }
Jerry Yud9526692022-02-17 14:23:47 +08007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (peer_crt->raw.len != crt_buf_len) {
7681 return -1;
7682 }
Jerry Yud9526692022-02-17 14:23:47 +08007683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007685}
7686#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007688static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7689 unsigned char *crt_buf,
7690 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007691{
7692 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7693 unsigned char const * const peer_cert_digest =
7694 ssl->session->peer_cert_digest;
7695 mbedtls_md_type_t const peer_cert_digest_type =
7696 ssl->session->peer_cert_digest_type;
7697 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007699 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7700 size_t digest_len;
7701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (peer_cert_digest == NULL || digest_info == NULL) {
7703 return -1;
7704 }
Jerry Yud9526692022-02-17 14:23:47 +08007705
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 digest_len = mbedtls_md_get_size(digest_info);
7707 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7708 return -1;
7709 }
Jerry Yud9526692022-02-17 14:23:47 +08007710
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7712 if (ret != 0) {
7713 return -1;
7714 }
Jerry Yud9526692022-02-17 14:23:47 +08007715
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007717}
7718#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7719#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7720
7721/*
7722 * Once the certificate message is read, parse it into a cert chain and
7723 * perform basic checks, but leave actual verification to the caller
7724 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007726static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7727 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007728{
7729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7730#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007732#endif
7733 size_t i, n;
7734 uint8_t alert;
7735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7737 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7738 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7739 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7740 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007741 }
7742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7744 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7745 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7746 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007747 }
7748
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
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
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007757
7758 /*
7759 * Same message structure as in mbedtls_ssl_write_certificate()
7760 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007761 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007762
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 if (ssl->in_msg[i] != 0 ||
7764 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7766 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7767 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7768 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007769 }
7770
7771 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7772 i += 3;
7773
7774 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007776 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (i + 3 > ssl->in_hslen) {
7778 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7779 mbedtls_ssl_send_alert_message(ssl,
7780 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7781 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7782 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007783 }
7784 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7785 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (ssl->in_msg[i] != 0) {
7787 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7788 mbedtls_ssl_send_alert_message(ssl,
7789 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7790 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7791 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007792 }
7793
7794 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007795 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007796 i += 3;
7797
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (n < 128 || i + n > ssl->in_hslen) {
7799 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7800 mbedtls_ssl_send_alert_message(ssl,
7801 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7802 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7803 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007804 }
7805
7806 /* Check if we're handling the first CRT in the chain. */
7807#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007809 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007811 /* During client-side renegotiation, check that the server's
7812 * end-CRTs hasn't changed compared to the initial handshake,
7813 * mitigating the triple handshake attack. On success, reuse
7814 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7816 if (ssl_check_peer_crt_unchanged(ssl,
7817 &ssl->in_msg[i],
7818 n) != 0) {
7819 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7820 mbedtls_ssl_send_alert_message(ssl,
7821 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7822 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7823 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007824 }
7825
7826 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007828 }
7829#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7830
7831 /* Parse the next certificate in the chain. */
7832#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007834#else
7835 /* If we don't need to store the CRT chain permanently, parse
7836 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007838#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007840 case 0: /*ok*/
7841 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7842 /* Ignore certificate with an unknown algorithm: maybe a
7843 prior certificate was already trusted. */
7844 break;
7845
7846 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7847 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7848 goto crt_parse_der_failed;
7849
7850 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7851 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7852 goto crt_parse_der_failed;
7853
7854 default:
7855 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007856crt_parse_der_failed:
7857 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7858 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7859 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007860 }
7861
7862 i += n;
7863 }
7864
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7866 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007867}
7868
7869#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007870MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007871static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007872{
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7874 return -1;
7875 }
Jerry Yud9526692022-02-17 14:23:47 +08007876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007878 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7879 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7881 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7882 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007883 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007885}
7886#endif /* MBEDTLS_SSL_SRV_C */
7887
7888/* Check if a certificate message is expected.
7889 * Return either
7890 * - SSL_CERTIFICATE_EXPECTED, or
7891 * - SSL_CERTIFICATE_SKIP
7892 * indicating whether a Certificate message is expected or not.
7893 */
7894#define SSL_CERTIFICATE_EXPECTED 0
7895#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007896MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007897static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7898 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007899{
7900 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7901 ssl->handshake->ciphersuite_info;
7902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7904 return SSL_CERTIFICATE_SKIP;
7905 }
Jerry Yud9526692022-02-17 14:23:47 +08007906
7907#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7909 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7910 return SSL_CERTIFICATE_SKIP;
7911 }
Jerry Yud9526692022-02-17 14:23:47 +08007912
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007914 ssl->session_negotiate->verify_result =
7915 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007917 }
7918 }
7919#else
7920 ((void) authmode);
7921#endif /* MBEDTLS_SSL_SRV_C */
7922
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007924}
7925
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007926MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007927static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7928 int authmode,
7929 mbedtls_x509_crt *chain,
7930 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007931{
7932 int ret = 0;
7933 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7934 ssl->handshake->ciphersuite_info;
7935 int have_ca_chain = 0;
7936
7937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7938 void *p_vrfy;
7939
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7941 return 0;
7942 }
Jerry Yud9526692022-02-17 14:23:47 +08007943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 if (ssl->f_vrfy != NULL) {
7945 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007946 f_vrfy = ssl->f_vrfy;
7947 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 } else {
7949 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007950 f_vrfy = ssl->conf->f_vrfy;
7951 p_vrfy = ssl->conf->p_vrfy;
7952 }
7953
7954 /*
7955 * Main check: verify certificate
7956 */
7957#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007959 ((void) rs_ctx);
7960 have_ca_chain = 1;
7961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007963 ret = mbedtls_x509_crt_verify_with_ca_cb(
7964 chain,
7965 ssl->conf->f_ca_cb,
7966 ssl->conf->p_ca_cb,
7967 ssl->conf->cert_profile,
7968 ssl->hostname,
7969 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 f_vrfy, p_vrfy);
7971 } else
Jerry Yud9526692022-02-17 14:23:47 +08007972#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7973 {
7974 mbedtls_x509_crt *ca_chain;
7975 mbedtls_x509_crl *ca_crl;
7976
7977#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007979 ca_chain = ssl->handshake->sni_ca_chain;
7980 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 } else
Jerry Yud9526692022-02-17 14:23:47 +08007982#endif
7983 {
7984 ca_chain = ssl->conf->ca_chain;
7985 ca_crl = ssl->conf->ca_crl;
7986 }
7987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007989 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 }
Jerry Yud9526692022-02-17 14:23:47 +08007991
7992 ret = mbedtls_x509_crt_verify_restartable(
7993 chain,
7994 ca_chain, ca_crl,
7995 ssl->conf->cert_profile,
7996 ssl->hostname,
7997 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007999 }
8000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ret != 0) {
8002 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008003 }
8004
8005#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8007 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8008 }
Jerry Yud9526692022-02-17 14:23:47 +08008009#endif
8010
8011 /*
8012 * Secondary checks: always done, but change 'ret' only if it was 0
8013 */
8014
Valerio Settiacd32c02023-06-29 18:06:29 +02008015#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008016 {
8017 const mbedtls_pk_context *pk = &chain->pk;
8018
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008019 /* If certificate uses an EC key, make sure the curve is OK.
8020 * This is a public key, so it can't be opaque, so can_do() is a good
8021 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008023 /* and in the unlikely case the above assumption no longer holds
8024 * we are making sure that pk_ec() here does not return a NULL
8025 */
Valerio Settif9362b72023-11-29 08:42:27 +01008026 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008027 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8028 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008030 }
Valerio Setti97207782023-05-18 18:59:06 +02008031 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008032 ssl->session_negotiate->verify_result |=
8033 MBEDTLS_X509_BADCERT_BAD_KEY;
8034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8036 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008037 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008039 }
Jerry Yud9526692022-02-17 14:23:47 +08008040 }
8041 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008042#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 if (mbedtls_ssl_check_cert_usage(chain,
8045 ciphersuite_info,
8046 !ssl->conf->endpoint,
8047 &ssl->session_negotiate->verify_result) != 0) {
8048 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8049 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008050 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 }
Jerry Yud9526692022-02-17 14:23:47 +08008052 }
8053
8054 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8055 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8056 * with details encoded in the verification flags. All other kinds
8057 * of error codes, including those from the user provided f_vrfy
8058 * functions, are treated as fatal and lead to a failure of
8059 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8061 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8062 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008063 ret = 0;
8064 }
8065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8067 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008068 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8069 }
8070
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008072 uint8_t alert;
8073
8074 /* The certificate may have been rejected for several reasons.
8075 Pick one and send the corresponding alert. Which alert to send
8076 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008080 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008082 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008084 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008086 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008088 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008090 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008092 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008094 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008096 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008098 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 }
8100 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8101 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008102 }
8103
8104#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if (ssl->session_negotiate->verify_result != 0) {
8106 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8107 (unsigned int) ssl->session_negotiate->verify_result));
8108 } else {
8109 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008110 }
8111#endif /* MBEDTLS_DEBUG_C */
8112
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008114}
8115
8116#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008118static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8119 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008120{
8121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8122 /* Remember digest of the peer's end-CRT. */
8123 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8125 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8126 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8127 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8128 mbedtls_ssl_send_alert_message(ssl,
8129 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8130 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008131
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008133 }
8134
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 ret = mbedtls_md(mbedtls_md_info_from_type(
8136 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8137 start, len,
8138 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008139
8140 ssl->session_negotiate->peer_cert_digest_type =
8141 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8142 ssl->session_negotiate->peer_cert_digest_len =
8143 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8144
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008146}
8147
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008148MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008149static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8150 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008151{
8152 unsigned char *end = start + len;
8153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8154
8155 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8157 ret = mbedtls_pk_parse_subpubkey(&start, end,
8158 &ssl->handshake->peer_pubkey);
8159 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008160 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008162 }
8163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008165}
8166#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008169{
8170 int ret = 0;
8171 int crt_expected;
8172#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8173 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8174 ? ssl->handshake->sni_authmode
8175 : ssl->conf->authmode;
8176#else
8177 const int authmode = ssl->conf->authmode;
8178#endif
8179 void *rs_ctx = NULL;
8180 mbedtls_x509_crt *chain = NULL;
8181
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008183
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8185 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8186 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008187 goto exit;
8188 }
8189
8190#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 if (ssl->handshake->ecrs_enabled &&
8192 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008193 chain = ssl->handshake->ecrs_peer_cert;
8194 ssl->handshake->ecrs_peer_cert = NULL;
8195 goto crt_verify;
8196 }
8197#endif
8198
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008200 /* mbedtls_ssl_read_record may have sent an alert already. We
8201 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008203 goto exit;
8204 }
8205
8206#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008208 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8209
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008211 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 }
Jerry Yud9526692022-02-17 14:23:47 +08008213
8214 goto exit;
8215 }
8216#endif /* MBEDTLS_SSL_SRV_C */
8217
8218 /* Clear existing peer CRT structure in case we tried to
8219 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008221
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8223 if (chain == NULL) {
8224 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8225 sizeof(mbedtls_x509_crt)));
8226 mbedtls_ssl_send_alert_message(ssl,
8227 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8228 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008229
8230 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8231 goto exit;
8232 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008234
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 ret = ssl_parse_certificate_chain(ssl, chain);
8236 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 }
Jerry Yud9526692022-02-17 14:23:47 +08008239
8240#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008242 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 }
Jerry Yud9526692022-02-17 14:23:47 +08008244
8245crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008247 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 }
Jerry Yud9526692022-02-17 14:23:47 +08008249#endif
8250
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 ret = ssl_parse_certificate_verify(ssl, authmode,
8252 chain, rs_ctx);
8253 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008254 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 }
Jerry Yud9526692022-02-17 14:23:47 +08008256
8257#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8258 {
8259 unsigned char *crt_start, *pk_start;
8260 size_t crt_len, pk_len;
8261
8262 /* We parse the CRT chain without copying, so
8263 * these pointers point into the input buffer,
8264 * and are hence still valid after freeing the
8265 * CRT chain. */
8266
8267 crt_start = chain->raw.p;
8268 crt_len = chain->raw.len;
8269
8270 pk_start = chain->pk_raw.p;
8271 pk_len = chain->pk_raw.len;
8272
8273 /* Free the CRT structures before computing
8274 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 mbedtls_x509_crt_free(chain);
8276 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008277 chain = NULL;
8278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8280 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 }
Jerry Yud9526692022-02-17 14:23:47 +08008283
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8285 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 }
Jerry Yud9526692022-02-17 14:23:47 +08008288 }
8289#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8290 /* Pass ownership to session structure. */
8291 ssl->session_negotiate->peer_cert = chain;
8292 chain = NULL;
8293#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008296
8297exit:
8298
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008300 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 }
Jerry Yud9526692022-02-17 14:23:47 +08008302
8303#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008305 ssl->handshake->ecrs_peer_cert = chain;
8306 chain = NULL;
8307 }
8308#endif
8309
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 if (chain != NULL) {
8311 mbedtls_x509_crt_free(chain);
8312 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008313 }
8314
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008316}
8317#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8318
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008319static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8320 unsigned char *padbuf, size_t hlen,
8321 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008322{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008323 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008324 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008325#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008326 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008327 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008328 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008329 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008330#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008331 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008332 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008333 mbedtls_md_context_t cloned_ctx;
8334 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008335#endif
8336
8337 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008339 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008341
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008343 ? "client finished"
8344 : "server finished";
8345
8346#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008347 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008348
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008349 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008351 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008352 }
8353
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008354 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008356 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008357 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008358 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008359#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008360 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008361
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008362 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008363 if (ret != 0) {
8364 goto exit;
8365 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008366 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008367 if (ret != 0) {
8368 goto exit;
8369 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008370
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008371 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008372 if (ret != 0) {
8373 goto exit;
8374 }
8375#endif /* MBEDTLS_USE_PSA_CRYPTO */
8376
8377 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8378
Jerry Yu615bd6f2022-02-17 14:25:15 +08008379 /*
8380 * TLSv1.2:
8381 * hash = PRF( master, finished_label,
8382 * Hash( handshake ) )[0.11]
8383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008385 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008386
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008388
Paul Elliottecb95be2023-08-11 16:41:04 +01008389 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008390
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008391 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008392
8393exit:
8394#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008395 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008396 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008397#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008398 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008399 return ret;
8400#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008401}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008402
8403#if defined(MBEDTLS_MD_CAN_SHA256)
8404static int ssl_calc_finished_tls_sha256(
8405 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8406{
8407 unsigned char padbuf[32];
8408 return ssl_calc_finished_tls_generic(ssl,
8409#if defined(MBEDTLS_USE_PSA_CRYPTO)
8410 &ssl->handshake->fin_sha256_psa,
8411#else
8412 &ssl->handshake->fin_sha256,
8413#endif
8414 padbuf, sizeof(padbuf),
8415 buf, from);
8416}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008417#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008418
Jerry Yub7ba49e2022-02-17 14:25:53 +08008419
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008420#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008421static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008423{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008424 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008425 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008426#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008427 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008428#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008429 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008430#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008431 padbuf, sizeof(padbuf),
8432 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008433}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008434#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008437{
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008439
8440 /*
8441 * Free our handshake params
8442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 mbedtls_ssl_handshake_free(ssl);
8444 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008445 ssl->handshake = NULL;
8446
8447 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008448 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008449 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 if (ssl->transform) {
8451 mbedtls_ssl_transform_free(ssl->transform);
8452 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008453 }
8454 ssl->transform = ssl->transform_negotiate;
8455 ssl->transform_negotiate = NULL;
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008458}
8459
Gilles Peskine449bd832023-01-11 14:50:10 +01008460void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008461{
8462 int resume = ssl->handshake->resume;
8463
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008465
8466#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008468 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8469 ssl->renego_records_seen = 0;
8470 }
8471#endif
8472
8473 /*
8474 * Free the previous session and switch in the current one
8475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008477#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8478 /* RFC 7366 3.1: keep the EtM state */
8479 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008481#endif
8482
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 mbedtls_ssl_session_free(ssl->session);
8484 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008485 }
8486 ssl->session = ssl->session_negotiate;
8487 ssl->session_negotiate = NULL;
8488
8489 /*
8490 * Add cache entry
8491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008493 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 resume == 0) {
8495 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8496 ssl->session->id,
8497 ssl->session->id_len,
8498 ssl->session) != 0) {
8499 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8500 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008501 }
8502
8503#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8505 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008506 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008508
8509 /* Keep last flight around in case we need to resend it:
8510 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8512 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008513#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008515
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008516 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008519}
8520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008522{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008523 int ret;
8524 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008529
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008530 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8531 if (ret != 0) {
8532 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8533 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008534
8535 /*
8536 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8537 * may define some other value. Currently (early 2016), no defined
8538 * ciphersuite does this (and this is unlikely to change as activity has
8539 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8540 */
8541 hash_len = 12;
8542
8543#if defined(MBEDTLS_SSL_RENEGOTIATION)
8544 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008546#endif
8547
8548 ssl->out_msglen = 4 + hash_len;
8549 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8550 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8551
8552 /*
8553 * In case of session resuming, invert the client and server
8554 * ChangeCipherSpec messages order.
8555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008557#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008559 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008561#endif
8562#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008564 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008566#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008568 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008570
8571 /*
8572 * Switch to our negotiated transform and session parameters for outbound
8573 * data.
8574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008576
8577#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008579 unsigned char i;
8580
8581 /* Remember current epoch settings for resending */
8582 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8584 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008585
8586 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588
8589
8590 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 for (i = 2; i > 0; i--) {
8592 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008593 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 }
8595 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008596
8597 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 if (i == 0) {
8599 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8600 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008601 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008603#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008605
8606 ssl->transform_out = ssl->transform_negotiate;
8607 ssl->session_out = ssl->session_negotiate;
8608
8609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8611 mbedtls_ssl_send_flight_completed(ssl);
8612 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008613#endif
8614
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8616 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8617 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008618 }
8619
8620#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8622 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8623 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8624 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008625 }
8626#endif
8627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008629
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008631}
8632
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008633#define SSL_MAX_HASH_LEN 12
8634
Gilles Peskine449bd832023-01-11 14:50:10 +01008635int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008636{
8637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8638 unsigned int hash_len = 12;
8639 unsigned char buf[SSL_MAX_HASH_LEN];
8640
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008642
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008643 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8644 if (ret != 0) {
8645 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8646 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8649 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008650 goto exit;
8651 }
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
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_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008657 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8658 goto exit;
8659 }
8660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8662 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8663 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008664 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8665 goto exit;
8666 }
8667
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8669 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8670 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8671 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008672 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8673 goto exit;
8674 }
8675
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8677 buf, hash_len) != 0) {
8678 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8679 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8680 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008681 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8682 goto exit;
8683 }
8684
8685#if defined(MBEDTLS_SSL_RENEGOTIATION)
8686 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008688#endif
8689
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008691#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008693 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008695#endif
8696#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008698 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008700#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008702 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008704
8705#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8707 mbedtls_ssl_recv_flight_completed(ssl);
8708 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008709#endif
8710
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008712
8713exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 mbedtls_platform_zeroize(buf, hash_len);
8715 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008716}
8717
Jerry Yu392112c2022-02-17 14:34:10 +08008718#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8719/*
8720 * Helper to get TLS 1.2 PRF from ciphersuite
8721 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008723static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008724{
Jerry Yu392112c2022-02-17 14:34:10 +08008725 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008726 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008727#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8729 return tls_prf_sha384;
8730 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008731#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008732#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008733 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8735 return tls_prf_sha256;
8736 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008737 }
8738#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008739#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8740 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008741 (void) ciphersuite_info;
8742#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008743
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008745}
8746#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008747
Gilles Peskine449bd832023-01-11 14:50:10 +01008748static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008749{
8750 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008751#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 if (tls_prf == tls_prf_sha384) {
8753 return MBEDTLS_SSL_TLS_PRF_SHA384;
8754 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008755#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008756#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 if (tls_prf == tls_prf_sha256) {
8758 return MBEDTLS_SSL_TLS_PRF_SHA256;
8759 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008760#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008762}
8763
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008764/*
8765 * Populate a transform structure with session keys and all the other
8766 * necessary information.
8767 *
8768 * Parameters:
8769 * - [in/out]: transform: structure to populate
8770 * [in] must be just initialised with mbedtls_ssl_transform_init()
8771 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8772 * - [in] ciphersuite
8773 * - [in] master
8774 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008775 * - [in] tls_prf: pointer to PRF to use for key derivation
8776 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008777 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008778 * - [in] endpoint: client or server
8779 * - [in] ssl: used for:
8780 * - ssl->conf->{f,p}_export_keys
8781 * [in] optionally used for:
8782 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8783 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008784MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008785static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8786 int ciphersuite,
8787 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008788#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008790#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 ssl_tls_prf_t tls_prf,
8792 const unsigned char randbytes[64],
8793 mbedtls_ssl_protocol_version tls_version,
8794 unsigned endpoint,
8795 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008796{
8797 int ret = 0;
8798 unsigned char keyblk[256];
8799 unsigned char *key1;
8800 unsigned char *key2;
8801 unsigned char *mac_enc;
8802 unsigned char *mac_dec;
8803 size_t mac_key_len = 0;
8804 size_t iv_copy_len;
8805 size_t keylen;
8806 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008807 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008808#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008809 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008810 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008811#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008812
8813#if defined(MBEDTLS_USE_PSA_CRYPTO)
8814 psa_key_type_t key_type;
8815 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8816 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008817 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008818 size_t key_bits;
8819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8820#endif
8821
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008822 /*
8823 * Some data just needs copying into the structure
8824 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008825#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008826 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008827#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008828 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829
8830#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008832#endif
8833
8834#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008836 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8837 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008838 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008839 }
8840#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8841
8842 /*
8843 * Get various info structures
8844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8846 if (ciphersuite_info == NULL) {
8847 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8848 ciphersuite));
8849 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850 }
8851
Neil Armstrongab555e02022-04-04 11:07:59 +02008852 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008853#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008855#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008857
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008859 transform->taglen =
8860 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008862
8863#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008864 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 transform->taglen,
8866 &alg,
8867 &key_type,
8868 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008869 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008871 goto end;
8872 }
8873#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008874 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 if (cipher_info == NULL) {
8876 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8877 ciphersuite_info->cipher));
8878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008879 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008880#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008881
Neil Armstronge4512952022-03-08 09:08:22 +01008882#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008883 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008885 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 (unsigned) ciphersuite_info->mac));
8887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008888 }
8889#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008890 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if (md_info == NULL) {
8892 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8893 (unsigned) ciphersuite_info->mac));
8894 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008895 }
Neil Armstronge4512952022-03-08 09:08:22 +01008896#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008897
8898#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8899 /* Copy own and peer's CID if the use of the CID
8900 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008901 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8902 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008903
8904 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8906 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8907 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008908
8909 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8911 ssl->handshake->peer_cid_len);
8912 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8913 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008914 }
8915#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8916
8917 /*
8918 * Compute key block using the PRF
8919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8921 if (ret != 0) {
8922 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8923 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008924 }
8925
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8927 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8928 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8929 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8930 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931
8932 /*
8933 * Determine the appropriate key, IV and MAC length.
8934 */
8935
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008936#if defined(MBEDTLS_USE_PSA_CRYPTO)
8937 keylen = PSA_BITS_TO_BYTES(key_bits);
8938#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008940#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008941
Valerio Settie5707042023-10-11 11:54:42 +02008942#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944 size_t explicit_ivlen;
8945
8946 transform->maclen = 0;
8947 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008948
8949 /* All modes haves 96-bit IVs, but the length of the static parts vary
8950 * with mode and version:
8951 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8952 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8953 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8954 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8955 * sequence number).
8956 */
8957 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008958
8959 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008960#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008962#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8964 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008965#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008968 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008970 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008972
8973 /* Minimum length of encrypted record */
8974 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8975 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 } else
Valerio Settie5707042023-10-11 11:54:42 +02008977#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008978#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008980 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008982#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008984#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008985 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008986#endif /* MBEDTLS_USE_PSA_CRYPTO */
8987
8988#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008989 /* Get MAC length */
8990 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8991#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008992 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8994 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8995 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008996 goto end;
8997 }
8998
8999 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009001#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009002 transform->maclen = mac_key_len;
9003
9004 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009005#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009007#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009008 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009009#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009010
9011 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009013 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009015 /*
9016 * GenericBlockCipher:
9017 * 1. if EtM is in use: one block plus MAC
9018 * otherwise: * first multiple of blocklen greater than maclen
9019 * 2. IV
9020 */
9021#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009023 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 + block_size;
9025 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009026#endif
9027 {
9028 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 + block_size
9030 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009031 }
9032
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009034 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 } else {
9036 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009037 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9038 goto end;
9039 }
9040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009042#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9043 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009044 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9045 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009046 }
9047
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9049 (unsigned) keylen,
9050 (unsigned) transform->minlen,
9051 (unsigned) transform->ivlen,
9052 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009053
9054 /*
9055 * Finally setup the cipher contexts, IVs and MAC secrets.
9056 */
9057#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009059 key1 = keyblk + mac_key_len * 2;
9060 key2 = keyblk + mac_key_len * 2 + keylen;
9061
9062 mac_enc = keyblk;
9063 mac_dec = keyblk + mac_key_len;
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_enc, key2 + keylen, iv_copy_len);
9068 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9069 iv_copy_len);
9070 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071#endif /* MBEDTLS_SSL_CLI_C */
9072#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009074 key1 = keyblk + mac_key_len * 2 + keylen;
9075 key2 = keyblk + mac_key_len * 2;
9076
9077 mac_enc = keyblk + mac_key_len;
9078 mac_dec = keyblk;
9079
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 iv_copy_len = (transform->fixed_ivlen) ?
9081 transform->fixed_ivlen : transform->ivlen;
9082 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9083 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9084 iv_copy_len);
9085 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009086#endif /* MBEDTLS_SSL_SRV_C */
9087 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009089 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9090 goto end;
9091 }
9092
Paul Elliott4fb19552023-10-18 12:15:30 +01009093 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 ssl->f_export_keys(ssl->p_export_keys,
9095 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9096 master, 48,
9097 randbytes + 32,
9098 randbytes,
9099 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009100 }
9101
9102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009103 transform->psa_alg = alg;
9104
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9106 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9107 psa_set_key_algorithm(&attributes, alg);
9108 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if ((status = psa_import_key(&attributes,
9111 key1,
9112 PSA_BITS_TO_BYTES(key_bits),
9113 &transform->psa_key_enc)) != PSA_SUCCESS) {
9114 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009115 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009117 goto end;
9118 }
9119
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 if ((status = psa_import_key(&attributes,
9123 key2,
9124 PSA_BITS_TO_BYTES(key_bits),
9125 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009126 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009128 goto end;
9129 }
9130 }
9131#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9133 cipher_info)) != 0) {
9134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009135 goto end;
9136 }
9137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9139 cipher_info)) != 0) {
9140 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009141 goto end;
9142 }
9143
Gilles Peskine449bd832023-01-11 14:50:10 +01009144 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9145 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9146 MBEDTLS_ENCRYPT)) != 0) {
9147 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", 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_setkey(&transform->cipher_ctx_dec, key2,
9152 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9153 MBEDTLS_DECRYPT)) != 0) {
9154 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009155 goto end;
9156 }
9157
9158#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9160 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9161 MBEDTLS_PADDING_NONE)) != 0) {
9162 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009163 goto end;
9164 }
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9167 MBEDTLS_PADDING_NONE)) != 0) {
9168 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009169 goto end;
9170 }
9171 }
9172#endif /* MBEDTLS_CIPHER_MODE_CBC */
9173#endif /* MBEDTLS_USE_PSA_CRYPTO */
9174
Neil Armstrong29c0c042022-03-17 17:47:28 +01009175#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9176 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9177 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009179#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009181
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9183 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9184 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009185
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if ((status = psa_import_key(&attributes,
9187 mac_enc, mac_key_len,
9188 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009189 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009191 goto end;
9192 }
9193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9195 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009198#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009200 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9202 PSA_KEY_USAGE_VERIFY_HASH);
9203 } else {
9204 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9205 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009206
Gilles Peskine449bd832023-01-11 14:50:10 +01009207 if ((status = psa_import_key(&attributes,
9208 mac_dec, mac_key_len,
9209 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009210 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009212 goto end;
9213 }
9214#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9216 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009217 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 }
9219 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9220 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009221 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009223#endif /* MBEDTLS_USE_PSA_CRYPTO */
9224 }
9225#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9226
9227 ((void) mac_dec);
9228 ((void) mac_enc);
9229
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009230end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9232 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009233}
9234
Valerio Settia08b1a42022-11-17 15:10:02 +01009235#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9236 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009237int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 psa_pake_operation_t *pake_ctx,
9239 const unsigned char *buf,
9240 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009241{
9242 psa_status_t status;
9243 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009244 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009245 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9246 * At round two perform a single cycle
9247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009249
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 for (; remaining_steps > 0; remaining_steps--) {
9251 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009252 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009254 /* Length is stored at the first byte */
9255 size_t length = buf[input_offset];
9256 input_offset += 1;
9257
Gilles Peskine449bd832023-01-11 14:50:10 +01009258 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009259 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9260 }
9261
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 status = psa_pake_input(pake_ctx, step,
9263 buf + input_offset, length);
9264 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009265 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009266 }
9267
9268 input_offset += length;
9269 }
9270 }
9271
Gilles Peskine449bd832023-01-11 14:50:10 +01009272 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009273 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009275
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009277}
9278
Valerio Setti6b3dab02022-11-17 17:14:54 +01009279int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009280 psa_pake_operation_t *pake_ctx,
9281 unsigned char *buf,
9282 size_t len, size_t *olen,
9283 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009284{
9285 psa_status_t status;
9286 size_t output_offset = 0;
9287 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009288 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009289 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9290 * At round two perform a single cycle
9291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 for (; remaining_steps > 0; remaining_steps--) {
9295 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9296 step <= PSA_PAKE_STEP_ZK_PROOF;
9297 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009298 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009299 * For each step, prepend 1 byte with the length of the data as
9300 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 status = psa_pake_output(pake_ctx, step,
9303 buf + output_offset + 1,
9304 len - output_offset - 1,
9305 &output_len);
9306 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009307 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009308 }
9309
Valerio Setti99d88c12022-11-22 16:03:43 +01009310 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009311
9312 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009313 }
9314 }
9315
9316 *olen = output_offset;
9317
Gilles Peskine449bd832023-01-11 14:50:10 +01009318 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009319}
Valerio Settia08b1a42022-11-17 15:10:02 +01009320#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9321
Jerry Yuee40f9d2022-02-17 14:55:16 +08009322#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009323int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9324 unsigned char *hash, size_t *hashlen,
9325 unsigned char *data, size_t data_len,
9326 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009327{
9328 psa_status_t status;
9329 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009330 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009331
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009333
Gilles Peskine449bd832023-01-11 14:50:10 +01009334 if ((status = psa_hash_setup(&hash_operation,
9335 hash_alg)) != PSA_SUCCESS) {
9336 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009337 goto exit;
9338 }
9339
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9341 64)) != PSA_SUCCESS) {
9342 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009343 goto exit;
9344 }
9345
Gilles Peskine449bd832023-01-11 14:50:10 +01009346 if ((status = psa_hash_update(&hash_operation,
9347 data, data_len)) != PSA_SUCCESS) {
9348 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009349 goto exit;
9350 }
9351
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9353 hashlen)) != PSA_SUCCESS) {
9354 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9355 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009356 }
9357
9358exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 if (status != PSA_SUCCESS) {
9360 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9361 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9362 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009363 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009365 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9366 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009368 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009370 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009372 }
9373 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009375}
9376
9377#else
9378
Gilles Peskine449bd832023-01-11 14:50:10 +01009379int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9380 unsigned char *hash, size_t *hashlen,
9381 unsigned char *data, size_t data_len,
9382 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009383{
9384 int ret = 0;
9385 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9387 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009388
Gilles Peskine449bd832023-01-11 14:50:10 +01009389 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009392
9393 /*
9394 * digitally-signed struct {
9395 * opaque client_random[32];
9396 * opaque server_random[32];
9397 * ServerDHParams params;
9398 * };
9399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9401 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009402 goto exit;
9403 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9405 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009406 goto exit;
9407 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009408 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9409 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009410 goto exit;
9411 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9413 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009414 goto exit;
9415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9417 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009418 goto exit;
9419 }
9420
9421exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009423
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 if (ret != 0) {
9425 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9426 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9427 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009428
Gilles Peskine449bd832023-01-11 14:50:10 +01009429 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009430}
9431#endif /* MBEDTLS_USE_PSA_CRYPTO */
9432
Jerry Yud9d91da2022-02-17 14:57:06 +08009433#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9434
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009435/* Find the preferred hash for a given signature algorithm. */
9436unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 mbedtls_ssl_context *ssl,
9438 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009439{
Gabor Mezei078e8032022-04-27 21:17:56 +02009440 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009441 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009442
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9444 return MBEDTLS_SSL_HASH_NONE;
9445 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009446
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009448 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9450 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009451 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9453 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009454
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009455 mbedtls_md_type_t md_alg =
9456 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9457 if (md_alg == MBEDTLS_MD_NONE) {
9458 continue;
9459 }
9460
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009462#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009464 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009465 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9468 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9469 PSA_ALG_ECDSA(psa_hash_alg),
9470 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009471 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009473
Gilles Peskine449bd832023-01-11 14:50:10 +01009474 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9475 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9476 PSA_ALG_RSA_PKCS1V15_SIGN(
9477 psa_hash_alg),
9478 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009479 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009481 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009482#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009483
Gilles Peskine449bd832023-01-11 14:50:10 +01009484 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009485 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009486 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009487
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009489}
9490
9491#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9492
Jerry Yudc7bd172022-02-17 13:44:15 +08009493#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9494
XiaokangQian75d40ef2022-04-20 11:05:24 +00009495int mbedtls_ssl_validate_ciphersuite(
9496 const mbedtls_ssl_context *ssl,
9497 const mbedtls_ssl_ciphersuite_t *suite_info,
9498 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009500{
9501 (void) ssl;
9502
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (suite_info == NULL) {
9504 return -1;
9505 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009506
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 if ((suite_info->min_tls_version > max_tls_version) ||
9508 (suite_info->max_tls_version < min_tls_version)) {
9509 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009510 }
9511
XiaokangQian060d8672022-04-21 09:24:56 +00009512#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009513#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009514#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9516 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009517#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9519 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009520#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009521 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009523 }
9524#endif
9525
9526 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9527#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9529 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9530 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009531 }
9532#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9534
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009536}
9537
Ronald Crone68ab4f2022-10-05 12:46:29 +02009538#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009539/*
9540 * Function for writing a signature algorithm extension.
9541 *
9542 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9543 * value (TLS 1.3 RFC8446):
9544 * enum {
9545 * ....
9546 * ecdsa_secp256r1_sha256( 0x0403 ),
9547 * ecdsa_secp384r1_sha384( 0x0503 ),
9548 * ecdsa_secp521r1_sha512( 0x0603 ),
9549 * ....
9550 * } SignatureScheme;
9551 *
9552 * struct {
9553 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9554 * } SignatureSchemeList;
9555 *
9556 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9557 * value (TLS 1.2 RFC5246):
9558 * enum {
9559 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9560 * sha512(6), (255)
9561 * } HashAlgorithm;
9562 *
9563 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9564 * SignatureAlgorithm;
9565 *
9566 * struct {
9567 * HashAlgorithm hash;
9568 * SignatureAlgorithm signature;
9569 * } SignatureAndHashAlgorithm;
9570 *
9571 * SignatureAndHashAlgorithm
9572 * supported_signature_algorithms<2..2^16-2>;
9573 *
9574 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9575 * generalization of the TLS 1.2 signature algorithm extension.
9576 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9577 * `SignatureScheme` field of TLS 1.3
9578 *
9579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009580int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9581 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009582{
9583 unsigned char *p = buf;
9584 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9585 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9586
9587 *out_len = 0;
9588
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009590
9591 /* Check if we have space for header and length field:
9592 * - extension_type (2 bytes)
9593 * - extension_data_length (2 bytes)
9594 * - supported_signature_algorithms_length (2 bytes)
9595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009597 p += 6;
9598
9599 /*
9600 * Write supported_signature_algorithms
9601 */
9602 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9604 if (sig_alg == NULL) {
9605 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9606 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009607
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9609 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9610 *sig_alg,
9611 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9612 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009613 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009614 }
9615 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9616 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009617 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9619 *sig_alg,
9620 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009621 }
9622
9623 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009624 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009625 if (supported_sig_alg_len == 0) {
9626 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9627 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009628 }
9629
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9631 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9632 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009633
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009634 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009635
9636#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009638#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009639
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009641}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009642#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009643
XiaokangQian40a35232022-05-07 09:02:40 +00009644#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009645/*
9646 * mbedtls_ssl_parse_server_name_ext
9647 *
9648 * Structure of server_name extension:
9649 *
9650 * enum {
9651 * host_name(0), (255)
9652 * } NameType;
9653 * opaque HostName<1..2^16-1>;
9654 *
9655 * struct {
9656 * NameType name_type;
9657 * select (name_type) {
9658 * case host_name: HostName;
9659 * } name;
9660 * } ServerName;
9661 * struct {
9662 * ServerName server_name_list<1..2^16-1>
9663 * } ServerNameList;
9664 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009665MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009666int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9667 const unsigned char *buf,
9668 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009669{
9670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9671 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009672 size_t server_name_list_len, hostname_len;
9673 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009674
Gilles Peskine449bd832023-01-11 14:50:10 +01009675 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009676
Gilles Peskine449bd832023-01-11 14:50:10 +01009677 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9678 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009679 p += 2;
9680
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009682 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009683 while (p < server_name_list_end) {
9684 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9685 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9686 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9687 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009688
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009690 /* sni_name is intended to be used only during the parsing of the
9691 * ClientHello message (it is reset to NULL before the end of
9692 * the message parsing). Thus it is ok to just point to the
9693 * reception buffer and not make a copy of it.
9694 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009695 ssl->handshake->sni_name = p + 3;
9696 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 if (ssl->conf->f_sni == NULL) {
9698 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009699 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009700 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9701 ssl, p + 3, hostname_len);
9702 if (ret != 0) {
9703 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9704 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9705 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9706 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9707 }
9708 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009709 }
9710
9711 p += hostname_len + 3;
9712 }
9713
Gilles Peskine449bd832023-01-11 14:50:10 +01009714 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009715}
9716#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9717
XiaokangQianacb39922022-06-17 10:18:48 +00009718#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009719MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009720int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9721 const unsigned char *buf,
9722 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009723{
9724 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009725 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009726 const unsigned char *protocol_name_list;
9727 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009728 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009729
9730 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009731 if (ssl->conf->alpn_list == NULL) {
9732 return 0;
9733 }
XiaokangQianacb39922022-06-17 10:18:48 +00009734
9735 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009736 * RFC7301, section 3.1
9737 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009738 *
XiaokangQianc7403452022-06-23 03:24:12 +00009739 * struct {
9740 * ProtocolName protocol_name_list<2..2^16-1>
9741 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009742 */
9743
XiaokangQianc7403452022-06-23 03:24:12 +00009744 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009745 * protocol_name_list_len 2 bytes
9746 * protocol_name_len 1 bytes
9747 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009749 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009750
Gilles Peskine449bd832023-01-11 14:50:10 +01009751 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009752 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009753 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009754 protocol_name_list = p;
9755 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009756
9757 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009758 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009759 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009760 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9761 protocol_name_len);
9762 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009763 MBEDTLS_SSL_PEND_FATAL_ALERT(
9764 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009765 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9766 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009767 }
9768
9769 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009770 }
9771
9772 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009773 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9774 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009775 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009776 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009777 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 if (protocol_name_len == alpn_len &&
9779 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009780 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009781 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009782 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009783
9784 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009785 }
9786 }
9787
XiaokangQian95d5f542022-06-24 02:29:26 +00009788 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009789 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009790 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9791 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9792 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009793}
9794
Gilles Peskine449bd832023-01-11 14:50:10 +01009795int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9796 unsigned char *buf,
9797 unsigned char *end,
9798 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009799{
9800 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009801 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009802 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009803
Gilles Peskine449bd832023-01-11 14:50:10 +01009804 if (ssl->alpn_chosen == NULL) {
9805 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009806 }
9807
Gilles Peskine449bd832023-01-11 14:50:10 +01009808 protocol_name_len = strlen(ssl->alpn_chosen);
9809 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009810
Gilles Peskine449bd832023-01-11 14:50:10 +01009811 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009812 /*
9813 * 0 . 1 ext identifier
9814 * 2 . 3 ext length
9815 * 4 . 5 protocol list length
9816 * 6 . 6 protocol name length
9817 * 7 . 7+n protocol name
9818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009819 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009820
XiaokangQian95d5f542022-06-24 02:29:26 +00009821 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009822
Gilles Peskine449bd832023-01-11 14:50:10 +01009823 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9824 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009825 /* Note: the length of the chosen protocol has been checked to be less
9826 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009828 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009829
Gilles Peskine449bd832023-01-11 14:50:10 +01009830 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009831
9832#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009833 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009834#endif
9835
Gilles Peskine449bd832023-01-11 14:50:10 +01009836 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009837}
9838#endif /* MBEDTLS_SSL_ALPN */
9839
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009840#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009841 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009842 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009843 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009844int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9845 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009846{
9847 /* Initialize to suppress unnecessary compiler warning */
9848 size_t hostname_len = 0;
9849
9850 /* Check if new hostname is valid before
9851 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009852 if (hostname != NULL) {
9853 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009854
Gilles Peskine449bd832023-01-11 14:50:10 +01009855 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9857 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009858 }
9859
9860 /* Now it's clear that we will overwrite the old hostname,
9861 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009862 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009863 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009864 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009865 }
9866
9867 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009868 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009869 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009870 } else {
9871 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9872 if (session->hostname == NULL) {
9873 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9874 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009875
Gilles Peskine449bd832023-01-11 14:50:10 +01009876 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009877 }
9878
Gilles Peskine449bd832023-01-11 14:50:10 +01009879 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009880}
Xiaokang Qian03409292022-10-12 02:49:52 +00009881#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9882 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009883 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009884 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009885
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009886#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9887 defined(MBEDTLS_SSL_ALPN)
9888int mbedtls_ssl_session_set_alpn(mbedtls_ssl_session *session,
9889 const char *alpn)
9890{
9891 size_t alpn_len = 0;
9892
9893 if (alpn != NULL) {
9894 alpn_len = strlen(alpn);
9895
9896 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9897 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9898 }
9899 }
9900
9901 if (session->ticket_alpn != NULL) {
9902 mbedtls_zeroize_and_free(session->ticket_alpn,
9903 strlen(session->ticket_alpn));
9904 }
9905
9906 if (alpn == NULL) {
9907 session->ticket_alpn = NULL;
9908 } else {
9909 session->ticket_alpn = mbedtls_calloc(strlen(alpn) + 1, sizeof(char));
9910 if (session->ticket_alpn == NULL) {
9911 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9912 }
9913 memcpy(session->ticket_alpn, alpn, strlen(alpn) + 1);
9914 }
9915
9916 return 0;
9917}
9918#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009919#endif /* MBEDTLS_SSL_TLS_C */