blob: f78b97d4446d035c97181bec12261b374f9ae361 [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 Elmelegy2824a202024-02-23 17:51:47 +00003739 * struct {
3740 * opaque hostname<0..2^16-1>;
3741 * uint64 ticket_reception_time;
3742 * uint32 ticket_lifetime;
3743 * opaque ticket<1..2^16-1>;
3744 * } ClientOnlyData;
3745 *
3746 * struct {
3747 * uint32 ticket_age_add;
3748 * uint8 ticket_flags;
3749 * opaque resumption_key<0..255>;
3750 * uint32 max_early_data_size;
3751 * uint16 record_size_limit;
3752 * select ( endpoint ) {
3753 * case client: ClientOnlyData;
3754 * case server: uint64 ticket_creation_time;
3755 * };
3756 * } serialized_session_tls13;
3757 *
David Horstmanne59f9702024-02-29 16:08:57 +00003758 */
3759#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3760MBEDTLS_CHECK_RETURN_CRITICAL
3761static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3762 unsigned char *buf,
3763 size_t buf_len,
3764 size_t *olen)
3765{
3766 unsigned char *p = buf;
3767#if defined(MBEDTLS_SSL_CLI_C) && \
3768 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3769 size_t hostname_len = (session->hostname == NULL) ?
3770 0 : strlen(session->hostname) + 1;
3771#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003772
3773#if defined(MBEDTLS_SSL_SRV_C) && \
3774 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003775 const uint8_t alpn_len = (session->ticket_alpn == NULL) ?
3776 0 : (uint8_t) strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003777#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003778 size_t needed = 4 /* ticket_age_add */
3779 + 1 /* ticket_flags */
3780 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003781
David Horstmanne59f9702024-02-29 16:08:57 +00003782 *olen = 0;
3783
3784 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3785 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3786 }
3787 needed += session->resumption_key_len; /* resumption_key */
3788
3789#if defined(MBEDTLS_SSL_EARLY_DATA)
3790 needed += 4; /* max_early_data_size */
3791#endif
3792#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3793 needed += 2; /* record_size_limit */
3794#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3795
3796#if defined(MBEDTLS_HAVE_TIME)
3797 needed += 8; /* ticket_creation_time or ticket_reception_time */
3798#endif
3799
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003800#if defined(MBEDTLS_SSL_SRV_C)
3801 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3802#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3803 needed += 1 /* alpn_len */
3804 + alpn_len; /* alpn */
3805#endif
3806 }
3807#endif /* MBEDTLS_SSL_SRV_C */
3808
David Horstmanne59f9702024-02-29 16:08:57 +00003809#if defined(MBEDTLS_SSL_CLI_C)
3810 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3811#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3812 needed += 2 /* hostname_len */
3813 + hostname_len; /* hostname */
3814#endif
3815
3816 needed += 4 /* ticket_lifetime */
3817 + 2; /* ticket_len */
3818
3819 /* Check size_t overflow */
3820 if (session->ticket_len > SIZE_MAX - needed) {
3821 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3822 }
3823
3824 needed += session->ticket_len; /* ticket */
3825 }
3826#endif /* MBEDTLS_SSL_CLI_C */
3827
3828 *olen = needed;
3829 if (needed > buf_len) {
3830 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3831 }
3832
3833 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3834 p[4] = session->ticket_flags;
3835
3836 /* save resumption_key */
3837 p[5] = session->resumption_key_len;
3838 p += 6;
3839 memcpy(p, session->resumption_key, session->resumption_key_len);
3840 p += session->resumption_key_len;
3841
3842#if defined(MBEDTLS_SSL_EARLY_DATA)
3843 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3844 p += 4;
3845#endif
3846#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3847 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3848 p += 2;
3849#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3850
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003851#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003852 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003853#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003854 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3855 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003856#endif /* MBEDTLS_HAVE_TIME */
3857
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003858#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3859 *p++ = alpn_len;
3860 if (alpn_len > 0) {
3861 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003862 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003863 p += alpn_len;
3864 }
3865#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3866 }
3867#endif /* MBEDTLS_SSL_SRV_C */
3868
David Horstmanne59f9702024-02-29 16:08:57 +00003869#if defined(MBEDTLS_SSL_CLI_C)
3870 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3871#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3872 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3873 p += 2;
3874 if (hostname_len > 0) {
3875 /* save host name */
3876 memcpy(p, session->hostname, hostname_len);
3877 p += hostname_len;
3878 }
3879#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3880
3881#if defined(MBEDTLS_HAVE_TIME)
3882 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3883 p += 8;
3884#endif
3885 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3886 p += 4;
3887
3888 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3889 p += 2;
3890
3891 if (session->ticket != NULL && session->ticket_len > 0) {
3892 memcpy(p, session->ticket, session->ticket_len);
3893 p += session->ticket_len;
3894 }
3895 }
3896#endif /* MBEDTLS_SSL_CLI_C */
3897 return 0;
3898}
3899
3900MBEDTLS_CHECK_RETURN_CRITICAL
3901static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3902 const unsigned char *buf,
3903 size_t len)
3904{
3905 const unsigned char *p = buf;
3906 const unsigned char *end = buf + len;
3907
3908 if (end - p < 6) {
3909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3910 }
3911 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3912 session->ticket_flags = p[4];
3913
3914 /* load resumption_key */
3915 session->resumption_key_len = p[5];
3916 p += 6;
3917
3918 if (end - p < session->resumption_key_len) {
3919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3920 }
3921
3922 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3923 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3924 }
3925 memcpy(session->resumption_key, p, session->resumption_key_len);
3926 p += session->resumption_key_len;
3927
3928#if defined(MBEDTLS_SSL_EARLY_DATA)
3929 if (end - p < 4) {
3930 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3931 }
3932 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3933 p += 4;
3934#endif
3935#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3936 if (end - p < 2) {
3937 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3938 }
3939 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3940 p += 2;
3941#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3942
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003943#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003944 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003945#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003946 if (end - p < 8) {
3947 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3948 }
3949 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3950 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003951#endif /* MBEDTLS_HAVE_TIME */
3952
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3954 uint8_t alpn_len;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003955 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003956
3957 if (end - p < 1) {
3958 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3959 }
3960 alpn_len = *p++;
3961
3962 if (end - p < alpn_len) {
3963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3964 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003965
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003966 if (alpn_len > 0) {
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003967 ret = mbedtls_ssl_session_set_alpn(session, (const char *) p);
3968 if (ret != 0) {
3969 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003970 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003971 p += alpn_len;
3972 }
3973#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3974 }
3975#endif /* MBEDTLS_SSL_SRV_C */
3976
David Horstmanne59f9702024-02-29 16:08:57 +00003977#if defined(MBEDTLS_SSL_CLI_C)
3978 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3979#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3980 size_t hostname_len;
3981 /* load host name */
3982 if (end - p < 2) {
3983 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3984 }
3985 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3986 p += 2;
3987
3988 if (end - p < (long int) hostname_len) {
3989 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3990 }
3991 if (hostname_len > 0) {
3992 session->hostname = mbedtls_calloc(1, hostname_len);
3993 if (session->hostname == NULL) {
3994 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3995 }
3996 memcpy(session->hostname, p, hostname_len);
3997 p += hostname_len;
3998 }
3999#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4000
4001#if defined(MBEDTLS_HAVE_TIME)
4002 if (end - p < 8) {
4003 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4004 }
4005 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4006 p += 8;
4007#endif
4008 if (end - p < 4) {
4009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4010 }
4011 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4012 p += 4;
4013
4014 if (end - p < 2) {
4015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4016 }
4017 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4018 p += 2;
4019
4020 if (end - p < (long int) session->ticket_len) {
4021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4022 }
4023 if (session->ticket_len > 0) {
4024 session->ticket = mbedtls_calloc(1, session->ticket_len);
4025 if (session->ticket == NULL) {
4026 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4027 }
4028 memcpy(session->ticket, p, session->ticket_len);
4029 p += session->ticket_len;
4030 }
4031 }
4032#endif /* MBEDTLS_SSL_CLI_C */
4033
4034 return 0;
4035
4036}
4037#else /* MBEDTLS_SSL_SESSION_TICKETS */
4038MBEDTLS_CHECK_RETURN_CRITICAL
4039static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4040 unsigned char *buf,
4041 size_t buf_len,
4042 size_t *olen)
4043{
4044 ((void) session);
4045 ((void) buf);
4046 ((void) buf_len);
4047 *olen = 0;
4048 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4049}
4050
4051static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4052 unsigned char *buf,
4053 size_t buf_len)
4054{
4055 ((void) session);
4056 ((void) buf);
4057 ((void) buf_len);
4058 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4059}
4060#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4061#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4062
Paul Bakker5121ce52009-01-03 21:22:43 +00004063/*
Hanno Beckera835da52019-05-16 12:39:07 +01004064 * Define ticket header determining Mbed TLS version
4065 * and structure of the ticket.
4066 */
4067
Hanno Becker94ef3b32019-05-16 12:50:45 +01004068/*
Hanno Becker50b59662019-05-28 14:30:45 +01004069 * Define bitflag determining compile-time settings influencing
4070 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004071 */
4072
Hanno Becker50b59662019-05-28 14:30:45 +01004073#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004074#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004075#else
Hanno Becker3e088662019-05-29 11:10:18 +01004076#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004077#endif /* MBEDTLS_HAVE_TIME */
4078
4079#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004080#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081#else
Hanno Becker3e088662019-05-29 11:10:18 +01004082#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004083#endif /* MBEDTLS_X509_CRT_PARSE_C */
4084
David Horstmann5c5a32f2024-02-13 17:53:35 +00004085#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004086#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004087#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004088#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004089#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4090
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004092#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#else
Hanno Becker3e088662019-05-29 11:10:18 +01004094#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004095#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4096
4097#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004098#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004099#else
Hanno Becker3e088662019-05-29 11:10:18 +01004100#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004101#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4102
Hanno Becker94ef3b32019-05-16 12:50:45 +01004103#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004104#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004105#else
Hanno Becker3e088662019-05-29 11:10:18 +01004106#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004107#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4108
Hanno Becker94ef3b32019-05-16 12:50:45 +01004109#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4110#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4111#else
4112#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4113#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4114
David Horstmann92b258b2024-02-13 17:23:34 +00004115#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4116#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4117#else
4118#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4119#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4120
4121#if defined(MBEDTLS_SSL_EARLY_DATA)
4122#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4123#else
4124#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4125#endif /* MBEDTLS_SSL_EARLY_DATA */
4126
4127#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4128#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4129#else
4130#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4131#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4132
Hanno Becker3e088662019-05-29 11:10:18 +01004133#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4134#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4135#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4136#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004137#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4138#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004139#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004140#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4141#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4142#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Hanno Becker3e088662019-05-29 11:10:18 +01004143
Hanno Becker50b59662019-05-28 14:30:45 +01004144#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 ((uint16_t) ( \
4146 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4147 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4148 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4149 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4150 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4151 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004152 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004153 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4154 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004155 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4156 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4157 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4158 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
4159 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004160
Chien Wong4e9683e2023-12-28 17:07:43 +08004161static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004162 MBEDTLS_VERSION_MAJOR,
4163 MBEDTLS_VERSION_MINOR,
4164 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4166 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004167};
Hanno Beckera835da52019-05-16 12:39:07 +01004168
4169/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004170 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004171 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004172 *
David Horstmanncb01b362024-02-29 17:31:46 +00004173 * TLS 1.2 session:
4174 *
4175 * struct {
4176 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4177 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4178 * uint32 ticket_lifetime;
4179 * #endif
4180 * } ClientOnlyData;
4181 *
4182 * struct {
4183 * #if defined(MBEDTLS_HAVE_TIME)
4184 * uint64 start_time;
4185 * #endif
4186 * uint8 session_id_len; // at most 32
4187 * opaque session_id[32];
4188 * opaque master[48]; // fixed length in the standard
4189 * uint32 verify_result;
4190 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4191 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4192 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004193 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004194 * opaque peer_cert_digest<0..2^8-1>
4195 * #endif
4196 * select (endpoint) {
4197 * case client: ClientOnlyData;
4198 * case server: uint64 ticket_creation_time;
4199 * };
4200 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4201 * uint8 mfl_code; // up to 255 according to standard
4202 * #endif
4203 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4204 * uint8 encrypt_then_mac; // 0 or 1
4205 * #endif
4206 * } serialized_session_tls12;
4207 *
4208 *
4209 * TLS 1.3 Session:
4210 *
4211 * struct {
4212 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4213 * opaque hostname<0..2^16-1>;
4214 * #endif
4215 * #if defined(MBEDTLS_HAVE_TIME)
4216 * uint64 ticket_reception_time;
4217 * #endif
4218 * uint32 ticket_lifetime;
4219 * opaque ticket<1..2^16-1>;
4220 * } ClientOnlyData;
4221 *
4222 * struct {
4223 * uint32 ticket_age_add;
4224 * uint8 ticket_flags;
4225 * opaque resumption_key<0..255>;
4226 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4227 * uint32 max_early_data_size;
4228 * #endif
4229 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4230 * uint16 record_size_limit;
4231 * #endif
4232 * select ( endpoint ) {
4233 * case client: ClientOnlyData;
4234 * #if defined(MBEDTLS_HAVE_TIME)
4235 * case server: uint64 ticket_creation_time;
4236 * #endif
4237 * };
4238 * } serialized_session_tls13;
4239 *
4240 *
4241 * SSL session:
4242 *
4243 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004244 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004245 * opaque mbedtls_version[3]; // library version: major, minor, patch
4246 * opaque session_format[2]; // library-version specific 16-bit field
4247 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004248 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004249 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004250 * Note: When updating the format, remember to keep
4251 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004252 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004253 * // In this version, `session_format` determines
4254 * // the setting of those compile-time
4255 * // configuration options which influence
4256 * // the structure of mbedtls_ssl_session.
4257 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004258 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004259 * // - TLS 1.2 (0x0303)
4260 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004261 * uint8_t endpoint;
4262 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004264 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004266 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004267 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004268 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004269 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004270 *
4271 * };
4272 *
4273 * } serialized_session;
4274 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004275 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004278static int ssl_session_save(const mbedtls_ssl_session *session,
4279 unsigned char omit_header,
4280 unsigned char *buf,
4281 size_t buf_len,
4282 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004283{
4284 unsigned char *p = buf;
4285 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004286 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004287#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4288 size_t out_len;
4289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4290#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (session == NULL) {
4292 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4293 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004296 /*
4297 * Add Mbed TLS version identifier
4298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (used <= buf_len) {
4302 memcpy(p, ssl_serialized_session_header,
4303 sizeof(ssl_serialized_session_header));
4304 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004305 }
4306 }
4307
4308 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004309 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004310 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004311 used += 1 /* TLS version */
4312 + 1 /* endpoint */
4313 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (used <= buf_len) {
4315 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004316 *p++ = session->endpoint;
4317 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4318 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004319 }
4320
4321 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004322 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 case MBEDTLS_SSL_VERSION_TLS1_2:
4326 used += ssl_tls12_session_save(session, p, remaining_len);
4327 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004328#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4329
Jerry Yu251a12e2022-07-13 15:15:48 +08004330#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 case MBEDTLS_SSL_VERSION_TLS1_3:
4332 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4333 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4334 return ret;
4335 }
4336 used += out_len;
4337 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004338#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 default:
4341 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004342 }
4343
4344 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (used > buf_len) {
4346 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4347 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004350}
4351
4352/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004353 * Public wrapper for ssl_session_save()
4354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004355int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4356 unsigned char *buf,
4357 size_t buf_len,
4358 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004359{
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004361}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004362
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004363/*
4364 * Deserialize session, see mbedtls_ssl_session_save() for format.
4365 *
4366 * This internal version is wrapped by a public function that cleans up in
4367 * case of error, and has an extra option omit_header.
4368 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004369MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004370static int ssl_session_load(mbedtls_ssl_session *session,
4371 unsigned char omit_header,
4372 const unsigned char *buf,
4373 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004374{
4375 const unsigned char *p = buf;
4376 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004377 size_t remaining_len;
4378
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (session == NULL) {
4381 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4382 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004385 /*
4386 * Check Mbed TLS version identifier
4387 */
4388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004392
4393 if (memcmp(p, ssl_serialized_session_header,
4394 sizeof(ssl_serialized_session_header)) != 0) {
4395 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4396 }
4397 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004398 }
4399
4400 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004401 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004402 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004403 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4405 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004406 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004407 session->endpoint = *p++;
4408 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4409 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004410
4411 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004412 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004414#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 case MBEDTLS_SSL_VERSION_TLS1_2:
4416 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4418
Jerry Yu438ddd82022-07-07 06:55:50 +00004419#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 case MBEDTLS_SSL_VERSION_TLS1_3:
4421 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004422#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 default:
4425 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004426 }
4427}
4428
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004429/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004430 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004432int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4433 const unsigned char *buf,
4434 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004435{
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (ret != 0) {
4439 mbedtls_ssl_session_free(session);
4440 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004443}
4444
4445/*
Paul Bakker1961b702013-01-25 14:49:24 +01004446 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004447 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004449static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004450{
4451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4452
Ronald Cron66dbf912022-02-02 15:33:46 +01004453 /*
4454 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004455 * that were written into the output buffer by the previous handshake step,
4456 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004457 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4458 * We proceed to the next handshake step only when all data from the
4459 * previous one have been sent to the peer, thus we make sure that this is
4460 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4461 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4462 * we have to wait before to go ahead.
4463 * In the case of TLS 1.3, handshake step handlers do not send data to the
4464 * peer. Data are only sent here and through
4465 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004466 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4469 return ret;
4470 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004471
4472#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4474 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4475 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4476 return ret;
4477 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004478 }
4479#endif /* MBEDTLS_SSL_PROTO_DTLS */
4480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004482}
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004485{
Hanno Becker41934dd2021-08-07 19:13:43 +01004486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004489 ssl->conf == NULL ||
4490 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4492 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004493 }
4494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 ret = ssl_prepare_handshake_step(ssl);
4496 if (ret != 0) {
4497 return ret;
4498 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 ret = mbedtls_ssl_handle_pending_alert(ssl);
4501 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004502 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 }
Jerry Yue7047812021-09-13 19:26:39 +08004504
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004505 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4506 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4507 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4511 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004512 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004515 case MBEDTLS_SSL_HELLO_REQUEST:
4516 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004517 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004518 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004519
Ronald Cron9f0fba32022-02-10 16:45:15 +01004520 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004522 break;
4523
4524 default:
4525#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4527 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4528 } else {
4529 ret = mbedtls_ssl_handshake_client_step(ssl);
4530 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004535#endif
4536 }
Jerry Yub9930e72021-08-06 17:11:51 +08004537 }
Ronald Cron6291b232023-03-08 15:51:25 +01004538#endif /* MBEDTLS_SSL_CLI_C */
4539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004542#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4543 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004545 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 ret = mbedtls_ssl_handshake_server_step(ssl);
4547 }
Ronald Cron6291b232023-03-08 15:51:25 +01004548#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4549 ret = mbedtls_ssl_handshake_server_step(ssl);
4550#else
4551 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004552#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004553 }
4554#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004557 /* handshake_step return error. And it is same
4558 * with alert_reason.
4559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (ssl->send_alert) {
4561 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004562 goto cleanup;
4563 }
4564 }
4565
4566cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004568}
4569
4570/*
4571 * Perform the SSL handshake
4572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004574{
4575 int ret = 0;
4576
Hanno Beckera817ea42020-10-20 15:20:23 +01004577 /* Sanity checks */
4578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl == NULL || ssl->conf == NULL) {
4580 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4581 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004582
Hanno Beckera817ea42020-10-20 15:20:23 +01004583#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4585 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4586 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4587 "mbedtls_ssl_set_timer_cb() for DTLS"));
4588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004589 }
4590#endif /* MBEDTLS_SSL_PROTO_DTLS */
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004593
Hanno Beckera817ea42020-10-20 15:20:23 +01004594 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4596 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004599 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 }
Paul Bakker1961b702013-01-25 14:49:24 +01004601 }
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004606}
4607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004608#if defined(MBEDTLS_SSL_RENEGOTIATION)
4609#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004610/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004611 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004612 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004614static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004615{
Janos Follath865b3eb2019-12-16 11:46:15 +00004616 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004619
4620 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4622 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4625 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4626 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004627 }
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004632}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004634
4635/*
4636 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 * - any side: calling mbedtls_ssl_renegotiate(),
4638 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4639 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004640 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004641 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004644int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004645{
Janos Follath865b3eb2019-12-16 11:46:15 +00004646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if ((ret = ssl_handshake_init(ssl)) != 0) {
4651 return ret;
4652 }
Paul Bakker48916f92012-09-16 19:57:18 +00004653
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004654 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4655 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4658 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4659 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004660 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004662 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004664 }
4665#endif
4666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4668 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4671 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4672 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004673 }
4674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004678}
4679
4680/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004681 * Renegotiate current connection on client,
4682 * or request renegotiation on server
4683 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004684int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004685{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (ssl == NULL || ssl->conf == NULL) {
4689 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4690 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004692#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004693 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4695 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4697 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004700
4701 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (ssl->out_left != 0) {
4703 return mbedtls_ssl_flush_output(ssl);
4704 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004707 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004711 /*
4712 * On client, either start the renegotiation process or,
4713 * if already in progress, continue the handshake
4714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4716 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004718 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004719
4720 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4721 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4722 return ret;
4723 }
4724 } else {
4725 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4726 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4727 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004728 }
4729 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004733}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004737{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004738 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004741 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004743
Valerio Setti6f0441d2023-07-03 12:11:36 +02004744#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004745#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->handshake->group_list_heap_allocated) {
4747 mbedtls_free((void *) handshake->group_list);
4748 }
Brett Warrene0edc842021-08-17 09:53:13 +01004749 handshake->group_list = NULL;
4750#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004751#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004752
Ronald Crone68ab4f2022-10-05 12:46:29 +02004753#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004754#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (ssl->handshake->sig_algs_heap_allocated) {
4756 mbedtls_free((void *) handshake->sig_algs);
4757 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004758 handshake->sig_algs = NULL;
4759#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ssl->handshake->certificate_request_context) {
4762 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004763 }
4764#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004765#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004766
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004767#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4769 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004770 handshake->async_in_progress = 0;
4771 }
4772#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4773
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004774#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004775#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004777#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004778 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004779#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004780#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004781#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004782#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004784#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004785 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004786#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004787#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004788
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004791#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004792#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004793 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004795#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004796
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004797#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004800 /*
4801 * Opaque keys are not stored in the handshake's data and it's the user
4802 * responsibility to destroy them. Clear ones, instead, are created by
4803 * the TLS library and should be destroyed at the same level
4804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4806 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004807 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004808 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4809#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004811#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004812#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004814 handshake->ecjpake_cache = NULL;
4815 handshake->ecjpake_cache_len = 0;
4816#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004817#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004818
Valerio Setti7aeec542023-07-05 18:57:21 +02004819#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004820 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004821 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004822 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004824#endif
4825
Ronald Cron73fe8df2022-10-05 14:31:43 +02004826#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004827#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004829 /* The maintenance of the external PSK key slot is the
4830 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (ssl->handshake->psk_opaque_is_internal) {
4832 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004833 ssl->handshake->psk_opaque_is_internal = 0;
4834 }
4835 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4836 }
Neil Armstronge952a302022-05-03 10:22:14 +02004837#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004839 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004840 }
Neil Armstronge952a302022-05-03 10:22:14 +02004841#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004842#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4845 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004846 /*
4847 * Free only the linked list wrapper, not the keys themselves
4848 * since the belong to the SNI callback
4849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004851#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004852
Gilles Peskineeccd8882020-03-10 12:19:08 +01004853#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4855 if (handshake->ecrs_peer_cert != NULL) {
4856 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4857 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004858 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004859#endif
4860
Hanno Becker75173122019-02-06 16:18:31 +00004861#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4862 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004864#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4865
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004866#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4868 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004869#endif /* MBEDTLS_SSL_CLI_C &&
4870 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004871
4872#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_ssl_flight_free(handshake->flight);
4874 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004875#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004876
Valerio Settiea59c432023-07-25 11:14:03 +02004877#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004878 if (handshake->xxdh_psa_privkey_is_external == 0) {
4879 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 }
Valerio Settiea59c432023-07-25 11:14:03 +02004881#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004882
Ronald Cron6f135e12021-12-08 16:57:54 +01004883#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 mbedtls_ssl_transform_free(handshake->transform_handshake);
4885 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004886#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4888 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004889#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004890#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004891
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004892
4893#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4894 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4895 * processes datagrams and the fact that a datagram is allowed to have
4896 * several records in it, it is possible that the I/O buffers are not
4897 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4899 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004900#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004901
Jerry Yuba9c7272021-10-30 11:54:10 +08004902 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 mbedtls_platform_zeroize(handshake,
4904 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004905}
4906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004908{
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004910 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004915#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004916
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004917#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004918#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4919 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004921#endif
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004922 mbedtls_free(session->ticket);
4923#endif
4924
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004925#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4926 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004927 mbedtls_free(session->ticket_alpn);
Paul Bakkera503a632013-08-14 13:48:06 +02004928#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004931}
4932
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004933#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004934
4935#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4936#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4937#else
4938#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4939#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4940
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004941#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004942
4943#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4944#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4945#else
4946#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4947#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4948
4949#if defined(MBEDTLS_SSL_ALPN)
4950#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4951#else
4952#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4953#endif /* MBEDTLS_SSL_ALPN */
4954
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4956#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4959
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 ((uint32_t) ( \
4962 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4963 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4964 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4965 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4966 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4967 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4968 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4969 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004970
Chien Wong4e9683e2023-12-28 17:07:43 +08004971static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004972 MBEDTLS_VERSION_MAJOR,
4973 MBEDTLS_VERSION_MINOR,
4974 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4976 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4977 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4978 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4979 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004980};
4981
Paul Bakker5121ce52009-01-03 21:22:43 +00004982/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004983 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004984 *
4985 * The format of the serialized data is:
4986 * (in the presentation language of TLS, RFC 8446 section 3)
4987 *
4988 * // header
4989 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004990 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004991 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004992 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004993 * Note: When updating the format, remember to keep these
4994 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004995 *
4996 * // session sub-structure
4997 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4998 * // transform sub-structure
4999 * uint8 random[64]; // ServerHello.random+ClientHello.random
5000 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5001 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5002 * // fields from ssl_context
5003 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5004 * uint64 in_window_top; // DTLS: last validated record seq_num
5005 * uint64 in_window; // DTLS: bitmask for replay protection
5006 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5007 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5008 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5009 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5010 *
5011 * Note that many fields of the ssl_context or sub-structures are not
5012 * serialized, as they fall in one of the following categories:
5013 *
5014 * 1. forced value (eg in_left must be 0)
5015 * 2. pointer to dynamically-allocated memory (eg session, transform)
5016 * 3. value can be re-derived from other data (eg session keys from MS)
5017 * 4. value was temporary (eg content of input buffer)
5018 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005020int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5021 unsigned char *buf,
5022 size_t buf_len,
5023 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005024{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005025 unsigned char *p = buf;
5026 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005027 size_t session_len;
5028 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005029
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005030 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005031 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5032 * this function's documentation.
5033 *
5034 * These are due to assumptions/limitations in the implementation. Some of
5035 * them are likely to stay (no handshake in progress) some might go away
5036 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005037 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005038 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5040 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005042 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 if (ssl->handshake != NULL) {
5044 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005046 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005047 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (ssl->transform == NULL || ssl->session == NULL) {
5049 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005051 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005052 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (mbedtls_ssl_check_pending(ssl) != 0) {
5054 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if (ssl->out_left != 0) {
5058 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005060 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005061 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5063 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005065 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005066 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005070 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005071 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5073 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites 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 /* Renegotiation must not be enabled */
5077#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5079 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5080 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005081 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005082#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005083
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005084 /*
5085 * Version and format identifier
5086 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (used <= buf_len) {
5090 memcpy(p, ssl_serialized_context_header,
5091 sizeof(ssl_serialized_context_header));
5092 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005093 }
5094
5095 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005096 * Session (length + data)
5097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5099 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5100 return ret;
5101 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005102
5103 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (used <= buf_len) {
5105 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005106 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 ret = ssl_session_save(ssl->session, 1,
5109 p, session_len, &session_len);
5110 if (ret != 0) {
5111 return ret;
5112 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005113
5114 p += session_len;
5115 }
5116
5117 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005118 * Transform
5119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 used += sizeof(ssl->transform->randbytes);
5121 if (used <= buf_len) {
5122 memcpy(p, ssl->transform->randbytes,
5123 sizeof(ssl->transform->randbytes));
5124 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005125 }
5126
5127#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005128 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005130 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005132 p += ssl->transform->in_cid_len;
5133
5134 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005136 p += ssl->transform->out_cid_len;
5137 }
5138#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5139
5140 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005141 * Saved fields from top-level ssl_context structure
5142 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005143 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (used <= buf_len) {
5145 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005146 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005147 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005148
5149#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5150 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (used <= buf_len) {
5152 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005153 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005156 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005157 }
5158#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5159
5160#if defined(MBEDTLS_SSL_PROTO_DTLS)
5161 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005163 *p++ = ssl->disable_datagram_packing;
5164 }
5165#endif /* MBEDTLS_SSL_PROTO_DTLS */
5166
Jerry Yuae0b2e22021-10-08 15:21:19 +08005167 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (used <= buf_len) {
5169 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005170 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005171 }
5172
5173#if defined(MBEDTLS_SSL_PROTO_DTLS)
5174 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
5176 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005177 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178 }
5179#endif /* MBEDTLS_SSL_PROTO_DTLS */
5180
5181#if defined(MBEDTLS_SSL_ALPN)
5182 {
5183 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005185 : 0;
5186
5187 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005189 *p++ = alpn_len;
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (ssl->alpn_chosen != NULL) {
5192 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005193 p += alpn_len;
5194 }
5195 }
5196 }
5197#endif /* MBEDTLS_SSL_ALPN */
5198
5199 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005200 * Done
5201 */
5202 *olen = used;
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (used > buf_len) {
5205 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5206 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005209
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005211}
5212
5213/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005214 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005215 *
5216 * This internal version is wrapped by a public function that cleans up in
5217 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005218 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005220static int ssl_context_load(mbedtls_ssl_context *ssl,
5221 const unsigned char *buf,
5222 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005223{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005224 const unsigned char *p = buf;
5225 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005226 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005228#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005229 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005230#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005231
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005232 /*
5233 * The context should have been freshly setup or reset.
5234 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005235 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005236 * renegotiating, or if the user mistakenly loaded a session first.)
5237 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5239 ssl->session != NULL) {
5240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005241 }
5242
5243 /*
5244 * We can't check that the config matches the initial one, but we can at
5245 * least check it matches the requirements for serializing.
5246 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005247 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005248#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005249 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005250#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005251 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5252 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5253 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5254 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005256 }
5257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005259
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005260 /*
5261 * Check version identifier
5262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005265 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005266
5267 if (memcmp(p, ssl_serialized_context_header,
5268 sizeof(ssl_serialized_context_header)) != 0) {
5269 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5270 }
5271 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005272
5273 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005274 * Session
5275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 if ((size_t) (end - p) < 4) {
5277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5278 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005279
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005280 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005281 p += 4;
5282
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005283 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005284 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005285 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005286 ssl->session_in = ssl->session;
5287 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005288 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 if ((size_t) (end - p) < session_len) {
5291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5292 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 ret = ssl_session_load(ssl->session, 1, p, session_len);
5295 if (ret != 0) {
5296 mbedtls_ssl_session_free(ssl->session);
5297 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005298 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005299
5300 p += session_len;
5301
5302 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005303 * Transform
5304 */
5305
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005306 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005307 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005308#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005310 ssl->transform_in = ssl->transform;
5311 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005312 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005313#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005314
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005315#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5317 if (prf_func == NULL) {
5318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5319 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005320
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005321 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5324 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005325
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 ret = ssl_tls12_populate_transform(ssl->transform,
5327 ssl->session->ciphersuite,
5328 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005329#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005331#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 prf_func,
5333 p, /* currently pointing to randbytes */
5334 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5335 ssl->conf->endpoint,
5336 ssl);
5337 if (ret != 0) {
5338 return ret;
5339 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005340#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005342
5343#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5344 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if ((size_t) (end - p) < 1) {
5346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5347 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005348
5349 ssl->transform->in_cid_len = *p++;
5350
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5352 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5353 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005356 p += ssl->transform->in_cid_len;
5357
5358 ssl->transform->out_cid_len = *p++;
5359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5361 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5362 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005363
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365 p += ssl->transform->out_cid_len;
5366#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5367
5368 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005369 * Saved fields from top-level ssl_context structure
5370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if ((size_t) (end - p) < 4) {
5372 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5373 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005374
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005375 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005376 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005377
5378#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 if ((size_t) (end - p) < 16) {
5380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5381 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005382
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005383 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005384 p += 8;
5385
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005386 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387 p += 8;
5388#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5389
5390#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if ((size_t) (end - p) < 1) {
5392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5393 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005394
5395 ssl->disable_datagram_packing = *p++;
5396#endif /* MBEDTLS_SSL_PROTO_DTLS */
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5400 }
5401 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5402 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005403
5404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if ((size_t) (end - p) < 2) {
5406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5407 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005409 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005410 p += 2;
5411#endif /* MBEDTLS_SSL_PROTO_DTLS */
5412
5413#if defined(MBEDTLS_SSL_ALPN)
5414 {
5415 uint8_t alpn_len;
5416 const char **cur;
5417
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 if ((size_t) (end - p) < 1) {
5419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5420 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005421
5422 alpn_len = *p++;
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005425 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5427 if (strlen(*cur) == alpn_len &&
5428 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005429 ssl->alpn_chosen = *cur;
5430 break;
5431 }
5432 }
5433 }
5434
5435 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5438 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005439
5440 p += alpn_len;
5441 }
5442#endif /* MBEDTLS_SSL_ALPN */
5443
5444 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005445 * Forced fields from top-level ssl_context structure
5446 *
5447 * Most of them already set to the correct value by mbedtls_ssl_init() and
5448 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5449 */
5450 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005451 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005452
Hanno Becker361b10d2019-08-30 10:42:49 +01005453 /* Adjust pointers for header fields of outgoing records to
5454 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005456
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005457#if defined(MBEDTLS_SSL_PROTO_DTLS)
5458 ssl->in_epoch = 1;
5459#endif
5460
5461 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5462 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005463 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5464 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 if (ssl->handshake != NULL) {
5466 mbedtls_ssl_handshake_free(ssl);
5467 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005468 ssl->handshake = NULL;
5469 }
5470
5471 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005472 * Done - should have consumed entire buffer
5473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 if (p != end) {
5475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5476 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005479}
5480
5481/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005482 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5485 const unsigned char *buf,
5486 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005487{
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if (ret != 0) {
5491 mbedtls_ssl_free(context);
5492 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005493
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005495}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005496#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005497
5498/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005499 * Free an SSL context
5500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005501void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005502{
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005504 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005510#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5511 size_t out_buf_len = ssl->out_buf_len;
5512#else
5513 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5514#endif
5515
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005516 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005517 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005518 }
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005521#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5522 size_t in_buf_len = ssl->in_buf_len;
5523#else
5524 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5525#endif
5526
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005527 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005528 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005529 }
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl->transform) {
5532 mbedtls_ssl_transform_free(ssl->transform);
5533 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005534 }
5535
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (ssl->handshake) {
5537 mbedtls_ssl_handshake_free(ssl);
5538 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005539
5540#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5542 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005543#endif
5544
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 mbedtls_ssl_session_free(ssl->session_negotiate);
5546 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005547 }
5548
Ronald Cron6f135e12021-12-08 16:57:54 +01005549#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 mbedtls_ssl_transform_free(ssl->transform_application);
5551 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005552#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (ssl->session) {
5555 mbedtls_ssl_session_free(ssl->session);
5556 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005557 }
5558
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005559#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005561 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005562 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005563#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005564
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005565#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005567#endif
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005570
Paul Bakker86f04f42013-02-14 11:20:09 +01005571 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005573}
5574
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005575/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005576 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005578void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005579{
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005581}
5582
Gilles Peskineae270bf2021-06-02 00:05:29 +02005583/* The selection should be the same as mbedtls_x509_crt_profile_default in
5584 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005585 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005586 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005587 * about this list.
5588 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005589static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005590#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005591 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005592#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005593#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005594 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005595#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005596#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005597 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005598#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005599#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005600 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005601#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005602#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005603 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005604#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005605#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005606 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005607#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005608#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005609 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005610#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005611#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005612 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005613#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005614#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005615 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5616 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5617 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5618 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5619 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5620#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005621 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005622};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005623
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005624static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005625 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5626 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5627 0
5628};
5629
Ronald Crone68ab4f2022-10-05 12:46:29 +02005630#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005631
Jerry Yu909df7b2022-01-22 11:56:27 +08005632/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005633 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005634 * rules SHOULD be upheld.
5635 * - No duplicate entries.
5636 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005637 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005638 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005639 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005640static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005641
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005642#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005643 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005644 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005645 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005646 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5647#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005648
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005649#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005650 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005651 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005652 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005653 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5654#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005655
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005656#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005657 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005658 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005659 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005660 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5661#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005662
Yanray Wang1136fad2023-11-22 16:54:31 +08005663#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005664 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005665#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005666
Yanray Wang1136fad2023-11-22 16:54:31 +08005667#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005668 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005669#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005670
Yanray Wang1136fad2023-11-22 16:54:31 +08005671#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005672 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005673#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005674
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005675#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005676 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005677#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005678
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005679#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005680 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005681#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005682
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005683#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005684 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005685#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005686
Gabor Mezei15b95a62022-05-09 16:37:58 +02005687 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005688};
5689
5690/* NOTICE: see above */
5691#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5692static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005693
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005694#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005695#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005697#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005698#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5699 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005700#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005701#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005703#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005704#endif /* MBEDTLS_MD_CAN_SHA512 */
5705
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005706#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005707#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005709#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005710#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5711 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005712#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005713#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005715#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005716#endif /* MBEDTLS_MD_CAN_SHA384 */
5717
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005718#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005719#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005721#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005722#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5723 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005724#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005727#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005728#endif /* MBEDTLS_MD_CAN_SHA256 */
5729
Gabor Mezei15b95a62022-05-09 16:37:58 +02005730 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005731};
5732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005733
Jerry Yu909df7b2022-01-22 11:56:27 +08005734/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005735static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005736
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005737#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005738 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005739 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005740 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005741 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5742#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005743
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005744#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005745 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005746 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005747 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005748 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5749#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005750
Gabor Mezei15b95a62022-05-09 16:37:58 +02005751 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005752};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005753
Jerry Yu909df7b2022-01-22 11:56:27 +08005754/* NOTICE: see above */
5755#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5756static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005757
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005758#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005759#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005761#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005762#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005763
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005764#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005765#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005767#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005768#endif /* MBEDTLS_MD_CAN_SHA384 */
5769
Gabor Mezei15b95a62022-05-09 16:37:58 +02005770 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005771};
Jerry Yu909df7b2022-01-22 11:56:27 +08005772#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5773
Ronald Crone68ab4f2022-10-05 12:46:29 +02005774#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005775
Chien Wong4e9683e2023-12-28 17:07:43 +08005776static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005777#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005778 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005779#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005780#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005781 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005782#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005783 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005784};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005785
Ronald Crone68ab4f2022-10-05 12:46:29 +02005786#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005787/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005788 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005789MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005790static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005791{
5792 size_t i, j;
5793 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5796 for (j = 0; j < i; j++) {
5797 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005798 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 }
5800 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5801 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5802 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005803 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005804 }
5805 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005807}
5808
Ronald Crone68ab4f2022-10-05 12:46:29 +02005809#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005810
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005811/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005812 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5815 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005816{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005817#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005818 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005819#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005820
Ronald Crone68ab4f2022-10-05 12:46:29 +02005821#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5823 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5824 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005825 }
5826
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5828 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5829 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005830 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005831
5832#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5834 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5835 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005836 }
5837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5839 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5840 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005841 }
5842#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005843#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005844
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005845 /* Use the functions here so that they are covered in tests,
5846 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 mbedtls_ssl_conf_endpoint(conf, endpoint);
5848 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005849
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005850 /*
5851 * Things that are common to all presets
5852 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005853#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005855 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5856#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5857 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5858#endif
5859 }
5860#endif
5861
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005862#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5863 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5864#endif
5865
5866#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5867 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5868#endif
5869
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005870#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005871 conf->f_cookie_write = ssl_cookie_write_dummy;
5872 conf->f_cookie_check = ssl_cookie_check_dummy;
5873#endif
5874
5875#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5876 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5877#endif
5878
Janos Follath088ce432017-04-10 12:42:31 +01005879#if defined(MBEDTLS_SSL_SRV_C)
5880 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005881 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005882#endif
5883
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005884#if defined(MBEDTLS_SSL_PROTO_DTLS)
5885 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5886 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5887#endif
5888
5889#if defined(MBEDTLS_SSL_RENEGOTIATION)
5890 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 memset(conf->renego_period, 0x00, 2);
5892 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005893#endif
5894
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005895#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005897 const unsigned char dhm_p[] =
5898 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5899 const unsigned char dhm_g[] =
5900 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5903 dhm_p, sizeof(dhm_p),
5904 dhm_g, sizeof(dhm_g))) != 0) {
5905 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005906 }
5907 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005908#endif
5909
Ronald Cron6f135e12021-12-08 16:57:54 +01005910#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005911
5912#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005913 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005914#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005915 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005916#endif
5917#endif /* MBEDTLS_SSL_EARLY_DATA */
5918
Jerry Yud0766ec2022-09-22 10:46:57 +08005919#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005920 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005922#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005923 /*
5924 * Allow all TLS 1.3 key exchange modes by default.
5925 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005926 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005927#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005930#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005931 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005932 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005933#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005935#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005937#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005938 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5939 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005940#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5941 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5942 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5943#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5944 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5945 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5946#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005948#endif
5949 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005950
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005951 /*
5952 * Preset-specific defaults
5953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005955 /*
5956 * NSA Suite B
5957 */
5958 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005959
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005960 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005961
5962#if defined(MBEDTLS_X509_CRT_PARSE_C)
5963 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005964#endif
5965
Ronald Crone68ab4f2022-10-05 12:46:29 +02005966#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005967#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005969 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005971#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005973#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005974
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005975#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005976 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005977#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005978 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005979 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005980
5981 /*
5982 * Default
5983 */
5984 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005985
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005986 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005987
5988#if defined(MBEDTLS_X509_CRT_PARSE_C)
5989 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5990#endif
5991
Ronald Crone68ab4f2022-10-05 12:46:29 +02005992#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005993#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005995 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005997#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005999#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006001#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006002 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006003#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006004 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006005
6006#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6007 conf->dhm_min_bitlen = 1024;
6008#endif
6009 }
6010
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006012}
6013
6014/*
6015 * Free mbedtls_ssl_config
6016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006017void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006018{
6019#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 mbedtls_mpi_free(&conf->dhm_P);
6021 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006022#endif
6023
Ronald Cron73fe8df2022-10-05 14:31:43 +02006024#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006025#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006027 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6028 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006029#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006031 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006032 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006033 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006034 }
6035
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006037 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006038 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006039 conf->psk_identity_len = 0;
6040 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006041#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006042
6043#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006045#endif
6046
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006048}
6049
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006050#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006051 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006052/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006053 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006055unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006056{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006057#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6059 return MBEDTLS_SSL_SIG_RSA;
6060 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006061#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006062#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6064 return MBEDTLS_SSL_SIG_ECDSA;
6065 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006066#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006068}
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006071{
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006073 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006075 case MBEDTLS_PK_ECDSA:
6076 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006078 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006080 }
6081}
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006084{
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006086#if defined(MBEDTLS_RSA_C)
6087 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006089#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006091 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006093#endif
6094 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006096 }
6097}
Valerio Settie9646ec2023-08-02 20:02:28 +02006098#endif /* MBEDTLS_PK_C &&
6099 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006100
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006101/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006102 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006103 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006104mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006105{
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006107#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006108 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006110#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006111#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006112 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006114#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006115#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006116 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006118#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006119#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006120 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006122#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006123#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006124 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006126#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006127#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006128 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006130#endif
6131 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006133 }
6134}
6135
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006136/*
6137 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006139unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006140{
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006142#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006143 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006145#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006146#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006147 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006149#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006150#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006151 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006153#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006154#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006155 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006157#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006158#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006159 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006161#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006162#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006163 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006165#endif
6166 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168 }
6169}
6170
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006171/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006172 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006173 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006175int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006176{
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 if (group_list == NULL) {
6180 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006181 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 for (; *group_list != 0; group_list++) {
6184 if (*group_list == tls_id) {
6185 return 0;
6186 }
6187 }
6188
6189 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006190}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006191
Valerio Setti49e69072023-06-27 17:27:51 +02006192#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006193/*
6194 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6195 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006196int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006197{
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006199
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006201 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006205}
Valerio Setti49e69072023-06-27 17:27:51 +02006206#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006207
Valerio Setti18c9fed2022-12-30 17:44:24 +01006208static const struct {
6209 uint16_t tls_id;
6210 mbedtls_ecp_group_id ecp_group_id;
6211 psa_ecc_family_t psa_family;
6212 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006213} tls_id_match_table[] =
6214{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006215#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006216 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006217#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006218#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006219 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006220#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006221#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006222 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006223#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006224#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006225 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006226#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006227#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006228 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006229#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006230#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006231 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006232#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006233#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006234 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006235#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006236#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006237 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006238#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006239#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006240 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006242#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006243 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006244#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006245#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006246 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006247#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006248#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006251#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006252 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006253#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006254 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006255};
6256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006258 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260{
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6262 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006263 if (type != NULL) {
6264 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 }
6266 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006267 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006269 return PSA_SUCCESS;
6270 }
6271 }
6272
6273 return PSA_ERROR_NOT_SUPPORTED;
6274}
6275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006277{
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6279 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006280 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006282 }
6283
6284 return MBEDTLS_ECP_DP_NONE;
6285}
6286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006288{
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6290 i++) {
6291 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006294 }
6295
6296 return 0;
6297}
6298
Valerio Setti67419f02023-01-04 16:12:42 +01006299#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006300static const struct {
6301 uint16_t tls_id;
6302 const char *name;
6303} tls_id_curve_name_table[] =
6304{
Valerio Setti54e23792023-07-07 10:49:27 +02006305 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6306 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6307 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6308 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6309 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6315 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6316 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6317 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006318 { 0, NULL },
6319};
6320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322{
Valerio Settiacd32c02023-06-29 18:06:29 +02006323 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6324 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6325 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006327 }
6328
6329 return NULL;
6330}
Valerio Setti67419f02023-01-04 16:12:42 +01006331#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006333#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006334int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6335 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6336 int cert_endpoint,
6337 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006338{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006339 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006340 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006341 const char *ext_oid;
6342 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006345 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006347 case MBEDTLS_KEY_EXCHANGE_RSA:
6348 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006349 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006350 break;
6351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006352 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6353 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6354 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6355 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006356 break;
6357
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006358 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6359 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006360 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006361 break;
6362
6363 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006364 case MBEDTLS_KEY_EXCHANGE_NONE:
6365 case MBEDTLS_KEY_EXCHANGE_PSK:
6366 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6367 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006368 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006369 usage = 0;
6370 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006372 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6373 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006374 }
6375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006377 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006378 ret = -1;
6379 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006382 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6384 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006385 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006387 }
6388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006390 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006391 ret = -1;
6392 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006393
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006395}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006396#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006397
Jerry Yu148165c2021-09-24 23:20:59 +08006398#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6400 const mbedtls_md_type_t md,
6401 unsigned char *dst,
6402 size_t dst_len,
6403 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006404{
Ronald Cronf6893e12022-01-07 22:09:01 +01006405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6406 psa_hash_operation_t *hash_operation_to_clone;
6407 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6408
Jerry Yu148165c2021-09-24 23:20:59 +08006409 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006412#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 case MBEDTLS_MD_SHA384:
6414 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6415 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006416#endif
6417
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006418#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 case MBEDTLS_MD_SHA256:
6420 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6421 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006422#endif
6423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 default:
6425 goto exit;
6426 }
6427
6428 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6429 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006430 goto exit;
6431 }
6432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6434 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006437
6438exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006439#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6440 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006441 (void) ssl;
6442#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006443 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006444}
6445#else /* MBEDTLS_USE_PSA_CRYPTO */
6446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006449static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6450 unsigned char *dst,
6451 size_t dst_len,
6452 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006453{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006454 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006455 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 if (dst_len < 48) {
6458 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6459 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006460
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006461 mbedtls_md_init(&sha384);
6462 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006463 if (ret != 0) {
6464 goto exit;
6465 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006466 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006467 if (ret != 0) {
6468 goto exit;
6469 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006470
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006471 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006472 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006473 goto exit;
6474 }
6475
6476 *olen = 48;
6477
6478exit:
6479
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006480 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006482}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006483#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006484
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006485#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006486MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006487static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6488 unsigned char *dst,
6489 size_t dst_len,
6490 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006491{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006492 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006493 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 if (dst_len < 32) {
6496 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6497 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006499 mbedtls_md_init(&sha256);
6500 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6501 if (ret != 0) {
6502 goto exit;
6503 }
6504 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6505 if (ret != 0) {
6506 goto exit;
6507 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006508
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006509 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006511 goto exit;
6512 }
6513
6514 *olen = 32;
6515
6516exit:
6517
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006518 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006521#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6524 const mbedtls_md_type_t md,
6525 unsigned char *dst,
6526 size_t dst_len,
6527 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006528{
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006530
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006531#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 case MBEDTLS_MD_SHA384:
6533 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006534#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006535
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006536#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 case MBEDTLS_MD_SHA256:
6538 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006539#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006542#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6543 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 (void) ssl;
6545 (void) dst;
6546 (void) dst_len;
6547 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006548#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006550 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006552}
XiaokangQian647719a2021-12-07 09:16:29 +00006553
Jerry Yu148165c2021-09-24 23:20:59 +08006554#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006555
Ronald Crone68ab4f2022-10-05 12:46:29 +02006556#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006557/* mbedtls_ssl_parse_sig_alg_ext()
6558 *
6559 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6560 * value (TLS 1.3 RFC8446):
6561 * enum {
6562 * ....
6563 * ecdsa_secp256r1_sha256( 0x0403 ),
6564 * ecdsa_secp384r1_sha384( 0x0503 ),
6565 * ecdsa_secp521r1_sha512( 0x0603 ),
6566 * ....
6567 * } SignatureScheme;
6568 *
6569 * struct {
6570 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6571 * } SignatureSchemeList;
6572 *
6573 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6574 * value (TLS 1.2 RFC5246):
6575 * enum {
6576 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6577 * sha512(6), (255)
6578 * } HashAlgorithm;
6579 *
6580 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6581 * SignatureAlgorithm;
6582 *
6583 * struct {
6584 * HashAlgorithm hash;
6585 * SignatureAlgorithm signature;
6586 * } SignatureAndHashAlgorithm;
6587 *
6588 * SignatureAndHashAlgorithm
6589 * supported_signature_algorithms<2..2^16-2>;
6590 *
6591 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6592 * generalization of the TLS 1.2 signature algorithm extension.
6593 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6594 * `SignatureScheme` field of TLS 1.3
6595 *
6596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006597int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6598 const unsigned char *buf,
6599 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006600{
6601 const unsigned char *p = buf;
6602 size_t supported_sig_algs_len = 0;
6603 const unsigned char *supported_sig_algs_end;
6604 uint16_t sig_alg;
6605 uint32_t common_idx = 0;
6606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6608 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006609 p += 2;
6610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 memset(ssl->handshake->received_sig_algs, 0,
6612 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006615 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 while (p < supported_sig_algs_end) {
6617 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6618 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006619 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006620 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6621 sig_alg,
6622 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006623#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6625 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6626 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006627 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006628 }
6629#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006630
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6632 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006635 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6636 common_idx += 1;
6637 }
6638 }
6639 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 if (p != end) {
6641 MBEDTLS_SSL_DEBUG_MSG(1,
6642 ("Signature algorithms extension length misaligned"));
6643 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6644 MBEDTLS_ERR_SSL_DECODE_ERROR);
6645 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006646 }
6647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 if (common_idx == 0) {
6649 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6650 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6651 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6652 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006653 }
6654
Gabor Mezei15b95a62022-05-09 16:37:58 +02006655 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006657}
6658
Ronald Crone68ab4f2022-10-05 12:46:29 +02006659#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006660
Jerry Yudc7bd172022-02-17 13:44:15 +08006661#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6662
6663#if defined(MBEDTLS_USE_PSA_CRYPTO)
6664
Gilles Peskine449bd832023-01-11 14:50:10 +01006665static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6666 mbedtls_svc_key_id_t key,
6667 psa_algorithm_t alg,
6668 const unsigned char *raw_psk, size_t raw_psk_length,
6669 const unsigned char *seed, size_t seed_length,
6670 const unsigned char *label, size_t label_length,
6671 const unsigned char *other_secret,
6672 size_t other_secret_length,
6673 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006674{
6675 psa_status_t status;
6676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 status = psa_key_derivation_setup(derivation, alg);
6678 if (status != PSA_SUCCESS) {
6679 return status;
6680 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006681
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6683 status = psa_key_derivation_input_bytes(derivation,
6684 PSA_KEY_DERIVATION_INPUT_SEED,
6685 seed, seed_length);
6686 if (status != PSA_SUCCESS) {
6687 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006688 }
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 if (other_secret != NULL) {
6691 status = psa_key_derivation_input_bytes(derivation,
6692 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6693 other_secret, other_secret_length);
6694 if (status != PSA_SUCCESS) {
6695 return status;
6696 }
6697 }
6698
6699 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006700 status = psa_key_derivation_input_bytes(
6701 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 raw_psk, raw_psk_length);
6703 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006704 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006706 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (status != PSA_SUCCESS) {
6708 return status;
6709 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 status = psa_key_derivation_input_bytes(derivation,
6712 PSA_KEY_DERIVATION_INPUT_LABEL,
6713 label, label_length);
6714 if (status != PSA_SUCCESS) {
6715 return status;
6716 }
6717 } else {
6718 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006719 }
6720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 status = psa_key_derivation_set_capacity(derivation, capacity);
6722 if (status != PSA_SUCCESS) {
6723 return status;
6724 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006727}
6728
Andrzej Kurek57d10632022-10-24 10:32:01 -04006729#if defined(PSA_WANT_ALG_SHA_384) || \
6730 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006731MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006732static int tls_prf_generic(mbedtls_md_type_t md_type,
6733 const unsigned char *secret, size_t slen,
6734 const char *label,
6735 const unsigned char *random, size_t rlen,
6736 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006737{
6738 psa_status_t status;
6739 psa_algorithm_t alg;
6740 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6741 psa_key_derivation_operation_t derivation =
6742 PSA_KEY_DERIVATION_OPERATION_INIT;
6743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006745 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006747 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006749
6750 /* Normally a "secret" should be long enough to be impossible to
6751 * find by brute force, and in particular should not be empty. But
6752 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6753 * and for this use case it makes sense to have a 0-length "secret".
6754 * Since the key API doesn't allow importing a key of length 0,
6755 * keep master_key=0, which setup_psa_key_derivation() understands
6756 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006758 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6760 psa_set_key_algorithm(&key_attributes, alg);
6761 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006762
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6764 if (status != PSA_SUCCESS) {
6765 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6766 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006767 }
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 status = setup_psa_key_derivation(&derivation,
6770 master_key, alg,
6771 NULL, 0,
6772 random, rlen,
6773 (unsigned char const *) label,
6774 (size_t) strlen(label),
6775 NULL, 0,
6776 dlen);
6777 if (status != PSA_SUCCESS) {
6778 psa_key_derivation_abort(&derivation);
6779 psa_destroy_key(master_key);
6780 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006781 }
6782
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6784 if (status != PSA_SUCCESS) {
6785 psa_key_derivation_abort(&derivation);
6786 psa_destroy_key(master_key);
6787 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006788 }
6789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 status = psa_key_derivation_abort(&derivation);
6791 if (status != PSA_SUCCESS) {
6792 psa_destroy_key(master_key);
6793 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006794 }
6795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 if (!mbedtls_svc_key_id_is_null(master_key)) {
6797 status = psa_destroy_key(master_key);
6798 }
6799 if (status != PSA_SUCCESS) {
6800 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6801 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006804}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006805#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006806#else /* MBEDTLS_USE_PSA_CRYPTO */
6807
Andrzej Kurek57d10632022-10-24 10:32:01 -04006808#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006809 (defined(MBEDTLS_MD_CAN_SHA256) || \
6810 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006811MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006812static int tls_prf_generic(mbedtls_md_type_t md_type,
6813 const unsigned char *secret, size_t slen,
6814 const char *label,
6815 const unsigned char *random, size_t rlen,
6816 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006817{
6818 size_t nb;
6819 size_t i, j, k, md_len;
6820 unsigned char *tmp;
6821 size_t tmp_len = 0;
6822 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6823 const mbedtls_md_info_t *md_info;
6824 mbedtls_md_context_t md_ctx;
6825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6831 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 tmp_len = md_len + strlen(label) + rlen;
6836 tmp = mbedtls_calloc(1, tmp_len);
6837 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006838 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6839 goto exit;
6840 }
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 nb = strlen(label);
6843 memcpy(tmp + md_len, label, nb);
6844 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006845 nb += rlen;
6846
6847 /*
6848 * Compute P_<hash>(secret, label + random)[0..dlen]
6849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006851 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6855 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006856 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 }
6858 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6859 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006860 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 }
6862 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6863 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006864 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 for (i = 0; i < dlen; i += md_len) {
6868 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len + nb);
6873 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006874 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 }
6876 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6877 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006878 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 ret = mbedtls_md_hmac_reset(&md_ctx);
6882 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006883 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 }
6885 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6886 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006887 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 }
6889 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6890 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006891 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006897 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006899 }
6900
6901exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (tmp != NULL) {
6905 mbedtls_platform_zeroize(tmp, tmp_len);
6906 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006913}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006914#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006915#endif /* MBEDTLS_USE_PSA_CRYPTO */
6916
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006917#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006918MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006919static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6920 const char *label,
6921 const unsigned char *random, size_t rlen,
6922 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006923{
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6925 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006926}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006927#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006928
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006929#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006930MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006931static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6932 const char *label,
6933 const unsigned char *random, size_t rlen,
6934 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006935{
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6937 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006938}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006939#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006940
Jerry Yuf009d862022-02-17 14:01:37 +08006941/*
6942 * Set appropriate PRF function and other SSL / TLS1.2 functions
6943 *
6944 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006945 * - hash associated with the ciphersuite (only used by TLS 1.2)
6946 *
6947 * Outputs:
6948 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6949 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006950MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006951static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6952 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006953{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006954#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006956 handshake->tls_prf = tls_prf_sha384;
6957 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6958 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006961#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006962 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006963 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006964 handshake->tls_prf = tls_prf_sha256;
6965 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6966 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6967 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006968#else
Jerry Yuf009d862022-02-17 14:01:37 +08006969 {
Jerry Yuf009d862022-02-17 14:01:37 +08006970 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006971 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006973 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006974#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006977}
Jerry Yud6ab2352022-02-17 14:03:43 +08006978
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006979/*
6980 * Compute master secret if needed
6981 *
6982 * Parameters:
6983 * [in/out] handshake
6984 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6985 * (PSA-PSK) ciphersuite_info, psk_opaque
6986 * [out] premaster (cleared)
6987 * [out] master
6988 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6989 * debug: conf->f_dbg, conf->p_dbg
6990 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006991 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006992 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006993MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006994static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6995 unsigned char *master,
6996 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006997{
6998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6999
7000 /* cf. RFC 5246, Section 8.1:
7001 * "The master secret is always exactly 48 bytes in length." */
7002 size_t const master_secret_len = 48;
7003
7004#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7005 unsigned char session_hash[48];
7006#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7007
7008 /* The label for the KDF used for key expansion.
7009 * This is either "master secret" or "extended master secret"
7010 * depending on whether the Extended Master Secret extension
7011 * is used. */
7012 char const *lbl = "master secret";
7013
Przemek Stekielae4ed302022-04-05 17:15:55 +02007014 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007015 * - If the Extended Master Secret extension is not used,
7016 * this is ClientHello.Random + ServerHello.Random
7017 * (see Sect. 8.1 in RFC 5246).
7018 * - If the Extended Master Secret extension is used,
7019 * this is the transcript of the handshake so far.
7020 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007021 unsigned char const *seed = handshake->randbytes;
7022 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007023
7024#if !defined(MBEDTLS_DEBUG_C) && \
7025 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7026 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007028 ssl = NULL; /* make sure we don't use it except for those cases */
7029 (void) ssl;
7030#endif
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 if (handshake->resume != 0) {
7033 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7034 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007035 }
7036
7037#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007039 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007040 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007041 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7042 if (ret != 0) {
7043 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7044 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7047 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007049#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007050
Przemek Stekiel99114f32022-04-22 11:20:09 +02007051#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007052 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007054 /* Perform PSK-to-MS expansion in a single step. */
7055 psa_status_t status;
7056 psa_algorithm_t alg;
7057 mbedtls_svc_key_id_t psk;
7058 psa_key_derivation_operation_t derivation =
7059 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007060 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007065
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007067 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007069 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007071
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007072 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007074
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007076 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007077 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007078 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007079 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007080 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007081 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007082 other_secret_len = 48;
7083 other_secret = handshake->premaster + 2;
7084 break;
7085 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007086 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007087 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7088 other_secret = handshake->premaster + 2;
7089 break;
7090 default:
7091 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 status = setup_psa_key_derivation(&derivation, psk, alg,
7095 ssl->conf->psk, ssl->conf->psk_len,
7096 seed, seed_len,
7097 (unsigned char const *) lbl,
7098 (size_t) strlen(lbl),
7099 other_secret, other_secret_len,
7100 master_secret_len);
7101 if (status != PSA_SUCCESS) {
7102 psa_key_derivation_abort(&derivation);
7103 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007104 }
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 status = psa_key_derivation_output_bytes(&derivation,
7107 master,
7108 master_secret_len);
7109 if (status != PSA_SUCCESS) {
7110 psa_key_derivation_abort(&derivation);
7111 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007112 }
7113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 status = psa_key_derivation_abort(&derivation);
7115 if (status != PSA_SUCCESS) {
7116 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7117 }
7118 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007119#endif
7120 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007121#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7123 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007124 psa_status_t status;
7125 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7126 psa_key_derivation_operation_t derivation =
7127 PSA_KEY_DERIVATION_OPERATION_INIT;
7128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007130
7131 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 status = psa_key_derivation_setup(&derivation, alg);
7134 if (status != PSA_SUCCESS) {
7135 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007136 }
7137
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 status = psa_key_derivation_set_capacity(&derivation,
7139 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7140 if (status != PSA_SUCCESS) {
7141 psa_key_derivation_abort(&derivation);
7142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007143 }
7144
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7146 &derivation);
7147 if (status != PSA_SUCCESS) {
7148 psa_key_derivation_abort(&derivation);
7149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007150 }
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 status = psa_key_derivation_output_bytes(&derivation,
7153 handshake->premaster,
7154 handshake->pmslen);
7155 if (status != PSA_SUCCESS) {
7156 psa_key_derivation_abort(&derivation);
7157 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7158 }
7159
7160 status = psa_key_derivation_abort(&derivation);
7161 if (status != PSA_SUCCESS) {
7162 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007163 }
7164 }
7165#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7167 lbl, seed, seed_len,
7168 master,
7169 master_secret_len);
7170 if (ret != 0) {
7171 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7172 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007173 }
7174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7176 handshake->premaster,
7177 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 mbedtls_platform_zeroize(handshake->premaster,
7180 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007181 }
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007184}
7185
Gilles Peskine449bd832023-01-11 14:50:10 +01007186int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007187{
7188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7189 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7190 ssl->handshake->ciphersuite_info;
7191
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007193
7194 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007196 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (ret != 0) {
7198 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7199 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007200 }
7201
7202 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 ret = ssl_compute_master(ssl->handshake,
7204 ssl->session_negotiate->master,
7205 ssl);
7206 if (ret != 0) {
7207 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7208 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007209 }
7210
7211 /* Swap the client and server random values:
7212 * - MS derivation wanted client+server (RFC 5246 8.1)
7213 * - key derivation wants server+client (RFC 5246 6.3) */
7214 {
7215 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 memcpy(tmp, ssl->handshake->randbytes, 64);
7217 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7218 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7219 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007220 }
7221
7222 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7224 ssl->session_negotiate->ciphersuite,
7225 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007226#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007228#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 ssl->handshake->tls_prf,
7230 ssl->handshake->randbytes,
7231 ssl->tls_version,
7232 ssl->conf->endpoint,
7233 ssl);
7234 if (ret != 0) {
7235 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7236 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007237 }
7238
7239 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7241 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007244
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007246}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007247
Gilles Peskine449bd832023-01-11 14:50:10 +01007248int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007249{
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007251#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007252 case MBEDTLS_SSL_HASH_SHA384:
7253 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7254 break;
7255#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007256#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007257 case MBEDTLS_SSL_HASH_SHA256:
7258 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7259 break;
7260#endif
7261 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007263 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007264#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7265 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007266 (void) ssl;
7267#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007269}
7270
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007271#if defined(MBEDTLS_USE_PSA_CRYPTO)
7272static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7273 const psa_hash_operation_t *hs_op,
7274 size_t buffer_size,
7275 unsigned char *hash,
7276 size_t *hlen)
7277{
7278 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007279 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007280
7281#if !defined(MBEDTLS_DEBUG_C)
7282 (void) ssl;
7283#endif
7284 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007285 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007286 if (status != PSA_SUCCESS) {
7287 goto exit;
7288 }
7289
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007290 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007291 if (status != PSA_SUCCESS) {
7292 goto exit;
7293 }
7294
7295 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7296 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7297
7298exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007299 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007300 return mbedtls_md_error_from_psa(status);
7301}
7302#else
7303static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7304 const mbedtls_md_context_t *hs_ctx,
7305 unsigned char *hash,
7306 size_t *hlen)
7307{
7308 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007309 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007310
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007311 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007312
7313#if !defined(MBEDTLS_DEBUG_C)
7314 (void) ssl;
7315#endif
7316 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7317
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007318 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007319 if (ret != 0) {
7320 goto exit;
7321 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007322 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007323 if (ret != 0) {
7324 goto exit;
7325 }
7326
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007327 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007328 if (ret != 0) {
7329 goto exit;
7330 }
7331
7332 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7333
7334 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7335 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7336
7337exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007338 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007339 return ret;
7340}
7341#endif /* MBEDTLS_USE_PSA_CRYPTO */
7342
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007343#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007344int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7345 unsigned char *hash,
7346 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007347{
7348#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007349 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7350 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007351#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007352 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7353 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007354#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007355}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007356#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007357
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007358#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007359int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7360 unsigned char *hash,
7361 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007362{
7363#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007364 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7365 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007366#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007367 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7368 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007369#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007370}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007371#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007372
Neil Armstrong80f6f322022-05-03 17:56:38 +02007373#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7374 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007375int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007376{
7377 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007379 const unsigned char *psk = NULL;
7380 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007382
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007384 /*
7385 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007386 * checked before calling this function.
7387 *
7388 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007389 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7392 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7393 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007394 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007395 }
7396
7397 /*
7398 * PMS = struct {
7399 * opaque other_secret<0..2^16-1>;
7400 * opaque psk<0..2^16-1>;
7401 * };
7402 * with "other_secret" depending on the particular key exchange
7403 */
7404#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7406 if (end - p < 2) {
7407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7408 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007411 p += 2;
7412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (end < p || (size_t) (end - p) < psk_len) {
7414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7415 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007418 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007420#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7421#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007423 /*
7424 * other_secret already set by the ClientKeyExchange message,
7425 * and is 48 bytes long
7426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 if (end - p < 2) {
7428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7429 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007430
7431 *p++ = 0;
7432 *p++ = 48;
7433 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007435#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7436#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007438 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7439 size_t len;
7440
7441 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007443 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7445 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7446 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007447 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007449 p += 2 + len;
7450
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7452 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007453#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007454#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7457 size_t zlen;
7458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007460 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7462 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7463 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007464 }
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007467 p += 2 + zlen;
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7470 MBEDTLS_DEBUG_ECDH_Z);
7471 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007472#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007473 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7475 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007476 }
7477
7478 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 if (end - p < 2) {
7480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7481 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007484 p += 2;
7485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (end < p || (size_t) (end - p) < psk_len) {
7487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7488 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007489
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007491 p += psk_len;
7492
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007493 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007494
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007496}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007497#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007498
7499#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007500MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007501static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007502
7503#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007504int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007505{
7506 /* If renegotiation is not enforced, retransmit until we would reach max
7507 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007509 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7510 unsigned char doublings = 1;
7511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007513 ++doublings;
7514 ratio >>= 1;
7515 }
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 if (++ssl->renego_records_seen > doublings) {
7518 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7519 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007520 }
7521 }
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007524}
7525#endif
7526#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007527
Jerry Yud9526692022-02-17 14:23:47 +08007528/*
7529 * Handshake functions
7530 */
7531#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7532/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007533int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007534{
7535 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7536 ssl->handshake->ciphersuite_info;
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7541 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007542 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007544 }
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7547 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007548}
7549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007551{
7552 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7553 ssl->handshake->ciphersuite_info;
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007556
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7558 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007559 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007561 }
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7564 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007565}
7566
7567#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7568/* Some certificate support -> implement write and parse */
7569
Gilles Peskine449bd832023-01-11 14:50:10 +01007570int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007571{
7572 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7573 size_t i, n;
7574 const mbedtls_x509_crt *crt;
7575 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7576 ssl->handshake->ciphersuite_info;
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7581 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007582 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007584 }
7585
7586#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7588 if (ssl->handshake->client_auth == 0) {
7589 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007590 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007592 }
7593 }
7594#endif /* MBEDTLS_SSL_CLI_C */
7595#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7597 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007598 /* Should never happen because we shouldn't have picked the
7599 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007601 }
7602 }
7603#endif
7604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007606
7607 /*
7608 * 0 . 0 handshake type
7609 * 1 . 3 handshake length
7610 * 4 . 6 length of all certs
7611 * 7 . 9 length of cert. 1
7612 * 10 . n-1 peer certificate
7613 * n . n+2 length of cert. 2
7614 * n+3 . ... upper level cert, etc.
7615 */
7616 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007620 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7622 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7623 " > %" MBEDTLS_PRINTF_SIZET,
7624 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7625 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007626 }
7627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7629 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7630 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007633 i += n; crt = crt->next;
7634 }
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7637 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7638 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007639
7640 ssl->out_msglen = i;
7641 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7642 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7643
7644 ssl->state++;
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7647 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7648 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007649 }
7650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007654}
7655
7656#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7657
7658#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007659MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007660static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7661 unsigned char *crt_buf,
7662 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007663{
7664 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (peer_crt == NULL) {
7667 return -1;
7668 }
Jerry Yud9526692022-02-17 14:23:47 +08007669
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 if (peer_crt->raw.len != crt_buf_len) {
7671 return -1;
7672 }
Jerry Yud9526692022-02-17 14:23:47 +08007673
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007675}
7676#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007677MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007678static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7679 unsigned char *crt_buf,
7680 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007681{
7682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7683 unsigned char const * const peer_cert_digest =
7684 ssl->session->peer_cert_digest;
7685 mbedtls_md_type_t const peer_cert_digest_type =
7686 ssl->session->peer_cert_digest_type;
7687 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007689 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7690 size_t digest_len;
7691
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (peer_cert_digest == NULL || digest_info == NULL) {
7693 return -1;
7694 }
Jerry Yud9526692022-02-17 14:23:47 +08007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 digest_len = mbedtls_md_get_size(digest_info);
7697 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7698 return -1;
7699 }
Jerry Yud9526692022-02-17 14:23:47 +08007700
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7702 if (ret != 0) {
7703 return -1;
7704 }
Jerry Yud9526692022-02-17 14:23:47 +08007705
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007707}
7708#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7709#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7710
7711/*
7712 * Once the certificate message is read, parse it into a cert chain and
7713 * perform basic checks, but leave actual verification to the caller
7714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007716static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7717 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007718{
7719 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7720#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007722#endif
7723 size_t i, n;
7724 uint8_t alert;
7725
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7727 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7728 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7729 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7730 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007731 }
7732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7734 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7735 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7736 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007737 }
7738
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7740 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7741 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7742 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7743 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007744 }
7745
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007747
7748 /*
7749 * Same message structure as in mbedtls_ssl_write_certificate()
7750 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007751 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007752
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 if (ssl->in_msg[i] != 0 ||
7754 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7755 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7756 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7757 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7758 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007759 }
7760
7761 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7762 i += 3;
7763
7764 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007766 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 if (i + 3 > ssl->in_hslen) {
7768 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7769 mbedtls_ssl_send_alert_message(ssl,
7770 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7771 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7772 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007773 }
7774 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7775 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (ssl->in_msg[i] != 0) {
7777 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7778 mbedtls_ssl_send_alert_message(ssl,
7779 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7780 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7781 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007782 }
7783
7784 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007785 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007786 i += 3;
7787
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (n < 128 || i + n > ssl->in_hslen) {
7789 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7790 mbedtls_ssl_send_alert_message(ssl,
7791 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7792 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7793 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007794 }
7795
7796 /* Check if we're handling the first CRT in the chain. */
7797#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007799 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007801 /* During client-side renegotiation, check that the server's
7802 * end-CRTs hasn't changed compared to the initial handshake,
7803 * mitigating the triple handshake attack. On success, reuse
7804 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7806 if (ssl_check_peer_crt_unchanged(ssl,
7807 &ssl->in_msg[i],
7808 n) != 0) {
7809 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7810 mbedtls_ssl_send_alert_message(ssl,
7811 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7812 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7813 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007814 }
7815
7816 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007818 }
7819#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7820
7821 /* Parse the next certificate in the chain. */
7822#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007824#else
7825 /* If we don't need to store the CRT chain permanently, parse
7826 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007828#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007830 case 0: /*ok*/
7831 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7832 /* Ignore certificate with an unknown algorithm: maybe a
7833 prior certificate was already trusted. */
7834 break;
7835
7836 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7837 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7838 goto crt_parse_der_failed;
7839
7840 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7841 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7842 goto crt_parse_der_failed;
7843
7844 default:
7845 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007846crt_parse_der_failed:
7847 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7848 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7849 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007850 }
7851
7852 i += n;
7853 }
7854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7856 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007857}
7858
7859#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007860MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007861static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007862{
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7864 return -1;
7865 }
Jerry Yud9526692022-02-17 14:23:47 +08007866
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007868 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7869 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7871 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7872 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007873 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007875}
7876#endif /* MBEDTLS_SSL_SRV_C */
7877
7878/* Check if a certificate message is expected.
7879 * Return either
7880 * - SSL_CERTIFICATE_EXPECTED, or
7881 * - SSL_CERTIFICATE_SKIP
7882 * indicating whether a Certificate message is expected or not.
7883 */
7884#define SSL_CERTIFICATE_EXPECTED 0
7885#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007886MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007887static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7888 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007889{
7890 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7891 ssl->handshake->ciphersuite_info;
7892
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7894 return SSL_CERTIFICATE_SKIP;
7895 }
Jerry Yud9526692022-02-17 14:23:47 +08007896
7897#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7899 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7900 return SSL_CERTIFICATE_SKIP;
7901 }
Jerry Yud9526692022-02-17 14:23:47 +08007902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007904 ssl->session_negotiate->verify_result =
7905 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007907 }
7908 }
7909#else
7910 ((void) authmode);
7911#endif /* MBEDTLS_SSL_SRV_C */
7912
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007914}
7915
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007917static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7918 int authmode,
7919 mbedtls_x509_crt *chain,
7920 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007921{
7922 int ret = 0;
7923 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7924 ssl->handshake->ciphersuite_info;
7925 int have_ca_chain = 0;
7926
7927 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7928 void *p_vrfy;
7929
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7931 return 0;
7932 }
Jerry Yud9526692022-02-17 14:23:47 +08007933
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 if (ssl->f_vrfy != NULL) {
7935 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007936 f_vrfy = ssl->f_vrfy;
7937 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 } else {
7939 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007940 f_vrfy = ssl->conf->f_vrfy;
7941 p_vrfy = ssl->conf->p_vrfy;
7942 }
7943
7944 /*
7945 * Main check: verify certificate
7946 */
7947#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007949 ((void) rs_ctx);
7950 have_ca_chain = 1;
7951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007953 ret = mbedtls_x509_crt_verify_with_ca_cb(
7954 chain,
7955 ssl->conf->f_ca_cb,
7956 ssl->conf->p_ca_cb,
7957 ssl->conf->cert_profile,
7958 ssl->hostname,
7959 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 f_vrfy, p_vrfy);
7961 } else
Jerry Yud9526692022-02-17 14:23:47 +08007962#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7963 {
7964 mbedtls_x509_crt *ca_chain;
7965 mbedtls_x509_crl *ca_crl;
7966
7967#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007969 ca_chain = ssl->handshake->sni_ca_chain;
7970 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 } else
Jerry Yud9526692022-02-17 14:23:47 +08007972#endif
7973 {
7974 ca_chain = ssl->conf->ca_chain;
7975 ca_crl = ssl->conf->ca_crl;
7976 }
7977
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007979 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 }
Jerry Yud9526692022-02-17 14:23:47 +08007981
7982 ret = mbedtls_x509_crt_verify_restartable(
7983 chain,
7984 ca_chain, ca_crl,
7985 ssl->conf->cert_profile,
7986 ssl->hostname,
7987 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007989 }
7990
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (ret != 0) {
7992 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007993 }
7994
7995#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7997 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7998 }
Jerry Yud9526692022-02-17 14:23:47 +08007999#endif
8000
8001 /*
8002 * Secondary checks: always done, but change 'ret' only if it was 0
8003 */
8004
Valerio Settiacd32c02023-06-29 18:06:29 +02008005#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008006 {
8007 const mbedtls_pk_context *pk = &chain->pk;
8008
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008009 /* If certificate uses an EC key, make sure the curve is OK.
8010 * This is a public key, so it can't be opaque, so can_do() is a good
8011 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008013 /* and in the unlikely case the above assumption no longer holds
8014 * we are making sure that pk_ec() here does not return a NULL
8015 */
Valerio Settif9362b72023-11-29 08:42:27 +01008016 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008017 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8018 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008020 }
Valerio Setti97207782023-05-18 18:59:06 +02008021 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008022 ssl->session_negotiate->verify_result |=
8023 MBEDTLS_X509_BADCERT_BAD_KEY;
8024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8026 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008027 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008029 }
Jerry Yud9526692022-02-17 14:23:47 +08008030 }
8031 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008032#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (mbedtls_ssl_check_cert_usage(chain,
8035 ciphersuite_info,
8036 !ssl->conf->endpoint,
8037 &ssl->session_negotiate->verify_result) != 0) {
8038 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8039 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008040 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 }
Jerry Yud9526692022-02-17 14:23:47 +08008042 }
8043
8044 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8045 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8046 * with details encoded in the verification flags. All other kinds
8047 * of error codes, including those from the user provided f_vrfy
8048 * functions, are treated as fatal and lead to a failure of
8049 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8051 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8052 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008053 ret = 0;
8054 }
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8057 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008058 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8059 }
8060
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008062 uint8_t alert;
8063
8064 /* The certificate may have been rejected for several reasons.
8065 Pick one and send the corresponding alert. Which alert to send
8066 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008068 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008070 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008072 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008074 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008076 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008078 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008080 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008082 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008084 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008086 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008088 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 }
8090 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8091 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008092 }
8093
8094#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 if (ssl->session_negotiate->verify_result != 0) {
8096 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8097 (unsigned int) ssl->session_negotiate->verify_result));
8098 } else {
8099 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008100 }
8101#endif /* MBEDTLS_DEBUG_C */
8102
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008104}
8105
8106#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008107MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008108static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8109 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008110{
8111 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8112 /* Remember digest of the peer's end-CRT. */
8113 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8115 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8116 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8117 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8118 mbedtls_ssl_send_alert_message(ssl,
8119 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8120 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008121
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008123 }
8124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 ret = mbedtls_md(mbedtls_md_info_from_type(
8126 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8127 start, len,
8128 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008129
8130 ssl->session_negotiate->peer_cert_digest_type =
8131 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8132 ssl->session_negotiate->peer_cert_digest_len =
8133 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8134
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008136}
8137
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008138MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008139static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8140 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008141{
8142 unsigned char *end = start + len;
8143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8144
8145 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8147 ret = mbedtls_pk_parse_subpubkey(&start, end,
8148 &ssl->handshake->peer_pubkey);
8149 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008150 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008152 }
8153
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008155}
8156#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008159{
8160 int ret = 0;
8161 int crt_expected;
8162#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8163 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8164 ? ssl->handshake->sni_authmode
8165 : ssl->conf->authmode;
8166#else
8167 const int authmode = ssl->conf->authmode;
8168#endif
8169 void *rs_ctx = NULL;
8170 mbedtls_x509_crt *chain = NULL;
8171
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008173
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8175 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8176 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008177 goto exit;
8178 }
8179
8180#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 if (ssl->handshake->ecrs_enabled &&
8182 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008183 chain = ssl->handshake->ecrs_peer_cert;
8184 ssl->handshake->ecrs_peer_cert = NULL;
8185 goto crt_verify;
8186 }
8187#endif
8188
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008190 /* mbedtls_ssl_read_record may have sent an alert already. We
8191 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008193 goto exit;
8194 }
8195
8196#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008198 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8199
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008201 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 }
Jerry Yud9526692022-02-17 14:23:47 +08008203
8204 goto exit;
8205 }
8206#endif /* MBEDTLS_SSL_SRV_C */
8207
8208 /* Clear existing peer CRT structure in case we tried to
8209 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8213 if (chain == NULL) {
8214 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8215 sizeof(mbedtls_x509_crt)));
8216 mbedtls_ssl_send_alert_message(ssl,
8217 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8218 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008219
8220 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8221 goto exit;
8222 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008224
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 ret = ssl_parse_certificate_chain(ssl, chain);
8226 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008227 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 }
Jerry Yud9526692022-02-17 14:23:47 +08008229
8230#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008232 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 }
Jerry Yud9526692022-02-17 14:23:47 +08008234
8235crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008237 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 }
Jerry Yud9526692022-02-17 14:23:47 +08008239#endif
8240
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 ret = ssl_parse_certificate_verify(ssl, authmode,
8242 chain, rs_ctx);
8243 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 }
Jerry Yud9526692022-02-17 14:23:47 +08008246
8247#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8248 {
8249 unsigned char *crt_start, *pk_start;
8250 size_t crt_len, pk_len;
8251
8252 /* We parse the CRT chain without copying, so
8253 * these pointers point into the input buffer,
8254 * and are hence still valid after freeing the
8255 * CRT chain. */
8256
8257 crt_start = chain->raw.p;
8258 crt_len = chain->raw.len;
8259
8260 pk_start = chain->pk_raw.p;
8261 pk_len = chain->pk_raw.len;
8262
8263 /* Free the CRT structures before computing
8264 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 mbedtls_x509_crt_free(chain);
8266 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008267 chain = NULL;
8268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8270 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008271 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 }
Jerry Yud9526692022-02-17 14:23:47 +08008273
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8275 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008276 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 }
Jerry Yud9526692022-02-17 14:23:47 +08008278 }
8279#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8280 /* Pass ownership to session structure. */
8281 ssl->session_negotiate->peer_cert = chain;
8282 chain = NULL;
8283#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8284
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008286
8287exit:
8288
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008290 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 }
Jerry Yud9526692022-02-17 14:23:47 +08008292
8293#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008295 ssl->handshake->ecrs_peer_cert = chain;
8296 chain = NULL;
8297 }
8298#endif
8299
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 if (chain != NULL) {
8301 mbedtls_x509_crt_free(chain);
8302 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008303 }
8304
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008306}
8307#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8308
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008309static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8310 unsigned char *padbuf, size_t hlen,
8311 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008312{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008313 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008314 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008315#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008316 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008317 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008318 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008319 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008320#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008321 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008322 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008323 mbedtls_md_context_t cloned_ctx;
8324 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008325#endif
8326
8327 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008329 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008331
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008333 ? "client finished"
8334 : "server finished";
8335
8336#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008337 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008338
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008339 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008341 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008342 }
8343
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008344 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008346 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008347 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008348 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008349#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008350 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008351
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008352 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008353 if (ret != 0) {
8354 goto exit;
8355 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008356 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008357 if (ret != 0) {
8358 goto exit;
8359 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008360
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008361 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008362 if (ret != 0) {
8363 goto exit;
8364 }
8365#endif /* MBEDTLS_USE_PSA_CRYPTO */
8366
8367 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8368
Jerry Yu615bd6f2022-02-17 14:25:15 +08008369 /*
8370 * TLSv1.2:
8371 * hash = PRF( master, finished_label,
8372 * Hash( handshake ) )[0.11]
8373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008375 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008376
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008378
Paul Elliottecb95be2023-08-11 16:41:04 +01008379 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008380
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008381 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008382
8383exit:
8384#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008385 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008386 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008387#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008388 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008389 return ret;
8390#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008391}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008392
8393#if defined(MBEDTLS_MD_CAN_SHA256)
8394static int ssl_calc_finished_tls_sha256(
8395 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8396{
8397 unsigned char padbuf[32];
8398 return ssl_calc_finished_tls_generic(ssl,
8399#if defined(MBEDTLS_USE_PSA_CRYPTO)
8400 &ssl->handshake->fin_sha256_psa,
8401#else
8402 &ssl->handshake->fin_sha256,
8403#endif
8404 padbuf, sizeof(padbuf),
8405 buf, from);
8406}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008407#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008408
Jerry Yub7ba49e2022-02-17 14:25:53 +08008409
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008410#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008411static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008413{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008414 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008415 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008416#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008417 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008418#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008419 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008420#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008421 padbuf, sizeof(padbuf),
8422 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008423}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008424#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008425
Gilles Peskine449bd832023-01-11 14:50:10 +01008426void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008427{
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008429
8430 /*
8431 * Free our handshake params
8432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 mbedtls_ssl_handshake_free(ssl);
8434 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008435 ssl->handshake = NULL;
8436
8437 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008438 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 if (ssl->transform) {
8441 mbedtls_ssl_transform_free(ssl->transform);
8442 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008443 }
8444 ssl->transform = ssl->transform_negotiate;
8445 ssl->transform_negotiate = NULL;
8446
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008448}
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008451{
8452 int resume = ssl->handshake->resume;
8453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008455
8456#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008458 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8459 ssl->renego_records_seen = 0;
8460 }
8461#endif
8462
8463 /*
8464 * Free the previous session and switch in the current one
8465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008467#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8468 /* RFC 7366 3.1: keep the EtM state */
8469 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008471#endif
8472
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 mbedtls_ssl_session_free(ssl->session);
8474 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008475 }
8476 ssl->session = ssl->session_negotiate;
8477 ssl->session_negotiate = NULL;
8478
8479 /*
8480 * Add cache entry
8481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008483 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 resume == 0) {
8485 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8486 ssl->session->id,
8487 ssl->session->id_len,
8488 ssl->session) != 0) {
8489 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8490 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008491 }
8492
8493#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8495 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008496 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008498
8499 /* Keep last flight around in case we need to resend it:
8500 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8502 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008503#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008505
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008506 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008507
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008509}
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008512{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008513 int ret;
8514 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008519
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008520 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8521 if (ret != 0) {
8522 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8523 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008524
8525 /*
8526 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8527 * may define some other value. Currently (early 2016), no defined
8528 * ciphersuite does this (and this is unlikely to change as activity has
8529 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8530 */
8531 hash_len = 12;
8532
8533#if defined(MBEDTLS_SSL_RENEGOTIATION)
8534 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008536#endif
8537
8538 ssl->out_msglen = 4 + hash_len;
8539 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8540 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8541
8542 /*
8543 * In case of session resuming, invert the client and server
8544 * ChangeCipherSpec messages order.
8545 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008547#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008549 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008551#endif
8552#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008554 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008556#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008558 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008560
8561 /*
8562 * Switch to our negotiated transform and session parameters for outbound
8563 * data.
8564 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008566
8567#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008569 unsigned char i;
8570
8571 /* Remember current epoch settings for resending */
8572 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8574 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008575
8576 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008578
8579
8580 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 for (i = 2; i > 0; i--) {
8582 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008583 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 }
8585 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008586
8587 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 if (i == 0) {
8589 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8590 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008591 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008593#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008595
8596 ssl->transform_out = ssl->transform_negotiate;
8597 ssl->session_out = ssl->session_negotiate;
8598
8599#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8601 mbedtls_ssl_send_flight_completed(ssl);
8602 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008603#endif
8604
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8606 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8607 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008608 }
8609
8610#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8612 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8613 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8614 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008615 }
8616#endif
8617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008619
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008621}
8622
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008623#define SSL_MAX_HASH_LEN 12
8624
Gilles Peskine449bd832023-01-11 14:50:10 +01008625int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008626{
8627 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8628 unsigned int hash_len = 12;
8629 unsigned char buf[SSL_MAX_HASH_LEN];
8630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008632
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008633 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8634 if (ret != 0) {
8635 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8636 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008637
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8639 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008640 goto exit;
8641 }
8642
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8644 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8645 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8646 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008647 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8648 goto exit;
8649 }
8650
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8652 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8653 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008654 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8655 goto exit;
8656 }
8657
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8659 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8660 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8661 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008662 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8663 goto exit;
8664 }
8665
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8667 buf, hash_len) != 0) {
8668 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8669 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8670 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008671 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8672 goto exit;
8673 }
8674
8675#if defined(MBEDTLS_SSL_RENEGOTIATION)
8676 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008678#endif
8679
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008681#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008683 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685#endif
8686#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008688 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008689 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008690#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008692 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008694
8695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8697 mbedtls_ssl_recv_flight_completed(ssl);
8698 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008699#endif
8700
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008702
8703exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 mbedtls_platform_zeroize(buf, hash_len);
8705 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008706}
8707
Jerry Yu392112c2022-02-17 14:34:10 +08008708#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8709/*
8710 * Helper to get TLS 1.2 PRF from ciphersuite
8711 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008713static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008714{
Jerry Yu392112c2022-02-17 14:34:10 +08008715 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008716 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008717#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8719 return tls_prf_sha384;
8720 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008721#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008722#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008723 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8725 return tls_prf_sha256;
8726 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008727 }
8728#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008729#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8730 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008731 (void) ciphersuite_info;
8732#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008733
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008735}
8736#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008737
Gilles Peskine449bd832023-01-11 14:50:10 +01008738static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008739{
8740 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008741#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 if (tls_prf == tls_prf_sha384) {
8743 return MBEDTLS_SSL_TLS_PRF_SHA384;
8744 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008745#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008746#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if (tls_prf == tls_prf_sha256) {
8748 return MBEDTLS_SSL_TLS_PRF_SHA256;
8749 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008750#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008752}
8753
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008754/*
8755 * Populate a transform structure with session keys and all the other
8756 * necessary information.
8757 *
8758 * Parameters:
8759 * - [in/out]: transform: structure to populate
8760 * [in] must be just initialised with mbedtls_ssl_transform_init()
8761 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8762 * - [in] ciphersuite
8763 * - [in] master
8764 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008765 * - [in] tls_prf: pointer to PRF to use for key derivation
8766 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008767 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008768 * - [in] endpoint: client or server
8769 * - [in] ssl: used for:
8770 * - ssl->conf->{f,p}_export_keys
8771 * [in] optionally used for:
8772 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8773 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008774MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008775static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8776 int ciphersuite,
8777 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008778#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008780#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 ssl_tls_prf_t tls_prf,
8782 const unsigned char randbytes[64],
8783 mbedtls_ssl_protocol_version tls_version,
8784 unsigned endpoint,
8785 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008786{
8787 int ret = 0;
8788 unsigned char keyblk[256];
8789 unsigned char *key1;
8790 unsigned char *key2;
8791 unsigned char *mac_enc;
8792 unsigned char *mac_dec;
8793 size_t mac_key_len = 0;
8794 size_t iv_copy_len;
8795 size_t keylen;
8796 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008797 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008798#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008799 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008800 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008801#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008802
8803#if defined(MBEDTLS_USE_PSA_CRYPTO)
8804 psa_key_type_t key_type;
8805 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8806 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008807 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008808 size_t key_bits;
8809 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8810#endif
8811
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008812 /*
8813 * Some data just needs copying into the structure
8814 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008815#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008816 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008817#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008818 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819
8820#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008822#endif
8823
8824#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008826 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8827 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829 }
8830#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8831
8832 /*
8833 * Get various info structures
8834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8836 if (ciphersuite_info == NULL) {
8837 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8838 ciphersuite));
8839 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840 }
8841
Neil Armstrongab555e02022-04-04 11:07:59 +02008842 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008843#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008845#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008847
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008849 transform->taglen =
8850 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008852
8853#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008854 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 transform->taglen,
8856 &alg,
8857 &key_type,
8858 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008859 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008861 goto end;
8862 }
8863#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008864 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 if (cipher_info == NULL) {
8866 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8867 ciphersuite_info->cipher));
8868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008870#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008871
Neil Armstronge4512952022-03-08 09:08:22 +01008872#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008873 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008875 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 (unsigned) ciphersuite_info->mac));
8877 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008878 }
8879#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008880 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (md_info == NULL) {
8882 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8883 (unsigned) ciphersuite_info->mac));
8884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008885 }
Neil Armstronge4512952022-03-08 09:08:22 +01008886#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008887
8888#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8889 /* Copy own and peer's CID if the use of the CID
8890 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8892 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008893
8894 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8896 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8897 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008898
8899 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8901 ssl->handshake->peer_cid_len);
8902 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8903 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008904 }
8905#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8906
8907 /*
8908 * Compute key block using the PRF
8909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8911 if (ret != 0) {
8912 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8913 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008914 }
8915
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8917 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8918 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8919 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8920 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008921
8922 /*
8923 * Determine the appropriate key, IV and MAC length.
8924 */
8925
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008926#if defined(MBEDTLS_USE_PSA_CRYPTO)
8927 keylen = PSA_BITS_TO_BYTES(key_bits);
8928#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008930#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931
Valerio Settie5707042023-10-11 11:54:42 +02008932#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008934 size_t explicit_ivlen;
8935
8936 transform->maclen = 0;
8937 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008938
8939 /* All modes haves 96-bit IVs, but the length of the static parts vary
8940 * with mode and version:
8941 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8942 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8943 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8944 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8945 * sequence number).
8946 */
8947 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008948
8949 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008950#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008951 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008952#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008953 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8954 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008955#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008956
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008958 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008960 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008962
8963 /* Minimum length of encrypted record */
8964 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8965 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 } else
Valerio Settie5707042023-10-11 11:54:42 +02008967#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008968#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008970 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008974#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008975 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008976#endif /* MBEDTLS_USE_PSA_CRYPTO */
8977
8978#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008979 /* Get MAC length */
8980 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8981#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008982 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8984 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8985 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008986 goto end;
8987 }
8988
8989 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008990 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008991#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008992 transform->maclen = mac_key_len;
8993
8994 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008995#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008997#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008998 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009000
9001 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009002 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009003 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005 /*
9006 * GenericBlockCipher:
9007 * 1. if EtM is in use: one block plus MAC
9008 * otherwise: * first multiple of blocklen greater than maclen
9009 * 2. IV
9010 */
9011#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009012 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009013 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 + block_size;
9015 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009016#endif
9017 {
9018 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 + block_size
9020 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009021 }
9022
Gilles Peskine449bd832023-01-11 14:50:10 +01009023 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009024 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 } else {
9026 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009027 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9028 goto end;
9029 }
9030 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009032#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9033 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9035 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009036 }
9037
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9039 (unsigned) keylen,
9040 (unsigned) transform->minlen,
9041 (unsigned) transform->ivlen,
9042 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009043
9044 /*
9045 * Finally setup the cipher contexts, IVs and MAC secrets.
9046 */
9047#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 key1 = keyblk + mac_key_len * 2;
9050 key2 = keyblk + mac_key_len * 2 + keylen;
9051
9052 mac_enc = keyblk;
9053 mac_dec = keyblk + mac_key_len;
9054
Gilles Peskine449bd832023-01-11 14:50:10 +01009055 iv_copy_len = (transform->fixed_ivlen) ?
9056 transform->fixed_ivlen : transform->ivlen;
9057 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9058 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9059 iv_copy_len);
9060 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009061#endif /* MBEDTLS_SSL_CLI_C */
9062#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009064 key1 = keyblk + mac_key_len * 2 + keylen;
9065 key2 = keyblk + mac_key_len * 2;
9066
9067 mac_enc = keyblk + mac_key_len;
9068 mac_dec = keyblk;
9069
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 iv_copy_len = (transform->fixed_ivlen) ?
9071 transform->fixed_ivlen : transform->ivlen;
9072 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9073 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9074 iv_copy_len);
9075 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009076#endif /* MBEDTLS_SSL_SRV_C */
9077 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009079 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9080 goto end;
9081 }
9082
Paul Elliott4fb19552023-10-18 12:15:30 +01009083 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009084 ssl->f_export_keys(ssl->p_export_keys,
9085 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9086 master, 48,
9087 randbytes + 32,
9088 randbytes,
9089 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009090 }
9091
9092#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009093 transform->psa_alg = alg;
9094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9096 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9097 psa_set_key_algorithm(&attributes, alg);
9098 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009099
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 if ((status = psa_import_key(&attributes,
9101 key1,
9102 PSA_BITS_TO_BYTES(key_bits),
9103 &transform->psa_key_enc)) != PSA_SUCCESS) {
9104 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009105 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009107 goto end;
9108 }
9109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009111
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 if ((status = psa_import_key(&attributes,
9113 key2,
9114 PSA_BITS_TO_BYTES(key_bits),
9115 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009116 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009118 goto end;
9119 }
9120 }
9121#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9123 cipher_info)) != 0) {
9124 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009125 goto end;
9126 }
9127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9129 cipher_info)) != 0) {
9130 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009131 goto end;
9132 }
9133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9135 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9136 MBEDTLS_ENCRYPT)) != 0) {
9137 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009138 goto end;
9139 }
9140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9142 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9143 MBEDTLS_DECRYPT)) != 0) {
9144 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009145 goto end;
9146 }
9147
9148#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9150 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9151 MBEDTLS_PADDING_NONE)) != 0) {
9152 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009153 goto end;
9154 }
9155
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9157 MBEDTLS_PADDING_NONE)) != 0) {
9158 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009159 goto end;
9160 }
9161 }
9162#endif /* MBEDTLS_CIPHER_MODE_CBC */
9163#endif /* MBEDTLS_USE_PSA_CRYPTO */
9164
Neil Armstrong29c0c042022-03-17 17:47:28 +01009165#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9166 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9167 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009169#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9173 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9174 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009175
Gilles Peskine449bd832023-01-11 14:50:10 +01009176 if ((status = psa_import_key(&attributes,
9177 mac_enc, mac_key_len,
9178 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009179 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009181 goto end;
9182 }
9183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9185 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009186#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009188#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009190 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9192 PSA_KEY_USAGE_VERIFY_HASH);
9193 } else {
9194 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9195 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009196
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 if ((status = psa_import_key(&attributes,
9198 mac_dec, mac_key_len,
9199 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009200 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009202 goto end;
9203 }
9204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9206 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009207 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 }
9209 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9210 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009211 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009213#endif /* MBEDTLS_USE_PSA_CRYPTO */
9214 }
9215#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9216
9217 ((void) mac_dec);
9218 ((void) mac_enc);
9219
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009220end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9222 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009223}
9224
Valerio Settia08b1a42022-11-17 15:10:02 +01009225#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9226 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009227int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 psa_pake_operation_t *pake_ctx,
9229 const unsigned char *buf,
9230 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009231{
9232 psa_status_t status;
9233 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009234 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009235 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9236 * At round two perform a single cycle
9237 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009239
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 for (; remaining_steps > 0; remaining_steps--) {
9241 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009242 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009244 /* Length is stored at the first byte */
9245 size_t length = buf[input_offset];
9246 input_offset += 1;
9247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009249 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9250 }
9251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 status = psa_pake_input(pake_ctx, step,
9253 buf + input_offset, length);
9254 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009255 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009256 }
9257
9258 input_offset += length;
9259 }
9260 }
9261
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009263 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009265
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009267}
9268
Valerio Setti6b3dab02022-11-17 17:14:54 +01009269int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009270 psa_pake_operation_t *pake_ctx,
9271 unsigned char *buf,
9272 size_t len, size_t *olen,
9273 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009274{
9275 psa_status_t status;
9276 size_t output_offset = 0;
9277 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009278 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009279 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9280 * At round two perform a single cycle
9281 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009283
Gilles Peskine449bd832023-01-11 14:50:10 +01009284 for (; remaining_steps > 0; remaining_steps--) {
9285 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9286 step <= PSA_PAKE_STEP_ZK_PROOF;
9287 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009288 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009289 * For each step, prepend 1 byte with the length of the data as
9290 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 status = psa_pake_output(pake_ctx, step,
9293 buf + output_offset + 1,
9294 len - output_offset - 1,
9295 &output_len);
9296 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009297 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009298 }
9299
Valerio Setti99d88c12022-11-22 16:03:43 +01009300 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009301
9302 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009303 }
9304 }
9305
9306 *olen = output_offset;
9307
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009309}
Valerio Settia08b1a42022-11-17 15:10:02 +01009310#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9311
Jerry Yuee40f9d2022-02-17 14:55:16 +08009312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009313int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9314 unsigned char *hash, size_t *hashlen,
9315 unsigned char *data, size_t data_len,
9316 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009317{
9318 psa_status_t status;
9319 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009320 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009321
Gilles Peskine449bd832023-01-11 14:50:10 +01009322 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009323
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if ((status = psa_hash_setup(&hash_operation,
9325 hash_alg)) != PSA_SUCCESS) {
9326 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009327 goto exit;
9328 }
9329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9331 64)) != PSA_SUCCESS) {
9332 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009333 goto exit;
9334 }
9335
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 if ((status = psa_hash_update(&hash_operation,
9337 data, data_len)) != PSA_SUCCESS) {
9338 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009339 goto exit;
9340 }
9341
Gilles Peskine449bd832023-01-11 14:50:10 +01009342 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9343 hashlen)) != PSA_SUCCESS) {
9344 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9345 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009346 }
9347
9348exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 if (status != PSA_SUCCESS) {
9350 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9351 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9352 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009353 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009354 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9356 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009358 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009360 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009362 }
9363 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009365}
9366
9367#else
9368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9370 unsigned char *hash, size_t *hashlen,
9371 unsigned char *data, size_t data_len,
9372 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009373{
9374 int ret = 0;
9375 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9377 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009378
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009380
Gilles Peskine449bd832023-01-11 14:50:10 +01009381 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009382
9383 /*
9384 * digitally-signed struct {
9385 * opaque client_random[32];
9386 * opaque server_random[32];
9387 * ServerDHParams params;
9388 * };
9389 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9391 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009392 goto exit;
9393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009394 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9395 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009396 goto exit;
9397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009398 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9399 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009400 goto exit;
9401 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9403 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009404 goto exit;
9405 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009406 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9407 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009408 goto exit;
9409 }
9410
9411exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009413
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 if (ret != 0) {
9415 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9416 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9417 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009418
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009420}
9421#endif /* MBEDTLS_USE_PSA_CRYPTO */
9422
Jerry Yud9d91da2022-02-17 14:57:06 +08009423#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9424
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009425/* Find the preferred hash for a given signature algorithm. */
9426unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 mbedtls_ssl_context *ssl,
9428 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009429{
Gabor Mezei078e8032022-04-27 21:17:56 +02009430 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009431 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009432
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9434 return MBEDTLS_SSL_HASH_NONE;
9435 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009436
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009438 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9440 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009441 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9443 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009444
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009445 mbedtls_md_type_t md_alg =
9446 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9447 if (md_alg == MBEDTLS_MD_NONE) {
9448 continue;
9449 }
9450
Gilles Peskine449bd832023-01-11 14:50:10 +01009451 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009452#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009454 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009455 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009456
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9458 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9459 PSA_ALG_ECDSA(psa_hash_alg),
9460 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009461 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009462 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009463
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9465 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9466 PSA_ALG_RSA_PKCS1V15_SIGN(
9467 psa_hash_alg),
9468 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009469 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009471 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009472#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009473
Gilles Peskine449bd832023-01-11 14:50:10 +01009474 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009475 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009476 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009477
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009479}
9480
9481#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9482
Jerry Yudc7bd172022-02-17 13:44:15 +08009483#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9484
XiaokangQian75d40ef2022-04-20 11:05:24 +00009485int mbedtls_ssl_validate_ciphersuite(
9486 const mbedtls_ssl_context *ssl,
9487 const mbedtls_ssl_ciphersuite_t *suite_info,
9488 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009489 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009490{
9491 (void) ssl;
9492
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 if (suite_info == NULL) {
9494 return -1;
9495 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009496
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 if ((suite_info->min_tls_version > max_tls_version) ||
9498 (suite_info->max_tls_version < min_tls_version)) {
9499 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009500 }
9501
XiaokangQian060d8672022-04-21 09:24:56 +00009502#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009503#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009504#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9506 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009507#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9509 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009510#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009511 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009513 }
9514#endif
9515
9516 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9517#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9519 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9520 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009521 }
9522#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9523#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9524
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009526}
9527
Ronald Crone68ab4f2022-10-05 12:46:29 +02009528#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009529/*
9530 * Function for writing a signature algorithm extension.
9531 *
9532 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9533 * value (TLS 1.3 RFC8446):
9534 * enum {
9535 * ....
9536 * ecdsa_secp256r1_sha256( 0x0403 ),
9537 * ecdsa_secp384r1_sha384( 0x0503 ),
9538 * ecdsa_secp521r1_sha512( 0x0603 ),
9539 * ....
9540 * } SignatureScheme;
9541 *
9542 * struct {
9543 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9544 * } SignatureSchemeList;
9545 *
9546 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9547 * value (TLS 1.2 RFC5246):
9548 * enum {
9549 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9550 * sha512(6), (255)
9551 * } HashAlgorithm;
9552 *
9553 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9554 * SignatureAlgorithm;
9555 *
9556 * struct {
9557 * HashAlgorithm hash;
9558 * SignatureAlgorithm signature;
9559 * } SignatureAndHashAlgorithm;
9560 *
9561 * SignatureAndHashAlgorithm
9562 * supported_signature_algorithms<2..2^16-2>;
9563 *
9564 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9565 * generalization of the TLS 1.2 signature algorithm extension.
9566 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9567 * `SignatureScheme` field of TLS 1.3
9568 *
9569 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009570int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9571 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009572{
9573 unsigned char *p = buf;
9574 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9575 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9576
9577 *out_len = 0;
9578
Gilles Peskine449bd832023-01-11 14:50:10 +01009579 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009580
9581 /* Check if we have space for header and length field:
9582 * - extension_type (2 bytes)
9583 * - extension_data_length (2 bytes)
9584 * - supported_signature_algorithms_length (2 bytes)
9585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009587 p += 6;
9588
9589 /*
9590 * Write supported_signature_algorithms
9591 */
9592 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9594 if (sig_alg == NULL) {
9595 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9596 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009597
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9599 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9600 *sig_alg,
9601 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9602 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009603 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009604 }
9605 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9606 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009607 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9609 *sig_alg,
9610 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009611 }
9612
9613 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009614 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 if (supported_sig_alg_len == 0) {
9616 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9617 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009618 }
9619
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9621 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9622 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009623
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009624 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009625
9626#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009628#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009629
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009631}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009632#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009633
XiaokangQian40a35232022-05-07 09:02:40 +00009634#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009635/*
9636 * mbedtls_ssl_parse_server_name_ext
9637 *
9638 * Structure of server_name extension:
9639 *
9640 * enum {
9641 * host_name(0), (255)
9642 * } NameType;
9643 * opaque HostName<1..2^16-1>;
9644 *
9645 * struct {
9646 * NameType name_type;
9647 * select (name_type) {
9648 * case host_name: HostName;
9649 * } name;
9650 * } ServerName;
9651 * struct {
9652 * ServerName server_name_list<1..2^16-1>
9653 * } ServerNameList;
9654 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009655MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009656int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9657 const unsigned char *buf,
9658 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009659{
9660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9661 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009662 size_t server_name_list_len, hostname_len;
9663 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009664
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009666
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9668 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009669 p += 2;
9670
Gilles Peskine449bd832023-01-11 14:50:10 +01009671 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009672 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009673 while (p < server_name_list_end) {
9674 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9675 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9676 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9677 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009678
Gilles Peskine449bd832023-01-11 14:50:10 +01009679 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009680 /* sni_name is intended to be used only during the parsing of the
9681 * ClientHello message (it is reset to NULL before the end of
9682 * the message parsing). Thus it is ok to just point to the
9683 * reception buffer and not make a copy of it.
9684 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009685 ssl->handshake->sni_name = p + 3;
9686 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009687 if (ssl->conf->f_sni == NULL) {
9688 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009689 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009690 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9691 ssl, p + 3, hostname_len);
9692 if (ret != 0) {
9693 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9694 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9695 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9696 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9697 }
9698 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009699 }
9700
9701 p += hostname_len + 3;
9702 }
9703
Gilles Peskine449bd832023-01-11 14:50:10 +01009704 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009705}
9706#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9707
XiaokangQianacb39922022-06-17 10:18:48 +00009708#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009709MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009710int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9711 const unsigned char *buf,
9712 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009713{
9714 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009715 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009716 const unsigned char *protocol_name_list;
9717 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009718 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009719
9720 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009721 if (ssl->conf->alpn_list == NULL) {
9722 return 0;
9723 }
XiaokangQianacb39922022-06-17 10:18:48 +00009724
9725 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009726 * RFC7301, section 3.1
9727 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009728 *
XiaokangQianc7403452022-06-23 03:24:12 +00009729 * struct {
9730 * ProtocolName protocol_name_list<2..2^16-1>
9731 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009732 */
9733
XiaokangQianc7403452022-06-23 03:24:12 +00009734 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009735 * protocol_name_list_len 2 bytes
9736 * protocol_name_len 1 bytes
9737 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009739 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009740
Gilles Peskine449bd832023-01-11 14:50:10 +01009741 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009742 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009744 protocol_name_list = p;
9745 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009746
9747 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009748 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009749 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009750 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9751 protocol_name_len);
9752 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009753 MBEDTLS_SSL_PEND_FATAL_ALERT(
9754 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009755 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9756 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009757 }
9758
9759 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009760 }
9761
9762 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9764 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009765 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009766 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009767 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009768 if (protocol_name_len == alpn_len &&
9769 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009770 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009772 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009773
9774 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009775 }
9776 }
9777
XiaokangQian95d5f542022-06-24 02:29:26 +00009778 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009779 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009780 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9781 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9782 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009783}
9784
Gilles Peskine449bd832023-01-11 14:50:10 +01009785int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9786 unsigned char *buf,
9787 unsigned char *end,
9788 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009789{
9790 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009791 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009792 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009793
Gilles Peskine449bd832023-01-11 14:50:10 +01009794 if (ssl->alpn_chosen == NULL) {
9795 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009796 }
9797
Gilles Peskine449bd832023-01-11 14:50:10 +01009798 protocol_name_len = strlen(ssl->alpn_chosen);
9799 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009800
Gilles Peskine449bd832023-01-11 14:50:10 +01009801 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009802 /*
9803 * 0 . 1 ext identifier
9804 * 2 . 3 ext length
9805 * 4 . 5 protocol list length
9806 * 6 . 6 protocol name length
9807 * 7 . 7+n protocol name
9808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009809 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009810
XiaokangQian95d5f542022-06-24 02:29:26 +00009811 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009812
Gilles Peskine449bd832023-01-11 14:50:10 +01009813 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9814 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009815 /* Note: the length of the chosen protocol has been checked to be less
9816 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9817 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009818 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009819
Gilles Peskine449bd832023-01-11 14:50:10 +01009820 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009821
9822#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009823 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009824#endif
9825
Gilles Peskine449bd832023-01-11 14:50:10 +01009826 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009827}
9828#endif /* MBEDTLS_SSL_ALPN */
9829
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009830#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009831 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009832 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009833 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009834int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9835 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009836{
9837 /* Initialize to suppress unnecessary compiler warning */
9838 size_t hostname_len = 0;
9839
9840 /* Check if new hostname is valid before
9841 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009842 if (hostname != NULL) {
9843 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009844
Gilles Peskine449bd832023-01-11 14:50:10 +01009845 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9846 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9847 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009848 }
9849
9850 /* Now it's clear that we will overwrite the old hostname,
9851 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009852 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009853 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009854 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009855 }
9856
9857 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009858 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009859 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009860 } else {
9861 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9862 if (session->hostname == NULL) {
9863 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9864 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009865
Gilles Peskine449bd832023-01-11 14:50:10 +01009866 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009867 }
9868
Gilles Peskine449bd832023-01-11 14:50:10 +01009869 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009870}
Xiaokang Qian03409292022-10-12 02:49:52 +00009871#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9872 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009873 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009874 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009875
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009876#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9877 defined(MBEDTLS_SSL_ALPN)
9878int mbedtls_ssl_session_set_alpn(mbedtls_ssl_session *session,
9879 const char *alpn)
9880{
9881 size_t alpn_len = 0;
9882
9883 if (alpn != NULL) {
9884 alpn_len = strlen(alpn);
9885
9886 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9888 }
9889 }
9890
9891 if (session->ticket_alpn != NULL) {
9892 mbedtls_zeroize_and_free(session->ticket_alpn,
9893 strlen(session->ticket_alpn));
9894 }
9895
9896 if (alpn == NULL) {
9897 session->ticket_alpn = NULL;
9898 } else {
9899 session->ticket_alpn = mbedtls_calloc(strlen(alpn) + 1, sizeof(char));
9900 if (session->ticket_alpn == NULL) {
9901 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9902 }
9903 memcpy(session->ticket_alpn, alpn, strlen(alpn) + 1);
9904 }
9905
9906 return 0;
9907}
9908#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009909#endif /* MBEDTLS_SSL_TLS_C */