blob: d7d26ab063d8dce21ba20e8858c0f6d4d223c50f [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
135 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200278#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (src->ticket != NULL) {
280 dst->ticket = mbedtls_calloc(1, src->ticket_len);
281 if (dst->ticket == NULL) {
282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
283 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000287
288#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
289 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
293 if (ret != 0) {
294 return ret;
295 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000296 }
297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
298 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200299#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200302}
303
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500304#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
309 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800310 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312
313 /* We want to copy len_new bytes when downsizing the buffer, and
314 * len_old bytes when upsizing, so we choose the smaller of two sizes,
315 * to fit one buffer into another. Size checks, ensuring that no data is
316 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 memcpy(resized_buffer, *buffer,
318 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100319 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 *buffer = resized_buffer;
322 *len_old = len_new;
323
324 return 0;
325}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200326
Gilles Peskine449bd832023-01-11 14:50:10 +0100327static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
328 size_t in_buf_new_len,
329 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200330{
331 int modified = 0;
332 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
333 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl->in_buf_len < in_buf_new_len) {
341 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
343 } else {
344 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
345 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 modified = 1;
347 }
348 }
349 }
350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200352 written_out = ssl->out_msg - ssl->out_buf;
353 iv_offset_out = ssl->out_iv - ssl->out_buf;
354 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 ssl->out_buf_len < out_buf_new_len) {
358 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
360 } else {
361 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
362 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 modified = 1;
364 }
365 }
366 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 /* Fields below might not be properly updated with record
371 * splitting or with CID, so they are manually updated here. */
372 ssl->out_msg = ssl->out_buf + written_out;
373 ssl->out_len = ssl->out_buf + len_offset_out;
374 ssl->out_iv = ssl->out_buf + iv_offset_out;
375
376 ssl->in_msg = ssl->in_buf + written_in;
377 ssl->in_len = ssl->in_buf + len_offset_in;
378 ssl->in_iv = ssl->in_buf + iv_offset_in;
379 }
380}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500381#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
382
Jerry Yudb8c48a2022-01-27 14:54:54 +0800383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800384
385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100386typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
387 const char *label,
388 const unsigned char *random, size_t rlen,
389 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800390
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
394
395/* Type for the TLS PRF */
396typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
397 const unsigned char *, size_t,
398 unsigned char *, size_t);
399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
402 int ciphersuite,
403 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200406#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 ssl_tls_prf_t tls_prf,
408 const unsigned char randbytes[64],
409 mbedtls_ssl_protocol_version tls_version,
410 unsigned endpoint,
411 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100413#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300416 const char *label,
417 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100419static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
420static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100421
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425MBEDTLS_CHECK_RETURN_CRITICAL
426static int tls_prf_sha384(const unsigned char *secret, size_t slen,
427 const char *label,
428 const unsigned char *random, size_t rlen,
429 unsigned char *dstbuf, size_t dlen);
430
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int ssl_tls12_session_load(mbedtls_ssl_session *session,
437 const unsigned char *buf,
438 size_t len);
439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100443#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
451int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
452 const unsigned char *secret, size_t slen,
453 const char *label,
454 const unsigned char *random, size_t rlen,
455 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300456{
457 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462 case MBEDTLS_SSL_TLS_PRF_SHA384:
463 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
466#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 case MBEDTLS_SSL_TLS_PRF_SHA256:
468 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100470#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 default:
473 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 }
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477}
478
Jerry Yuc73c6182022-02-08 20:29:25 +0800479#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800481{
482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (session->peer_cert != NULL) {
484 mbedtls_x509_crt_free(session->peer_cert);
485 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800486 session->peer_cert = NULL;
487 }
488#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800492 session->peer_cert_digest = NULL;
493 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
494 session->peer_cert_digest_len = 0;
495 }
496#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
497}
498#endif /* MBEDTLS_X509_CRT_PARSE_C */
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800503 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800505
506 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
Jan Bruckner151f6422023-02-10 12:45:19 +0100581 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
582 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
583
Jerry Yu7a485c12022-10-31 13:08:18 +0800584 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590}
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800593{
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800595}
596
Jerry Yud25cab02022-10-31 12:48:30 +0800597#if defined(MBEDTLS_DEBUG_C)
598static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800599 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800600 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
601 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
602 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
603 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
604 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
605 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
606 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
607 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
608 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
609 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
610 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
611 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
612 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
613 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
614 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
615 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
616 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
617 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
618 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
619 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
621 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
622 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
623 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
624 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
625 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100626 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
627 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800628};
629
Chien Wong4e9683e2023-12-28 17:07:43 +0800630static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800631 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
632 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
633 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
634 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
637 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
638 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
639 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
640 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
641 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
642 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
643 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
644 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
645 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
647 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
648 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
649 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
650 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
651 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
653 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
654 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
656 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
657 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100658 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
659 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800660};
661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 return extension_name_table[
665 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800666}
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800671 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800673 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800687}
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
690 int level, const char *file, int line,
691 int hs_msg_type, unsigned int extension_type,
692 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
694 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 mbedtls_debug_print_msg(
697 ssl, level, file, line,
698 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 ssl_tls13_get_hs_msg_name(hs_msg_type),
700 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800701 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800703 return;
704 }
705
706 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
711 mbedtls_ssl_get_extension_name(extension_type), extension_type,
712 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800720}
721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
723 int level, const char *file, int line,
724 int hs_msg_type, uint32_t extensions_mask,
725 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800726{
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 for (unsigned i = 0;
729 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
730 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800731 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800732 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800734 }
735}
736
Pengyu Lvee455c02023-01-12 14:37:24 +0800737#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800738static const char *ticket_flag_name_table[] =
739{
740 [0] = "ALLOW_PSK_RESUMPTION",
741 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
742 [3] = "ALLOW_EARLY_DATA",
743};
744
Pengyu Lv4938a562023-01-16 11:28:49 +0800745void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748{
749 size_t i;
750
751 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800752 "print ticket_flags (0x%02x)", flags);
753
754 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800755
756 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800757 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800758 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
759 ticket_flag_name_table[i]);
760 }
761 }
762}
763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
764
Jerry Yud25cab02022-10-31 12:48:30 +0800765#endif /* MBEDTLS_DEBUG_C */
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
768 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769{
770 ((void) ciphersuite_info);
771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100772#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800776#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100777#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800779 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800781#endif
782 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 return;
785 }
786}
787
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100788int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100789 unsigned hs_type,
790 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100791{
792 unsigned char hs_hdr[4];
793
794 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
796 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
797 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
798 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 unsigned char const *msg,
806 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100808 int ret;
809 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100810 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100812 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814}
815
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100816int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800817{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100818#if defined(MBEDTLS_MD_CAN_SHA256) || \
819 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_status_t status;
822#else
823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
824#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100825#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800826 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100827#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100828#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
831 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200832 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 }
834 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
835 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200836 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800838#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100839 mbedtls_md_free(&ssl->handshake->fin_sha256);
840 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100841 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
842 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
843 0);
844 if (ret != 0) {
845 return ret;
846 }
847 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 if (ret != 0) {
849 return ret;
850 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800851#endif
852#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100853#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha384);
865 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100877 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800878}
879
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100881 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800882{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100883#if defined(MBEDTLS_MD_CAN_SHA256) || \
884 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 psa_status_t status;
887#else
888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
889#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100890#else /* SHA-256 or SHA-384 */
891 ((void) ssl);
892 (void) buf;
893 (void) len;
894#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100895#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
898 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200899 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800901#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100902 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 if (ret != 0) {
904 return ret;
905 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#endif
907#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100908#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
911 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200912 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800914#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100915 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 if (ret != 0) {
917 return ret;
918 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#endif
920#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100921 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800922}
923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100926 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800927{
928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200929 return mbedtls_md_error_from_psa(psa_hash_update(
930 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934}
935#endif
936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100937#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100939 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800940{
941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200942 return mbedtls_md_error_from_psa(psa_hash_update(
943 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100945 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#endif
947}
948#endif
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100954#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500957#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100958 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200959#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500963 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100965 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
969 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200974#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200975 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200978#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->psa_pake_ctx = psa_pake_operation_init();
981 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
982#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200985#if defined(MBEDTLS_SSL_CLI_C)
986 handshake->ecjpake_cache = NULL;
987 handshake->ecjpake_cache_len = 0;
988#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200989#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200990
Gilles Peskineeccd8882020-03-10 12:19:08 +0100991#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200993#endif
994
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
996 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
997#endif
Hanno Becker75173122019-02-06 16:18:31 +0000998
999#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1000 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001002#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006{
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001008
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001009#if defined(MBEDTLS_USE_PSA_CRYPTO)
1010 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1011 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1014 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001015#endif
1016
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_md_init(&transform->md_ctx_enc);
1023 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001024#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031}
1032
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001034static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001035{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1037
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl->transform_negotiate) {
1041 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1042 }
Jerry Yu2e199812022-12-01 18:57:19 +08001043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->session_negotiate) {
1045 mbedtls_ssl_session_free(ssl->session_negotiate);
1046 }
1047 if (ssl->handshake) {
1048 mbedtls_ssl_handshake_free(ssl);
1049 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001050
Jerry Yu2e199812022-12-01 18:57:19 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /*
1053 * Either the pointers are now NULL or cleared properly and can be freed.
1054 * Now allocate missing structures.
1055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate == NULL) {
1057 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if (ssl->session_negotiate == NULL) {
1062 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001063 }
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->handshake == NULL) {
1066 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001068#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1069 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1072 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001073#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001078 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl->session_negotiate == NULL) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001085
1086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089#endif
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->session_negotiate = NULL;
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001095 }
1096
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001097#if defined(MBEDTLS_SSL_EARLY_DATA)
1098#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001099 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001100#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_SRV_C)
1102 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1103#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001104 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001105#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001106
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 mbedtls_ssl_session_init(ssl->session_negotiate);
1109 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001110
Jerry Yu2e199812022-12-01 18:57:19 +08001111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001113#endif
1114
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001115 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001116 ret = mbedtls_ssl_reset_checksum(ssl);
1117 if (ret != 0) {
1118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1119 return ret;
1120 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001121
Jerry Yud0766ec2022-09-22 10:46:57 +08001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1123 defined(MBEDTLS_SSL_SRV_C) && \
1124 defined(MBEDTLS_SSL_SESSION_TICKETS)
1125 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001127#endif
1128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001131 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001134 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001140 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001141#endif
1142
Brett Warrene0edc842021-08-17 09:53:13 +01001143/*
1144 * curve_list is translated to IANA TLS group identifiers here because
1145 * mbedtls_ssl_conf_curves returns void and so can't return
1146 * any error codes.
1147 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001148#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001149#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1150 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001152 size_t length;
1153 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1154
Thomas Daubney850a0792023-05-22 12:05:03 +01001155 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 }
Brett Warrene0edc842021-08-17 09:53:13 +01001157
1158 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1160 if (group_list == NULL) {
1161 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1162 }
Brett Warrene0edc842021-08-17 09:53:13 +01001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001165 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 curve_list[i]);
1167 if (tls_id == 0) {
1168 mbedtls_free(group_list);
1169 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001170 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001171 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001172 }
1173
1174 group_list[length] = 0;
1175
1176 ssl->handshake->group_list = group_list;
1177 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001179 ssl->handshake->group_list = ssl->conf->group_list;
1180 ssl->handshake->group_list_heap_allocated = 0;
1181 }
1182#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001183#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001184
Ronald Crone68ab4f2022-10-05 12:46:29 +02001185#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001186#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001187#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001188 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1189 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1191 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001192 const int *md;
1193 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001194 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001195 uint16_t *p;
1196
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001197 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1198 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1199 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1202 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001203 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001205#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001207#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001208
Jerry Yub476a442022-01-21 18:14:45 +08001209#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001211#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1214 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001215 }
1216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1218 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1219 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1222 sizeof(uint16_t));
1223 if (ssl->handshake->sig_algs == NULL) {
1224 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1225 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 p = (uint16_t *) ssl->handshake->sig_algs;
1228 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1229 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1230 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001231 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001233#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001236#endif
1237#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001240#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001241 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001242 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001245#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001247 ssl->handshake->sig_algs_heap_allocated = 0;
1248 }
Jerry Yucc539102022-06-27 16:27:35 +08001249#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001250#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001252}
1253
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001254#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001255/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001257static int ssl_cookie_write_dummy(void *ctx,
1258 unsigned char **p, unsigned char *end,
1259 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001260{
1261 ((void) ctx);
1262 ((void) p);
1263 ((void) end);
1264 ((void) cli_id);
1265 ((void) cli_id_len);
1266
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001268}
1269
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static int ssl_cookie_check_dummy(void *ctx,
1272 const unsigned char *cookie, size_t cookie_len,
1273 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274{
1275 ((void) ctx);
1276 ((void) cookie);
1277 ((void) cookie_len);
1278 ((void) cli_id);
1279 ((void) cli_id_len);
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001282}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001283#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001284
Paul Bakker5121ce52009-01-03 21:22:43 +00001285/*
1286 * Initialize an SSL context
1287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001288void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001289{
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001291}
1292
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001293MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001294static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001295{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001296 const mbedtls_ssl_config *conf = ssl->conf;
1297
Ronald Cron6f135e12021-12-08 16:57:54 +01001298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1300 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1301 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001303 }
1304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
1310#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1312 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1313 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001314 }
1315#endif
1316
Ronald Cron6f135e12021-12-08 16:57:54 +01001317#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1320 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001322 }
1323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1325 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001326 }
1327#endif
1328
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1330 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001331}
1332
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001333MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001334static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1335{
1336 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 ret = ssl_conf_version_check(ssl);
1338 if (ret != 0) {
1339 return ret;
1340 }
Jerry Yu60835a82021-08-04 10:13:52 +08001341
Jerry Yudef7ae42022-10-30 14:13:19 +08001342#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1343 /* RFC 8446 section 4.4.3
1344 *
1345 * If the verification fails, the receiver MUST terminate the handshake with
1346 * a "decrypt_error" alert.
1347 *
1348 * If the client is configured as TLS 1.3 only with optional verify, return
1349 * bad config.
1350 *
1351 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001352 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001354 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1355 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1356 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 1, ("Optional verify auth mode "
1360 "is not available for TLS 1.3 client"));
1361 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001362 }
1363#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1364
Yanray Wangb422cab2023-12-01 16:18:10 +08001365 if (ssl->conf->f_rng == NULL) {
1366 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1367 return MBEDTLS_ERR_SSL_NO_RNG;
1368 }
1369
Jerry Yu60835a82021-08-04 10:13:52 +08001370 /* Space for further checks */
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001373}
1374
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001375/*
1376 * Setup an SSL context
1377 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1380 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001381{
Janos Follath865b3eb2019-12-16 11:46:15 +00001382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001383 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1384 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001386 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 if ((ret = ssl_conf_check(ssl)) != 0) {
1389 return ret;
1390 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001391 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001392
Paul Bakker62f2dee2012-09-28 07:31:51 +00001393 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001394 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001396
1397 /* Set to NULL in case of an error condition */
1398 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399
Darryl Greenb33cc762019-11-28 14:29:44 +00001400#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1401 ssl->in_buf_len = in_buf_len;
1402#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1404 if (ssl->in_buf == NULL) {
1405 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001406 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001407 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001408 }
1409
Darryl Greenb33cc762019-11-28 14:29:44 +00001410#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1411 ssl->out_buf_len = out_buf_len;
1412#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1414 if (ssl->out_buf == NULL) {
1415 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001416 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001417 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001421
Johan Pascalb62bb512015-12-03 21:56:45 +01001422#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#endif
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001427 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001431
1432error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 mbedtls_free(ssl->in_buf);
1434 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001435
1436 ssl->conf = NULL;
1437
Darryl Greenb33cc762019-11-28 14:29:44 +00001438#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1439 ssl->in_buf_len = 0;
1440 ssl->out_buf_len = 0;
1441#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 ssl->in_buf = NULL;
1443 ssl->out_buf = NULL;
1444
1445 ssl->in_hdr = NULL;
1446 ssl->in_ctr = NULL;
1447 ssl->in_len = NULL;
1448 ssl->in_iv = NULL;
1449 ssl->in_msg = NULL;
1450
1451 ssl->out_hdr = NULL;
1452 ssl->out_ctr = NULL;
1453 ssl->out_len = NULL;
1454 ssl->out_iv = NULL;
1455 ssl->out_msg = NULL;
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001458}
1459
1460/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001463 *
1464 * If partial is non-zero, keep data in the input buffer and client ID.
1465 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001466 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1468 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001469{
Darryl Greenb33cc762019-11-28 14:29:44 +00001470#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1471 size_t in_buf_len = ssl->in_buf_len;
1472 size_t out_buf_len = ssl->out_buf_len;
1473#else
1474 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1475 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1476#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001477
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1479 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001480#endif
1481
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001482 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001486
1487 /* Reset incoming message parsing */
1488 ssl->in_offt = NULL;
1489 ssl->nb_zero = 0;
1490 ssl->in_msgtype = 0;
1491 ssl->in_msglen = 0;
1492 ssl->in_hslen = 0;
1493 ssl->keep_current_message = 0;
1494 ssl->transform_in = NULL;
1495
1496#if defined(MBEDTLS_SSL_PROTO_DTLS)
1497 ssl->next_record_offset = 0;
1498 ssl->in_epoch = 0;
1499#endif
1500
1501 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001505 }
1506
Ronald Cronad8c17b2022-06-10 17:18:09 +02001507 ssl->send_alert = 0;
1508
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 /* Reset outgoing message writing */
1510 ssl->out_msgtype = 0;
1511 ssl->out_msglen = 0;
1512 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 memset(ssl->out_buf, 0, out_buf_len);
1514 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001515 ssl->transform_out = NULL;
1516
1517#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519#endif
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->transform) {
1523 mbedtls_ssl_transform_free(ssl->transform);
1524 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001525 ssl->transform = NULL;
1526 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001527#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1528
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 mbedtls_ssl_transform_free(ssl->transform_application);
1531 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532 ssl->transform_application = NULL;
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001535#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1537 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1542 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001543 ssl->handshake->transform_handshake = NULL;
1544 }
1545
XiaokangQian2b01dc32022-01-21 02:53:13 +00001546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547}
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001550{
1551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1552
1553 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556
1557 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#if defined(MBEDTLS_SSL_RENEGOTIATION)
1559 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001560 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001561
1562 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1564 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001567
Hanno Beckerb0302c42021-08-03 09:39:42 +01001568 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001569 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ssl->session) {
1571 mbedtls_ssl_session_free(ssl->session);
1572 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001573 ssl->session = NULL;
1574 }
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 ssl->alpn_chosen = NULL;
1578#endif
1579
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001580#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001581 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001582#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (free_cli_id) {
1586 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001587 ssl->cli_id = NULL;
1588 ssl->cli_id_len = 0;
1589 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590#endif
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if ((ret = ssl_handshake_init(ssl)) != 0) {
1593 return ret;
1594 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001597}
1598
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001599/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001600 * Reset an initialized and used SSL context for re-use while retaining
1601 * all application-set variables, function pointers and data.
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001604{
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001606}
1607
1608/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 * SSL set accessors
1610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001611void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001612{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001613 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001614}
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001619}
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001622void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001623{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001624 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001625}
1626#endif
1627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001629{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001630 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001631}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1636 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001637{
1638 ssl->disable_datagram_packing = !allow_packing;
1639}
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1642 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->hs_timeout_min = min;
1645 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001646}
1647#endif
1648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001652}
1653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1656 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1657 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 conf->f_vrfy = f_vrfy;
1660 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001661}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1665 int (*f_rng)(void *, unsigned char *, size_t),
1666 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001668 conf->f_rng = f_rng;
1669 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1673 void (*f_dbg)(void *, int, const char *, int, const char *),
1674 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001676 conf->f_dbg = f_dbg;
1677 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1681 void *p_bio,
1682 mbedtls_ssl_send_t *f_send,
1683 mbedtls_ssl_recv_t *f_recv,
1684 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001685{
1686 ssl->p_bio = p_bio;
1687 ssl->f_send = f_send;
1688 ssl->f_recv = f_recv;
1689 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001690}
1691
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001694{
1695 ssl->mtu = mtu;
1696}
1697#endif
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001700{
1701 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001702}
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1705 void *p_timer,
1706 mbedtls_ssl_set_timer_t *f_set_timer,
1707 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708{
1709 ssl->p_timer = p_timer;
1710 ssl->f_set_timer = f_set_timer;
1711 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001712
1713 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001715}
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1719 void *p_cache,
1720 mbedtls_ssl_cache_get_t *f_get_cache,
1721 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001723 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001724 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001726}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Janos Follath865b3eb2019-12-16 11:46:15 +00001732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001735 session == NULL ||
1736 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001739 }
1740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (ssl->handshake->resume == 1) {
1742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1743 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001744
Jerry Yu21092062022-10-10 21:21:31 +08001745#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001751 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1753 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1754 session->ciphersuite));
1755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001756 }
Jerry Yu40afab62022-10-08 10:42:13 +08001757 }
Jerry Yu21092062022-10-10 21:21:31 +08001758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1761 session)) != 0) {
1762 return ret;
1763 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001764
Paul Bakker0a597072012-09-25 21:55:46 +00001765 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1772 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001773{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001774 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001775}
1776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001778void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1779 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001780{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001781 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001783
1784#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001785void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1786 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787{
1788 conf->early_data_enabled = early_data_enabled;
1789}
Jerry Yucc4e0072022-11-22 17:22:22 +08001790
1791#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001792void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001794{
Jerry Yu39da9852022-12-06 16:58:36 +08001795 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001796}
1797#endif /* MBEDTLS_SSL_SRV_C */
1798
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001799#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1804 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001805{
1806 conf->cert_profile = profile;
1807}
1808
Gilles Peskine449bd832023-01-11 14:50:10 +01001809static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001810{
1811 mbedtls_ssl_key_cert *cur = key_cert, *next;
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001814 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 cur = next;
1817 }
1818}
1819
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001820/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001822static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1823 mbedtls_x509_crt *cert,
1824 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001825{
niisato8ee24222018-06-25 19:05:48 +09001826 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001829 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 }
1834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1836 if (new_cert == NULL) {
1837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1838 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839
niisato8ee24222018-06-25 19:05:48 +09001840 new_cert->cert = cert;
1841 new_cert->key = key;
1842 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001843
Glenn Strauss36872db2022-01-22 05:06:31 -05001844 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001846 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001848 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 }
niisato8ee24222018-06-25 19:05:48 +09001852 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853 }
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001859 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861{
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001863}
1864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001866 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001868{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001869 conf->ca_chain = ca_chain;
1870 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001871
1872#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1873 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1874 * cannot be used together. */
1875 conf->f_ca_cb = NULL;
1876 conf->p_ca_cb = NULL;
1877#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001878}
Hanno Becker5adaad92019-03-27 16:54:37 +00001879
1880#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001881void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1882 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1883 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001884{
1885 conf->f_ca_cb = f_ca_cb;
1886 conf->p_ca_cb = p_ca_cb;
1887
1888 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1889 * cannot be used together. */
1890 conf->ca_chain = NULL;
1891 conf->ca_crl = NULL;
1892}
1893#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001895
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001896#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1898 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001899{
1900 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001902}
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1905 mbedtls_x509_crt *own_cert,
1906 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001907{
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1909 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1913 mbedtls_x509_crt *ca_chain,
1914 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915{
1916 ssl->handshake->sni_ca_chain = ca_chain;
1917 ssl->handshake->sni_ca_crl = ca_crl;
1918}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001919
Glenn Strauss999ef702022-03-11 01:37:23 -05001920#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1922 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001923{
1924 ssl->handshake->dn_hints = crt;
1925}
1926#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1927
Gilles Peskine449bd832023-01-11 14:50:10 +01001928void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1929 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001930{
1931 ssl->handshake->sni_authmode = authmode;
1932}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001933#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1934
Hanno Becker8927c832019-04-03 12:52:50 +01001935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1937 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1938 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001939{
1940 ssl->f_vrfy = f_vrfy;
1941 ssl->p_vrfy = p_vrfy;
1942}
1943#endif
1944
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001945#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001946
Valerio Setti016f6822022-12-09 14:17:50 +01001947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001948static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1949static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1950
Valerio Setti016f6822022-12-09 14:17:50 +01001951static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001954{
1955 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001956 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001957 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001958 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1962 psa_pake_cs_set_primitive(&cipher_suite,
1963 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1964 PSA_ECC_FAMILY_SECP_R1,
1965 256));
1966 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1969 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001970 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001974 user = jpake_server_id;
1975 user_len = sizeof(jpake_server_id);
1976 peer = jpake_client_id;
1977 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001979 user = jpake_client_id;
1980 user_len = sizeof(jpake_client_id);
1981 peer = jpake_server_id;
1982 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001984
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1986 if (status != PSA_SUCCESS) {
1987 return status;
1988 }
1989
1990 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001992 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 }
Valerio Setti016f6822022-12-09 14:17:50 +01001994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1996 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 }
Valerio Setti016f6822022-12-09 14:17:50 +01001999
2000 ssl->handshake->psa_pake_ctx_is_ok = 1;
2001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002003}
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2006 const unsigned char *pw,
2007 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002008{
2009 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2010 psa_status_t status;
2011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (ssl->handshake == NULL || ssl->conf == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 /* Empty password is not valid */
2017 if ((pw == NULL) || (pw_len == 0)) {
2018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2019 }
2020
2021 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2022 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2023 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2024
2025 status = psa_import_key(&attributes, pw, pw_len,
2026 &ssl->handshake->psa_pake_password);
2027 if (status != PSA_SUCCESS) {
2028 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2029 }
2030
2031 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2032 ssl->handshake->psa_pake_password);
2033 if (status != PSA_SUCCESS) {
2034 psa_destroy_key(ssl->handshake->psa_pake_password);
2035 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2036 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2037 }
2038
2039 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002040}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2043 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002044{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045 psa_status_t status;
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 if (ssl->handshake == NULL || ssl->conf == NULL) {
2048 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002049 }
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (mbedtls_svc_key_id_is_null(pwd)) {
2052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2053 }
2054
2055 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2056 if (status != PSA_SUCCESS) {
2057 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2059 }
2060
2061 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002062}
2063#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2065 const unsigned char *pw,
2066 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002067{
2068 mbedtls_ecjpake_role role;
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->handshake == NULL || ssl->conf == NULL) {
2071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2072 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073
Valerio Settic689ed82022-12-07 14:40:38 +01002074 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if ((pw == NULL) || (pw_len == 0)) {
2076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2077 }
Valerio Settic689ed82022-12-07 14:40:38 +01002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002080 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2086 role,
2087 MBEDTLS_MD_SHA256,
2088 MBEDTLS_ECP_DP_SECP256R1,
2089 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002090}
Valerio Setti02c25b52022-11-15 14:08:42 +01002091#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002092#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002093
Ronald Cron73fe8df2022-10-05 14:31:43 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002096{
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (conf->psk_identity == NULL ||
2098 conf->psk_identity_len == 0) {
2099 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002100 }
2101
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2104 return 1;
2105 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (conf->psk != NULL && conf->psk_len != 0) {
2109 return 1;
2110 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113}
2114
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116{
2117 /* Remove reference to existing PSK, if any. */
2118#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 /* The maintenance of the PSK key slot is the
2121 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002122 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002123 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002126 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk = NULL;
2128 conf->psk_len = 0;
2129 }
2130
2131 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (conf->psk_identity != NULL) {
2133 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 conf->psk_identity = NULL;
2135 conf->psk_identity_len = 0;
2136 }
2137}
2138
Hanno Becker7390c712018-11-15 13:33:04 +00002139/* This function assumes that PSK identity in the SSL config is unset.
2140 * It checks that the provided identity is well-formed and attempts
2141 * to make a copy of it in the SSL config.
2142 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002143MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002144static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2145 unsigned char const *psk_identity,
2146 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002147{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002148 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002150 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 (psk_identity_len >> 16) != 0 ||
2152 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2157 if (conf->psk_identity == NULL) {
2158 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2159 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002160
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002161 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002165}
2166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2168 const unsigned char *psk, size_t psk_len,
2169 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002170{
Janos Follath865b3eb2019-12-16 11:46:15 +00002171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002172
2173 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2175 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2176 }
Hanno Becker7390c712018-11-15 13:33:04 +00002177
2178 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 if (psk == NULL) {
2180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2181 }
2182 if (psk_len == 0) {
2183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2184 }
2185 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2187 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2191 }
Hanno Becker7390c712018-11-15 13:33:04 +00002192 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002194
2195 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2197 if (ret != 0) {
2198 ssl_conf_remove_psk(conf);
2199 }
Hanno Becker7390c712018-11-15 13:33:04 +00002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002202}
2203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002205{
2206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002208 /* The maintenance of the external PSK key slot is the
2209 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk_opaque_is_internal) {
2211 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002212 ssl->handshake->psk_opaque_is_internal = 0;
2213 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002214 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002215 }
Neil Armstronge952a302022-05-03 10:22:14 +02002216#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002218 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002220 ssl->handshake->psk_len = 0;
2221 }
Neil Armstronge952a302022-05-03 10:22:14 +02002222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223}
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2226 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002227{
Neil Armstrong501c9322022-05-03 09:35:09 +02002228#if defined(MBEDTLS_USE_PSA_CRYPTO)
2229 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002230 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002231 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#endif /* MBEDTLS_USE_PSA_CRYPTO */
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (psk == NULL || ssl->handshake == NULL) {
2236 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2237 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2241 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Neil Armstrong501c9322022-05-03 09:35:09 +02002245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002246#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2248 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2249 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2250 } else {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2252 }
2253 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002254 }
2255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002256
Jerry Yu568ec252022-07-22 21:27:34 +08002257#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2259 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2260 psa_set_key_usage_flags(&key_attributes,
2261 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002262 }
2263#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 psa_set_key_algorithm(&key_attributes, alg);
2266 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2269 if (status != PSA_SUCCESS) {
2270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2271 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002272
2273 /* Allow calling psa_destroy_key() on psk remove */
2274 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2279 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002280
2281 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002285#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286}
2287
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2290 mbedtls_svc_key_id_t psk,
2291 const unsigned char *psk_identity,
2292 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293{
Janos Follath865b3eb2019-12-16 11:46:15 +00002294 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002295
2296 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2299 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002300
Hanno Becker7390c712018-11-15 13:33:04 +00002301 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (mbedtls_svc_key_id_is_null(psk)) {
2303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2304 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002305 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002306
2307 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2309 psk_identity_len);
2310 if (ret != 0) {
2311 ssl_conf_remove_psk(conf);
2312 }
Hanno Becker7390c712018-11-15 13:33:04 +00002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315}
2316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2318 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319{
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 if ((mbedtls_svc_key_id_is_null(psk)) ||
2321 (ssl->handshake == NULL)) {
2322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2323 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328}
2329#endif /* MBEDTLS_USE_PSA_CRYPTO */
2330
Jerry Yu8897c072022-08-12 13:56:53 +08002331#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002332void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2333 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2334 size_t),
2335 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336{
2337 conf->f_psk = f_psk;
2338 conf->p_psk = p_psk;
2339}
Jerry Yu8897c072022-08-12 13:56:53 +08002340#endif /* MBEDTLS_SSL_SRV_C */
2341
Ronald Cron73fe8df2022-10-05 14:31:43 +02002342#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343
2344#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002345static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002347{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (alg == PSA_ALG_CBC_NO_PADDING) {
2350 return MBEDTLS_SSL_MODE_CBC;
2351 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002352#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (PSA_ALG_IS_AEAD(alg)) {
2354 return MBEDTLS_SSL_MODE_AEAD;
2355 }
2356 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002357}
2358
2359#else /* MBEDTLS_USE_PSA_CRYPTO */
2360
2361static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002363{
2364#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (mode == MBEDTLS_MODE_CBC) {
2366 return MBEDTLS_SSL_MODE_CBC;
2367 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002368#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2369
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370#if defined(MBEDTLS_GCM_C) || \
2371 defined(MBEDTLS_CCM_C) || \
2372 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 mode == MBEDTLS_MODE_CHACHAPOLY) {
2376 return MBEDTLS_SSL_MODE_AEAD;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381}
Gilles Peskine301711e2022-04-26 16:57:05 +02002382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383
Gilles Peskinee108d982022-04-26 16:50:40 +02002384static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2385 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002387{
2388#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2390 base_mode == MBEDTLS_SSL_MODE_CBC) {
2391 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002392 }
2393#else
2394 (void) encrypt_then_mac;
2395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002397}
2398
Neil Armstrongab555e02022-04-04 11:07:59 +02002399mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002401{
Gilles Peskinee108d982022-04-26 16:50:40 +02002402 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002407#endif
2408 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 encrypt_then_mac = transform->encrypt_then_mac;
2413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415}
2416
Neil Armstrongab555e02022-04-04 11:07:59 +02002417mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002422{
Gilles Peskinee108d982022-04-26 16:50:40 +02002423 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2424
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425#if defined(MBEDTLS_USE_PSA_CRYPTO)
2426 psa_status_t status;
2427 psa_algorithm_t alg;
2428 psa_key_type_t type;
2429 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002430 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2431 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (status == PSA_SUCCESS) {
2433 base_mode = mbedtls_ssl_get_base_mode(alg);
2434 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435#else
2436 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002437 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002439 base_mode =
2440 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002443#endif /* MBEDTLS_USE_PSA_CRYPTO */
2444
Gilles Peskinee108d982022-04-26 16:50:40 +02002445#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2446 int encrypt_then_mac = 0;
2447#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002449}
2450
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2454 size_t taglen,
2455 psa_algorithm_t *alg,
2456 psa_key_type_t *key_type,
2457 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002458{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002459#if !defined(MBEDTLS_SSL_HAVE_CCM)
2460 (void) taglen;
2461#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002463#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002464 case MBEDTLS_CIPHER_AES_128_CBC:
2465 *alg = PSA_ALG_CBC_NO_PADDING;
2466 *key_type = PSA_KEY_TYPE_AES;
2467 *key_size = 128;
2468 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002469#endif
2470#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002471 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002473 *key_type = PSA_KEY_TYPE_AES;
2474 *key_size = 128;
2475 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002476#endif
2477#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002478 case MBEDTLS_CIPHER_AES_128_GCM:
2479 *alg = PSA_ALG_GCM;
2480 *key_type = PSA_KEY_TYPE_AES;
2481 *key_size = 128;
2482 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002483#endif
2484#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002485 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002487 *key_type = PSA_KEY_TYPE_AES;
2488 *key_size = 192;
2489 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002490#endif
2491#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002492 case MBEDTLS_CIPHER_AES_192_GCM:
2493 *alg = PSA_ALG_GCM;
2494 *key_type = PSA_KEY_TYPE_AES;
2495 *key_size = 192;
2496 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002497#endif
2498#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 case MBEDTLS_CIPHER_AES_256_CBC:
2500 *alg = PSA_ALG_CBC_NO_PADDING;
2501 *key_type = PSA_KEY_TYPE_AES;
2502 *key_size = 256;
2503 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002504#endif
2505#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002506 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002508 *key_type = PSA_KEY_TYPE_AES;
2509 *key_size = 256;
2510 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002511#endif
2512#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 case MBEDTLS_CIPHER_AES_256_GCM:
2514 *alg = PSA_ALG_GCM;
2515 *key_type = PSA_KEY_TYPE_AES;
2516 *key_size = 256;
2517 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002518#endif
2519#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002520 case MBEDTLS_CIPHER_ARIA_128_CBC:
2521 *alg = PSA_ALG_CBC_NO_PADDING;
2522 *key_type = PSA_KEY_TYPE_ARIA;
2523 *key_size = 128;
2524 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002525#endif
2526#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002527 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002529 *key_type = PSA_KEY_TYPE_ARIA;
2530 *key_size = 128;
2531 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002532#endif
2533#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 case MBEDTLS_CIPHER_ARIA_128_GCM:
2535 *alg = PSA_ALG_GCM;
2536 *key_type = PSA_KEY_TYPE_ARIA;
2537 *key_size = 128;
2538 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002539#endif
2540#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002541 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002543 *key_type = PSA_KEY_TYPE_ARIA;
2544 *key_size = 192;
2545 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002546#endif
2547#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002548 case MBEDTLS_CIPHER_ARIA_192_GCM:
2549 *alg = PSA_ALG_GCM;
2550 *key_type = PSA_KEY_TYPE_ARIA;
2551 *key_size = 192;
2552 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002553#endif
2554#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 case MBEDTLS_CIPHER_ARIA_256_CBC:
2556 *alg = PSA_ALG_CBC_NO_PADDING;
2557 *key_type = PSA_KEY_TYPE_ARIA;
2558 *key_size = 256;
2559 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002560#endif
2561#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002562 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002564 *key_type = PSA_KEY_TYPE_ARIA;
2565 *key_size = 256;
2566 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002567#endif
2568#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 case MBEDTLS_CIPHER_ARIA_256_GCM:
2570 *alg = PSA_ALG_GCM;
2571 *key_type = PSA_KEY_TYPE_ARIA;
2572 *key_size = 256;
2573 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002574#endif
2575#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002576 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2577 *alg = PSA_ALG_CBC_NO_PADDING;
2578 *key_type = PSA_KEY_TYPE_CAMELLIA;
2579 *key_size = 128;
2580 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002581#endif
2582#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002583 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002585 *key_type = PSA_KEY_TYPE_CAMELLIA;
2586 *key_size = 128;
2587 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002588#endif
2589#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2591 *alg = PSA_ALG_GCM;
2592 *key_type = PSA_KEY_TYPE_CAMELLIA;
2593 *key_size = 128;
2594 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002595#endif
2596#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002597 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002599 *key_type = PSA_KEY_TYPE_CAMELLIA;
2600 *key_size = 192;
2601 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002602#endif
2603#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002604 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2605 *alg = PSA_ALG_GCM;
2606 *key_type = PSA_KEY_TYPE_CAMELLIA;
2607 *key_size = 192;
2608 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002609#endif
2610#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2612 *alg = PSA_ALG_CBC_NO_PADDING;
2613 *key_type = PSA_KEY_TYPE_CAMELLIA;
2614 *key_size = 256;
2615 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002616#endif
2617#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002618 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002620 *key_type = PSA_KEY_TYPE_CAMELLIA;
2621 *key_size = 256;
2622 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002623#endif
2624#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2626 *alg = PSA_ALG_GCM;
2627 *key_type = PSA_KEY_TYPE_CAMELLIA;
2628 *key_size = 256;
2629 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002630#endif
2631#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002632 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2633 *alg = PSA_ALG_CHACHA20_POLY1305;
2634 *key_type = PSA_KEY_TYPE_CHACHA20;
2635 *key_size = 256;
2636 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002637#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002638 case MBEDTLS_CIPHER_NULL:
2639 *alg = MBEDTLS_SSL_NULL_CIPHER;
2640 *key_type = 0;
2641 *key_size = 0;
2642 break;
2643 default:
2644 return PSA_ERROR_NOT_SUPPORTED;
2645 }
2646
2647 return PSA_SUCCESS;
2648}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002649#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002650
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002651#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002652int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2653 const unsigned char *dhm_P, size_t P_len,
2654 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002655{
Janos Follath865b3eb2019-12-16 11:46:15 +00002656 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 mbedtls_mpi_free(&conf->dhm_P);
2659 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2662 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2663 mbedtls_mpi_free(&conf->dhm_P);
2664 mbedtls_mpi_free(&conf->dhm_G);
2665 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002666 }
2667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002669}
Paul Bakker5121ce52009-01-03 21:22:43 +00002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002672{
Janos Follath865b3eb2019-12-16 11:46:15 +00002673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 mbedtls_mpi_free(&conf->dhm_P);
2676 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2679 &conf->dhm_P)) != 0 ||
2680 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2681 &conf->dhm_G)) != 0) {
2682 mbedtls_mpi_free(&conf->dhm_P);
2683 mbedtls_mpi_free(&conf->dhm_G);
2684 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002685 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002688}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002689#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002690
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002691#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2692/*
2693 * Set the minimum length for Diffie-Hellman parameters
2694 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002695void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2696 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002697{
2698 conf->dhm_min_bitlen = bitlen;
2699}
2700#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2701
Ronald Crone68ab4f2022-10-05 12:46:29 +02002702#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002703#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002704/*
2705 * Set allowed/preferred hashes for handshake signatures
2706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002707void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2708 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002709{
2710 conf->sig_hashes = hashes;
2711}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002712#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002713
Jerry Yuf017ee42022-01-12 15:49:48 +08002714/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002715void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2716 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002717{
Jerry Yuf017ee42022-01-12 15:49:48 +08002718#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2719 conf->sig_hashes = NULL;
2720#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2721 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002722}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002723#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002724
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002725#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002726#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002727/*
2728 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002729 *
2730 * mbedtls_ssl_setup() takes the provided list
2731 * and translates it to a list of IANA TLS group identifiers,
2732 * stored in ssl->handshake->group_list.
2733 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002735void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2736 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002738 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002739 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740}
Brett Warrene0edc842021-08-17 09:53:13 +01002741#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002742#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002743
Brett Warrene0edc842021-08-17 09:53:13 +01002744/*
2745 * Set the allowed groups
2746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002747void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2748 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002749{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002750#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002751 conf->curve_list = NULL;
2752#endif
2753 conf->group_list = group_list;
2754}
2755
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002756#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002757int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002758{
Hanno Becker947194e2017-04-07 13:25:49 +01002759 /* Initialize to suppress unnecessary compiler warning */
2760 size_t hostname_len = 0;
2761
2762 /* Check if new hostname is valid before
2763 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (hostname != NULL) {
2765 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2769 }
Hanno Becker947194e2017-04-07 13:25:49 +01002770 }
2771
2772 /* Now it's clear that we will overwrite the old hostname,
2773 * so we can free it safely */
2774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002776 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002777 }
2778
2779 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002782 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 } else {
2784 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2785 if (ssl->hostname == NULL) {
2786 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2787 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002790
Hanno Becker947194e2017-04-07 13:25:49 +01002791 ssl->hostname[hostname_len] = '\0';
2792 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002795}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002796#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002797
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002798#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002799void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2800 int (*f_sni)(void *, mbedtls_ssl_context *,
2801 const unsigned char *, size_t),
2802 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002803{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002804 conf->f_sni = f_sni;
2805 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002806}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002810int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002811{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002812 size_t cur_len, tot_len;
2813 const char **p;
2814
2815 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002816 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2817 * MUST NOT be truncated."
2818 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002819 */
2820 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 for (p = protos; *p != NULL; p++) {
2822 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002823 tot_len += cur_len;
2824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if ((cur_len == 0) ||
2826 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2827 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2829 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002830 }
2831
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002832 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002835}
2836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002838{
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002840}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002842
Johan Pascalb62bb512015-12-03 21:56:45 +01002843#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2845 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002846{
2847 conf->dtls_srtp_mki_support = support_mki_value;
2848}
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2851 unsigned char *mki_value,
2852 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002853{
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002856 }
Ron Eldor591f1622018-01-22 12:30:04 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2859 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002860 }
Ron Eldor591f1622018-01-22 12:30:04 +02002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002863 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002865}
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2868 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002869{
Johan Pascal253d0262020-09-22 13:04:45 +02002870 const mbedtls_ssl_srtp_profile *p;
2871 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002872
Johan Pascal253d0262020-09-22 13:04:45 +02002873 /* check the profiles list: all entry must be valid,
2874 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2876 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2877 p++) {
2878 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002879 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002881 /* unsupported value, stop parsing and set the size to an error value */
2882 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002883 }
2884 }
2885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2887 conf->dtls_srtp_profile_list = NULL;
2888 conf->dtls_srtp_profile_list_len = 0;
2889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002890 }
2891
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002892 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002893 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002896}
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2899 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002900{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002901 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2902 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002904 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002906 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2908 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002909 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002910}
Johan Pascalb62bb512015-12-03 21:56:45 +01002911#endif /* MBEDTLS_SSL_DTLS_SRTP */
2912
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302913#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002914void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002915{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002916 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002917}
2918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002920{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002921 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002922}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302923#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002924
Janos Follath088ce432017-04-10 12:42:31 +01002925#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002926void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2927 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002928{
2929 conf->cert_req_ca_list = cert_req_ca_list;
2930}
2931#endif
2932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002935{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002936 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002937}
2938#endif
2939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002940#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002941void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002942{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002943 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002944}
2945#endif
2946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002948int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002949{
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2951 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2952 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002953 }
2954
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002955 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002956
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002958}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002962{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002963 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002964}
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002970}
2971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002973{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002974 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002975}
2976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2978 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002979{
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002981}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002985#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002986void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002987{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002988 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002989}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002990#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002991
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002992#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002993
Jerry Yud0766ec2022-09-22 10:46:57 +08002994#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002995void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2996 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002997{
Jerry Yud0766ec2022-09-22 10:46:57 +08002998 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002999}
3000#endif
3001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3003 mbedtls_ssl_ticket_write_t *f_ticket_write,
3004 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3005 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003006{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003007 conf->f_ticket_write = f_ticket_write;
3008 conf->f_ticket_parse = f_ticket_parse;
3009 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003010}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3015 mbedtls_ssl_export_keys_t *f_export_keys,
3016 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003017{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003018 ssl->f_export_keys = f_export_keys;
3019 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003020}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003021
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003022#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003023void mbedtls_ssl_conf_async_private_cb(
3024 mbedtls_ssl_config *conf,
3025 mbedtls_ssl_async_sign_t *f_async_sign,
3026 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3027 mbedtls_ssl_async_resume_t *f_async_resume,
3028 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003030{
3031 conf->f_async_sign_start = f_async_sign;
3032 conf->f_async_decrypt_start = f_async_decrypt;
3033 conf->f_async_resume = f_async_resume;
3034 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003035 conf->p_async_config_data = async_config_data;
3036}
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003039{
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003041}
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003044{
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (ssl->handshake == NULL) {
3046 return NULL;
3047 } else {
3048 return ssl->handshake->user_async_ctx;
3049 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003050}
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3053 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003054{
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003056 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003058}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003059#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003060
Paul Bakker5121ce52009-01-03 21:22:43 +00003061/*
3062 * SSL get accessors
3063 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003064uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003065{
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 if (ssl->session != NULL) {
3067 return ssl->session->verify_result;
3068 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (ssl->session_negotiate != NULL) {
3071 return ssl->session_negotiate->verify_result;
3072 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003075}
3076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl == NULL || ssl->session == NULL) {
3080 return 0;
3081 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003084}
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003087{
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 if (ssl == NULL || ssl->session == NULL) {
3089 return NULL;
3090 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003093}
3094
Gilles Peskine449bd832023-01-11 14:50:10 +01003095const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003096{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3099 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003100 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003102 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003104 }
3105 }
3106#endif
3107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003109 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003111 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003113 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003115 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003116}
3117
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003118#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3119
3120size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3121{
3122 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3123 size_t record_size_limit = max_len;
3124
3125 if (ssl->session != NULL &&
3126 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3127 ssl->session->record_size_limit < max_len) {
3128 record_size_limit = ssl->session->record_size_limit;
3129 }
3130
3131 // TODO: this is currently untested
3132 /* During a handshake, use the value being negotiated */
3133 if (ssl->session_negotiate != NULL &&
3134 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3135 ssl->session_negotiate->record_size_limit < max_len) {
3136 record_size_limit = ssl->session_negotiate->record_size_limit;
3137 }
3138
3139 return record_size_limit;
3140}
3141#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3142
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003143#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003144size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003145{
David Horstmann95d516f2021-05-04 18:36:56 +01003146 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003147 size_t read_mfl;
3148
Jerry Yuddda0502022-12-01 19:43:12 +08003149#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003150 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3152 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3153 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003154 }
Jerry Yuddda0502022-12-01 19:43:12 +08003155#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003156
3157 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 if (ssl->session_out != NULL) {
3159 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3160 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003161 max_len = read_mfl;
3162 }
3163 }
3164
Jerry Yuddda0502022-12-01 19:43:12 +08003165 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 if (ssl->session_negotiate != NULL) {
3167 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3168 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003169 max_len = read_mfl;
3170 }
3171 }
3172
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003177{
3178 size_t max_len;
3179
3180 /*
3181 * Assume mfl_code is correct since it was checked when set
3182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003184
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003185 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 if (ssl->session_out != NULL &&
3187 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3188 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003189 }
3190
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003191 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (ssl->session_negotiate != NULL &&
3193 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3194 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003195 }
3196
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003198}
3199#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3200
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003201#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003202size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003203{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003204 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3206 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3207 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3208 return 0;
3209 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003210
Gilles Peskine449bd832023-01-11 14:50:10 +01003211 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3212 return ssl->mtu;
3213 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 if (ssl->mtu == 0) {
3216 return ssl->handshake->mtu;
3217 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 return ssl->mtu < ssl->handshake->mtu ?
3220 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003221}
3222#endif /* MBEDTLS_SSL_PROTO_DTLS */
3223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003225{
3226 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3227
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003228#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003229 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003230 !defined(MBEDTLS_SSL_PROTO_DTLS)
3231 (void) ssl;
3232#endif
3233
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003234#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003238 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003240#endif
3241
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003242#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3243 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3244
3245 if (max_len > record_size_limit) {
3246 max_len = record_size_limit;
3247 }
3248#endif
3249
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003250 if (ssl->transform_out != NULL &&
3251 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003252 /*
3253 * In TLS 1.3 case, when records are protected, `max_len` as computed
3254 * above is the maximum length of the TLSInnerPlaintext structure that
3255 * along the plaintext payload contains the inner content type (one byte)
3256 * and some zero padding. Given the algorithm used for padding
3257 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3258 * the plaintext payload. Round down to a multiple of
3259 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3260 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003261 */
3262 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3263 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3264 }
3265
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3268 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3269 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003270 const size_t overhead = (size_t) ret;
3271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (ret < 0) {
3273 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003274 }
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (mtu <= overhead) {
3277 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3278 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3279 }
3280
3281 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003282 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003284 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003285#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003286
Hanno Becker0defedb2018-08-10 12:35:02 +01003287#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003288 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3289 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003290 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003291#endif
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003294}
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003297{
3298 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3299
3300#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3301 (void) ssl;
3302#endif
3303
3304#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003308 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003310#endif
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003313}
3314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003316const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003317{
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 if (ssl == NULL || ssl->session == NULL) {
3319 return NULL;
3320 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003321
Hanno Beckere6824572019-02-07 13:18:46 +00003322#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003324#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003326#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003327}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3332 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003333{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003334 int ret;
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003337 dst == NULL ||
3338 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003341 }
3342
Hanno Beckere810bbc2021-05-14 16:01:05 +01003343 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3344 * idempotent: Each session can only be exported once.
3345 *
3346 * (This is in preparation for TLS 1.3 support where we will
3347 * need the ability to export multiple sessions (aka tickets),
3348 * which will be achieved by calling mbedtls_ssl_get_session()
3349 * multiple times until it fails.)
3350 *
3351 * Check whether we have already exported the current session,
3352 * and fail if so.
3353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 if (ssl->session->exported == 1) {
3355 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3356 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3359 if (ret != 0) {
3360 return ret;
3361 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003362
3363 /* Remember that we've exported the session. */
3364 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003366}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003368
David Horstmanncb01b362024-02-29 17:31:46 +00003369#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3370
3371/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003372 *
David Horstmanncb01b362024-02-29 17:31:46 +00003373 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003374 */
3375static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3376 unsigned char *buf,
3377 size_t buf_len)
3378{
3379 unsigned char *p = buf;
3380 size_t used = 0;
3381
3382#if defined(MBEDTLS_HAVE_TIME)
3383 uint64_t start;
3384#endif
3385#if defined(MBEDTLS_X509_CRT_PARSE_C)
3386#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3387 size_t cert_len;
3388#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3389#endif /* MBEDTLS_X509_CRT_PARSE_C */
3390
3391 /*
3392 * Time
3393 */
3394#if defined(MBEDTLS_HAVE_TIME)
3395 used += 8;
3396
3397 if (used <= buf_len) {
3398 start = (uint64_t) session->start;
3399
3400 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3401 p += 8;
3402 }
3403#endif /* MBEDTLS_HAVE_TIME */
3404
3405 /*
3406 * Basic mandatory fields
3407 */
3408 used += 1 /* id_len */
3409 + sizeof(session->id)
3410 + sizeof(session->master)
3411 + 4; /* verify_result */
3412
3413 if (used <= buf_len) {
3414 *p++ = MBEDTLS_BYTE_0(session->id_len);
3415 memcpy(p, session->id, 32);
3416 p += 32;
3417
3418 memcpy(p, session->master, 48);
3419 p += 48;
3420
3421 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3422 p += 4;
3423 }
3424
3425 /*
3426 * Peer's end-entity certificate
3427 */
3428#if defined(MBEDTLS_X509_CRT_PARSE_C)
3429#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3430 if (session->peer_cert == NULL) {
3431 cert_len = 0;
3432 } else {
3433 cert_len = session->peer_cert->raw.len;
3434 }
3435
3436 used += 3 + cert_len;
3437
3438 if (used <= buf_len) {
3439 *p++ = MBEDTLS_BYTE_2(cert_len);
3440 *p++ = MBEDTLS_BYTE_1(cert_len);
3441 *p++ = MBEDTLS_BYTE_0(cert_len);
3442
3443 if (session->peer_cert != NULL) {
3444 memcpy(p, session->peer_cert->raw.p, cert_len);
3445 p += cert_len;
3446 }
3447 }
3448#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3449 if (session->peer_cert_digest != NULL) {
3450 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3451 if (used <= buf_len) {
3452 *p++ = (unsigned char) session->peer_cert_digest_type;
3453 *p++ = (unsigned char) session->peer_cert_digest_len;
3454 memcpy(p, session->peer_cert_digest,
3455 session->peer_cert_digest_len);
3456 p += session->peer_cert_digest_len;
3457 }
3458 } else {
3459 used += 2;
3460 if (used <= buf_len) {
3461 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3462 *p++ = 0;
3463 }
3464 }
3465#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3466#endif /* MBEDTLS_X509_CRT_PARSE_C */
3467
3468 /*
3469 * Session ticket if any, plus associated data
3470 */
3471#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3472#if defined(MBEDTLS_SSL_CLI_C)
3473 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3474 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3475
3476 if (used <= buf_len) {
3477 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3478 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3479 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3480
3481 if (session->ticket != NULL) {
3482 memcpy(p, session->ticket, session->ticket_len);
3483 p += session->ticket_len;
3484 }
3485
3486 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3487 p += 4;
3488 }
3489 }
3490#endif /* MBEDTLS_SSL_CLI_C */
3491#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3492 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3493 used += 8;
3494
3495 if (used <= buf_len) {
3496 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3497 p += 8;
3498 }
3499 }
3500#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3501#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3502
3503 /*
3504 * Misc extension-related info
3505 */
3506#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3507 used += 1;
3508
3509 if (used <= buf_len) {
3510 *p++ = session->mfl_code;
3511 }
3512#endif
3513
3514#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3515 used += 1;
3516
3517 if (used <= buf_len) {
3518 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3519 }
3520#endif
3521
3522 return used;
3523}
3524
3525MBEDTLS_CHECK_RETURN_CRITICAL
3526static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3527 const unsigned char *buf,
3528 size_t len)
3529{
3530#if defined(MBEDTLS_HAVE_TIME)
3531 uint64_t start;
3532#endif
3533#if defined(MBEDTLS_X509_CRT_PARSE_C)
3534#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3535 size_t cert_len;
3536#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3537#endif /* MBEDTLS_X509_CRT_PARSE_C */
3538
3539 const unsigned char *p = buf;
3540 const unsigned char * const end = buf + len;
3541
3542 /*
3543 * Time
3544 */
3545#if defined(MBEDTLS_HAVE_TIME)
3546 if (8 > (size_t) (end - p)) {
3547 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3548 }
3549
3550 start = MBEDTLS_GET_UINT64_BE(p, 0);
3551 p += 8;
3552
3553 session->start = (time_t) start;
3554#endif /* MBEDTLS_HAVE_TIME */
3555
3556 /*
3557 * Basic mandatory fields
3558 */
3559 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3560 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3561 }
3562
3563 session->id_len = *p++;
3564 memcpy(session->id, p, 32);
3565 p += 32;
3566
3567 memcpy(session->master, p, 48);
3568 p += 48;
3569
3570 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3571 p += 4;
3572
3573 /* Immediately clear invalid pointer values that have been read, in case
3574 * we exit early before we replaced them with valid ones. */
3575#if defined(MBEDTLS_X509_CRT_PARSE_C)
3576#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3577 session->peer_cert = NULL;
3578#else
3579 session->peer_cert_digest = NULL;
3580#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3581#endif /* MBEDTLS_X509_CRT_PARSE_C */
3582#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3583 session->ticket = NULL;
3584#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3585
3586 /*
3587 * Peer certificate
3588 */
3589#if defined(MBEDTLS_X509_CRT_PARSE_C)
3590#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3591 /* Deserialize CRT from the end of the ticket. */
3592 if (3 > (size_t) (end - p)) {
3593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3594 }
3595
3596 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3597 p += 3;
3598
3599 if (cert_len != 0) {
3600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3601
3602 if (cert_len > (size_t) (end - p)) {
3603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3604 }
3605
3606 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3607
3608 if (session->peer_cert == NULL) {
3609 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3610 }
3611
3612 mbedtls_x509_crt_init(session->peer_cert);
3613
3614 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3615 p, cert_len)) != 0) {
3616 mbedtls_x509_crt_free(session->peer_cert);
3617 mbedtls_free(session->peer_cert);
3618 session->peer_cert = NULL;
3619 return ret;
3620 }
3621
3622 p += cert_len;
3623 }
3624#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3625 /* Deserialize CRT digest from the end of the ticket. */
3626 if (2 > (size_t) (end - p)) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629
3630 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3631 session->peer_cert_digest_len = (size_t) *p++;
3632
3633 if (session->peer_cert_digest_len != 0) {
3634 const mbedtls_md_info_t *md_info =
3635 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3636 if (md_info == NULL) {
3637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3638 }
3639 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
3642
3643 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3645 }
3646
3647 session->peer_cert_digest =
3648 mbedtls_calloc(1, session->peer_cert_digest_len);
3649 if (session->peer_cert_digest == NULL) {
3650 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3651 }
3652
3653 memcpy(session->peer_cert_digest, p,
3654 session->peer_cert_digest_len);
3655 p += session->peer_cert_digest_len;
3656 }
3657#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3658#endif /* MBEDTLS_X509_CRT_PARSE_C */
3659
3660 /*
3661 * Session ticket and associated data
3662 */
3663#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3664#if defined(MBEDTLS_SSL_CLI_C)
3665 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3666 if (3 > (size_t) (end - p)) {
3667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3668 }
3669
3670 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3671 p += 3;
3672
3673 if (session->ticket_len != 0) {
3674 if (session->ticket_len > (size_t) (end - p)) {
3675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3676 }
3677
3678 session->ticket = mbedtls_calloc(1, session->ticket_len);
3679 if (session->ticket == NULL) {
3680 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3681 }
3682
3683 memcpy(session->ticket, p, session->ticket_len);
3684 p += session->ticket_len;
3685 }
3686
3687 if (4 > (size_t) (end - p)) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690
3691 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3692 p += 4;
3693 }
3694#endif /* MBEDTLS_SSL_CLI_C */
3695#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3696 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3697 if (8 > (size_t) (end - p)) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3701 p += 8;
3702 }
3703#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3704#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3705
3706 /*
3707 * Misc extension-related info
3708 */
3709#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3710 if (1 > (size_t) (end - p)) {
3711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3712 }
3713
3714 session->mfl_code = *p++;
3715#endif
3716
3717#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3718 if (1 > (size_t) (end - p)) {
3719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3720 }
3721
3722 session->encrypt_then_mac = *p++;
3723#endif
3724
3725 /* Done, should have consumed entire buffer */
3726 if (p != end) {
3727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3728 }
3729
3730 return 0;
3731}
3732
3733#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3734
3735#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3736/* Serialization of TLS 1.3 sessions:
3737 *
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003738 * struct {
3739 * opaque hostname<0..2^16-1>;
3740 * uint64 ticket_reception_time;
3741 * uint32 ticket_lifetime;
3742 * opaque ticket<1..2^16-1>;
3743 * } ClientOnlyData;
3744 *
3745 * struct {
3746 * uint32 ticket_age_add;
3747 * uint8 ticket_flags;
3748 * opaque resumption_key<0..255>;
3749 * uint32 max_early_data_size;
3750 * uint16 record_size_limit;
3751 * select ( endpoint ) {
3752 * case client: ClientOnlyData;
3753 * case server: uint64 ticket_creation_time;
3754 * };
3755 * } serialized_session_tls13;
3756 *
David Horstmanne59f9702024-02-29 16:08:57 +00003757 */
3758#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3759MBEDTLS_CHECK_RETURN_CRITICAL
3760static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3761 unsigned char *buf,
3762 size_t buf_len,
3763 size_t *olen)
3764{
3765 unsigned char *p = buf;
3766#if defined(MBEDTLS_SSL_CLI_C) && \
3767 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3768 size_t hostname_len = (session->hostname == NULL) ?
3769 0 : strlen(session->hostname) + 1;
3770#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003771
3772#if defined(MBEDTLS_SSL_SRV_C) && \
3773 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3774 const uint8_t alpn_len = (session->alpn == NULL) ?
3775 0 : (uint8_t) strlen(session->alpn) + 1;
3776#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003777 size_t needed = 4 /* ticket_age_add */
3778 + 1 /* ticket_flags */
3779 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003780
David Horstmanne59f9702024-02-29 16:08:57 +00003781 *olen = 0;
3782
3783 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3784 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3785 }
3786 needed += session->resumption_key_len; /* resumption_key */
3787
3788#if defined(MBEDTLS_SSL_EARLY_DATA)
3789 needed += 4; /* max_early_data_size */
3790#endif
3791#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3792 needed += 2; /* record_size_limit */
3793#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3794
3795#if defined(MBEDTLS_HAVE_TIME)
3796 needed += 8; /* ticket_creation_time or ticket_reception_time */
3797#endif
3798
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003799#if defined(MBEDTLS_SSL_SRV_C)
3800 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3801#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3802 needed += 1 /* alpn_len */
3803 + alpn_len; /* alpn */
3804#endif
3805 }
3806#endif /* MBEDTLS_SSL_SRV_C */
3807
David Horstmanne59f9702024-02-29 16:08:57 +00003808#if defined(MBEDTLS_SSL_CLI_C)
3809 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3810#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3811 needed += 2 /* hostname_len */
3812 + hostname_len; /* hostname */
3813#endif
3814
3815 needed += 4 /* ticket_lifetime */
3816 + 2; /* ticket_len */
3817
3818 /* Check size_t overflow */
3819 if (session->ticket_len > SIZE_MAX - needed) {
3820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3821 }
3822
3823 needed += session->ticket_len; /* ticket */
3824 }
3825#endif /* MBEDTLS_SSL_CLI_C */
3826
3827 *olen = needed;
3828 if (needed > buf_len) {
3829 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3830 }
3831
3832 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3833 p[4] = session->ticket_flags;
3834
3835 /* save resumption_key */
3836 p[5] = session->resumption_key_len;
3837 p += 6;
3838 memcpy(p, session->resumption_key, session->resumption_key_len);
3839 p += session->resumption_key_len;
3840
3841#if defined(MBEDTLS_SSL_EARLY_DATA)
3842 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3843 p += 4;
3844#endif
3845#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3846 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3847 p += 2;
3848#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3849
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003850#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003851 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003852#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003853 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3854 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003855#endif /* MBEDTLS_HAVE_TIME */
3856
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003857#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3858 *p++ = alpn_len;
3859 if (alpn_len > 0) {
3860 /* save chosen alpn */
3861 memcpy(p, session->alpn, alpn_len);
3862 p += alpn_len;
3863 }
3864#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3865 }
3866#endif /* MBEDTLS_SSL_SRV_C */
3867
David Horstmanne59f9702024-02-29 16:08:57 +00003868#if defined(MBEDTLS_SSL_CLI_C)
3869 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3870#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3871 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3872 p += 2;
3873 if (hostname_len > 0) {
3874 /* save host name */
3875 memcpy(p, session->hostname, hostname_len);
3876 p += hostname_len;
3877 }
3878#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3879
3880#if defined(MBEDTLS_HAVE_TIME)
3881 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3882 p += 8;
3883#endif
3884 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3885 p += 4;
3886
3887 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3888 p += 2;
3889
3890 if (session->ticket != NULL && session->ticket_len > 0) {
3891 memcpy(p, session->ticket, session->ticket_len);
3892 p += session->ticket_len;
3893 }
3894 }
3895#endif /* MBEDTLS_SSL_CLI_C */
3896 return 0;
3897}
3898
3899MBEDTLS_CHECK_RETURN_CRITICAL
3900static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3901 const unsigned char *buf,
3902 size_t len)
3903{
3904 const unsigned char *p = buf;
3905 const unsigned char *end = buf + len;
3906
3907 if (end - p < 6) {
3908 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3909 }
3910 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3911 session->ticket_flags = p[4];
3912
3913 /* load resumption_key */
3914 session->resumption_key_len = p[5];
3915 p += 6;
3916
3917 if (end - p < session->resumption_key_len) {
3918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3919 }
3920
3921 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3923 }
3924 memcpy(session->resumption_key, p, session->resumption_key_len);
3925 p += session->resumption_key_len;
3926
3927#if defined(MBEDTLS_SSL_EARLY_DATA)
3928 if (end - p < 4) {
3929 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3930 }
3931 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3932 p += 4;
3933#endif
3934#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3935 if (end - p < 2) {
3936 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3937 }
3938 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3939 p += 2;
3940#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3941
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003942#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003943 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003944#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003945 if (end - p < 8) {
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3947 }
3948 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3949 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003950#endif /* MBEDTLS_HAVE_TIME */
3951
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
3953 uint8_t alpn_len;
3954
3955 if (end - p < 1) {
3956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3957 }
3958 alpn_len = *p++;
3959
3960 if (end - p < alpn_len) {
3961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3962 }
3963 if (alpn_len > 0) {
3964 session->alpn = mbedtls_calloc(alpn_len, sizeof(char));
3965 if (session->alpn == NULL) {
3966 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3967 }
3968 memcpy(session->alpn, p, alpn_len);
3969 p += alpn_len;
3970 }
3971#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3972 }
3973#endif /* MBEDTLS_SSL_SRV_C */
3974
David Horstmanne59f9702024-02-29 16:08:57 +00003975#if defined(MBEDTLS_SSL_CLI_C)
3976 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3977#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3978 size_t hostname_len;
3979 /* load host name */
3980 if (end - p < 2) {
3981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3982 }
3983 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3984 p += 2;
3985
3986 if (end - p < (long int) hostname_len) {
3987 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3988 }
3989 if (hostname_len > 0) {
3990 session->hostname = mbedtls_calloc(1, hostname_len);
3991 if (session->hostname == NULL) {
3992 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3993 }
3994 memcpy(session->hostname, p, hostname_len);
3995 p += hostname_len;
3996 }
3997#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3998
3999#if defined(MBEDTLS_HAVE_TIME)
4000 if (end - p < 8) {
4001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4002 }
4003 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4004 p += 8;
4005#endif
4006 if (end - p < 4) {
4007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4008 }
4009 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4010 p += 4;
4011
4012 if (end - p < 2) {
4013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4014 }
4015 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4016 p += 2;
4017
4018 if (end - p < (long int) session->ticket_len) {
4019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4020 }
4021 if (session->ticket_len > 0) {
4022 session->ticket = mbedtls_calloc(1, session->ticket_len);
4023 if (session->ticket == NULL) {
4024 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4025 }
4026 memcpy(session->ticket, p, session->ticket_len);
4027 p += session->ticket_len;
4028 }
4029 }
4030#endif /* MBEDTLS_SSL_CLI_C */
4031
4032 return 0;
4033
4034}
4035#else /* MBEDTLS_SSL_SESSION_TICKETS */
4036MBEDTLS_CHECK_RETURN_CRITICAL
4037static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4038 unsigned char *buf,
4039 size_t buf_len,
4040 size_t *olen)
4041{
4042 ((void) session);
4043 ((void) buf);
4044 ((void) buf_len);
4045 *olen = 0;
4046 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4047}
4048
4049static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
4050 unsigned char *buf,
4051 size_t buf_len)
4052{
4053 ((void) session);
4054 ((void) buf);
4055 ((void) buf_len);
4056 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4057}
4058#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4059#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4060
Paul Bakker5121ce52009-01-03 21:22:43 +00004061/*
Hanno Beckera835da52019-05-16 12:39:07 +01004062 * Define ticket header determining Mbed TLS version
4063 * and structure of the ticket.
4064 */
4065
Hanno Becker94ef3b32019-05-16 12:50:45 +01004066/*
Hanno Becker50b59662019-05-28 14:30:45 +01004067 * Define bitflag determining compile-time settings influencing
4068 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004069 */
4070
Hanno Becker50b59662019-05-28 14:30:45 +01004071#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004072#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004073#else
Hanno Becker3e088662019-05-29 11:10:18 +01004074#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004075#endif /* MBEDTLS_HAVE_TIME */
4076
4077#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004078#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004079#else
Hanno Becker3e088662019-05-29 11:10:18 +01004080#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081#endif /* MBEDTLS_X509_CRT_PARSE_C */
4082
David Horstmann5c5a32f2024-02-13 17:53:35 +00004083#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004084#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004085#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004086#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004087#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4088
Hanno Becker94ef3b32019-05-16 12:50:45 +01004089#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#else
Hanno Becker3e088662019-05-29 11:10:18 +01004092#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4094
4095#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004096#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004097#else
Hanno Becker3e088662019-05-29 11:10:18 +01004098#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004099#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4100
Hanno Becker94ef3b32019-05-16 12:50:45 +01004101#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004102#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004103#else
Hanno Becker3e088662019-05-29 11:10:18 +01004104#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004105#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4106
Hanno Becker94ef3b32019-05-16 12:50:45 +01004107#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4108#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4109#else
4110#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4111#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4112
David Horstmann92b258b2024-02-13 17:23:34 +00004113#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4114#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4115#else
4116#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4117#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4118
4119#if defined(MBEDTLS_SSL_EARLY_DATA)
4120#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4121#else
4122#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4123#endif /* MBEDTLS_SSL_EARLY_DATA */
4124
4125#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4126#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4127#else
4128#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4129#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4130
Hanno Becker3e088662019-05-29 11:10:18 +01004131#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4132#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4133#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4134#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004135#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4136#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004137#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004138#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4139#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4140#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Hanno Becker3e088662019-05-29 11:10:18 +01004141
Hanno Becker50b59662019-05-28 14:30:45 +01004142#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 ((uint16_t) ( \
4144 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4145 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4146 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4147 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4148 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4149 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004150 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004151 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4152 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004153 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4154 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4155 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4156 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
4157 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004158
Chien Wong4e9683e2023-12-28 17:07:43 +08004159static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004160 MBEDTLS_VERSION_MAJOR,
4161 MBEDTLS_VERSION_MINOR,
4162 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4164 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004165};
Hanno Beckera835da52019-05-16 12:39:07 +01004166
4167/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004168 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004169 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004170 *
David Horstmanncb01b362024-02-29 17:31:46 +00004171 * TLS 1.2 session:
4172 *
4173 * struct {
4174 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4175 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4176 * uint32 ticket_lifetime;
4177 * #endif
4178 * } ClientOnlyData;
4179 *
4180 * struct {
4181 * #if defined(MBEDTLS_HAVE_TIME)
4182 * uint64 start_time;
4183 * #endif
4184 * uint8 session_id_len; // at most 32
4185 * opaque session_id[32];
4186 * opaque master[48]; // fixed length in the standard
4187 * uint32 verify_result;
4188 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4189 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4190 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004191 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004192 * opaque peer_cert_digest<0..2^8-1>
4193 * #endif
4194 * select (endpoint) {
4195 * case client: ClientOnlyData;
4196 * case server: uint64 ticket_creation_time;
4197 * };
4198 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4199 * uint8 mfl_code; // up to 255 according to standard
4200 * #endif
4201 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4202 * uint8 encrypt_then_mac; // 0 or 1
4203 * #endif
4204 * } serialized_session_tls12;
4205 *
4206 *
4207 * TLS 1.3 Session:
4208 *
4209 * struct {
4210 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4211 * opaque hostname<0..2^16-1>;
4212 * #endif
4213 * #if defined(MBEDTLS_HAVE_TIME)
4214 * uint64 ticket_reception_time;
4215 * #endif
4216 * uint32 ticket_lifetime;
4217 * opaque ticket<1..2^16-1>;
4218 * } ClientOnlyData;
4219 *
4220 * struct {
4221 * uint32 ticket_age_add;
4222 * uint8 ticket_flags;
4223 * opaque resumption_key<0..255>;
4224 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4225 * uint32 max_early_data_size;
4226 * #endif
4227 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4228 * uint16 record_size_limit;
4229 * #endif
4230 * select ( endpoint ) {
4231 * case client: ClientOnlyData;
4232 * #if defined(MBEDTLS_HAVE_TIME)
4233 * case server: uint64 ticket_creation_time;
4234 * #endif
4235 * };
4236 * } serialized_session_tls13;
4237 *
4238 *
4239 * SSL session:
4240 *
4241 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004242 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004243 * opaque mbedtls_version[3]; // library version: major, minor, patch
4244 * opaque session_format[2]; // library-version specific 16-bit field
4245 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004246 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004247 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004248 * Note: When updating the format, remember to keep
4249 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004250 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004251 * // In this version, `session_format` determines
4252 * // the setting of those compile-time
4253 * // configuration options which influence
4254 * // the structure of mbedtls_ssl_session.
4255 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004256 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004257 * // - TLS 1.2 (0x0303)
4258 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004259 * uint8_t endpoint;
4260 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004261 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004262 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004264 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004266 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004267 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004268 *
4269 * };
4270 *
4271 * } serialized_session;
4272 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004273 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004274
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004276static int ssl_session_save(const mbedtls_ssl_session *session,
4277 unsigned char omit_header,
4278 unsigned char *buf,
4279 size_t buf_len,
4280 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004281{
4282 unsigned char *p = buf;
4283 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004284 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004285#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4286 size_t out_len;
4287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4288#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (session == NULL) {
4290 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4291 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294 /*
4295 * Add Mbed TLS version identifier
4296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 if (used <= buf_len) {
4300 memcpy(p, ssl_serialized_session_header,
4301 sizeof(ssl_serialized_session_header));
4302 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004303 }
4304 }
4305
4306 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004307 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004308 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004309 used += 1 /* TLS version */
4310 + 1 /* endpoint */
4311 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (used <= buf_len) {
4313 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004314 *p++ = session->endpoint;
4315 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4316 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004317 }
4318
4319 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004320 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 case MBEDTLS_SSL_VERSION_TLS1_2:
4324 used += ssl_tls12_session_save(session, p, remaining_len);
4325 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4327
Jerry Yu251a12e2022-07-13 15:15:48 +08004328#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 case MBEDTLS_SSL_VERSION_TLS1_3:
4330 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4331 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4332 return ret;
4333 }
4334 used += out_len;
4335 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004336#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 default:
4339 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004340 }
4341
4342 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if (used > buf_len) {
4344 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4345 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004348}
4349
4350/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004351 * Public wrapper for ssl_session_save()
4352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004353int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4354 unsigned char *buf,
4355 size_t buf_len,
4356 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004357{
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004359}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004360
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004361/*
4362 * Deserialize session, see mbedtls_ssl_session_save() for format.
4363 *
4364 * This internal version is wrapped by a public function that cleans up in
4365 * case of error, and has an extra option omit_header.
4366 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004367MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004368static int ssl_session_load(mbedtls_ssl_session *session,
4369 unsigned char omit_header,
4370 const unsigned char *buf,
4371 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004372{
4373 const unsigned char *p = buf;
4374 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004375 size_t remaining_len;
4376
4377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (session == NULL) {
4379 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4380 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004383 /*
4384 * Check Mbed TLS version identifier
4385 */
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004389 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004390
4391 if (memcmp(p, ssl_serialized_session_header,
4392 sizeof(ssl_serialized_session_header)) != 0) {
4393 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4394 }
4395 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004396 }
4397
4398 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004399 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004400 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004401 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4403 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004404 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004405 session->endpoint = *p++;
4406 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4407 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004408
4409 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004410 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004412#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 case MBEDTLS_SSL_VERSION_TLS1_2:
4414 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4416
Jerry Yu438ddd82022-07-07 06:55:50 +00004417#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 case MBEDTLS_SSL_VERSION_TLS1_3:
4419 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004420#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 default:
4423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004424 }
4425}
4426
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004427/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004428 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004430int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4431 const unsigned char *buf,
4432 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004433{
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004435
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (ret != 0) {
4437 mbedtls_ssl_session_free(session);
4438 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004441}
4442
4443/*
Paul Bakker1961b702013-01-25 14:49:24 +01004444 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004445 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004447static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004448{
4449 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4450
Ronald Cron66dbf912022-02-02 15:33:46 +01004451 /*
4452 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004453 * that were written into the output buffer by the previous handshake step,
4454 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004455 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4456 * We proceed to the next handshake step only when all data from the
4457 * previous one have been sent to the peer, thus we make sure that this is
4458 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4459 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4460 * we have to wait before to go ahead.
4461 * In the case of TLS 1.3, handshake step handlers do not send data to the
4462 * peer. Data are only sent here and through
4463 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004464 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4467 return ret;
4468 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004469
4470#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4472 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4473 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4474 return ret;
4475 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004476 }
4477#endif /* MBEDTLS_SSL_PROTO_DTLS */
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004480}
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004483{
Hanno Becker41934dd2021-08-07 19:13:43 +01004484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004485
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004487 ssl->conf == NULL ||
4488 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004491 }
4492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 ret = ssl_prepare_handshake_step(ssl);
4494 if (ret != 0) {
4495 return ret;
4496 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 ret = mbedtls_ssl_handle_pending_alert(ssl);
4499 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004500 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 }
Jerry Yue7047812021-09-13 19:26:39 +08004502
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004503 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4504 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4505 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4509 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004510 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004513 case MBEDTLS_SSL_HELLO_REQUEST:
4514 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004515 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004516 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004517
Ronald Cron9f0fba32022-02-10 16:45:15 +01004518 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004520 break;
4521
4522 default:
4523#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4525 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4526 } else {
4527 ret = mbedtls_ssl_handshake_client_step(ssl);
4528 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004529#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533#endif
4534 }
Jerry Yub9930e72021-08-06 17:11:51 +08004535 }
Ronald Cron6291b232023-03-08 15:51:25 +01004536#endif /* MBEDTLS_SSL_CLI_C */
4537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004540#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4541 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004543 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_handshake_server_step(ssl);
4545 }
Ronald Cron6291b232023-03-08 15:51:25 +01004546#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4547 ret = mbedtls_ssl_handshake_server_step(ssl);
4548#else
4549 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004550#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004551 }
4552#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004555 /* handshake_step return error. And it is same
4556 * with alert_reason.
4557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 if (ssl->send_alert) {
4559 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004560 goto cleanup;
4561 }
4562 }
4563
4564cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004566}
4567
4568/*
4569 * Perform the SSL handshake
4570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004572{
4573 int ret = 0;
4574
Hanno Beckera817ea42020-10-20 15:20:23 +01004575 /* Sanity checks */
4576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (ssl == NULL || ssl->conf == NULL) {
4578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4579 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004580
Hanno Beckera817ea42020-10-20 15:20:23 +01004581#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4583 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4584 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4585 "mbedtls_ssl_set_timer_cb() for DTLS"));
4586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004587 }
4588#endif /* MBEDTLS_SSL_PROTO_DTLS */
4589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004591
Hanno Beckera817ea42020-10-20 15:20:23 +01004592 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4594 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004597 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 }
Paul Bakker1961b702013-01-25 14:49:24 +01004599 }
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004604}
4605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606#if defined(MBEDTLS_SSL_RENEGOTIATION)
4607#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004608/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004609 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004610 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004612static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004613{
Janos Follath865b3eb2019-12-16 11:46:15 +00004614 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004617
4618 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4620 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4623 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4624 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004625 }
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004632
4633/*
4634 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 * - any side: calling mbedtls_ssl_renegotiate(),
4636 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4637 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004638 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004639 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004640 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004643{
Janos Follath865b3eb2019-12-16 11:46:15 +00004644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004645
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if ((ret = ssl_handshake_init(ssl)) != 0) {
4649 return ret;
4650 }
Paul Bakker48916f92012-09-16 19:57:18 +00004651
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004652 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4653 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004654#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4656 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4657 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004658 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004660 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004662 }
4663#endif
4664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4666 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4669 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4670 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004671 }
4672
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004676}
4677
4678/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004679 * Renegotiate current connection on client,
4680 * or request renegotiation on server
4681 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004682int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004683{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ssl == NULL || ssl->conf == NULL) {
4687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4688 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004691 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4693 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4695 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004698
4699 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 if (ssl->out_left != 0) {
4701 return mbedtls_ssl_flush_output(ssl);
4702 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004703
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004705 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004706#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709 /*
4710 * On client, either start the renegotiation process or,
4711 * if already in progress, continue the handshake
4712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4714 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004717
4718 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4719 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4720 return ret;
4721 }
4722 } else {
4723 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4724 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4725 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004726 }
4727 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004731}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004735{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004736 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004739 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004741
Valerio Setti6f0441d2023-07-03 12:11:36 +02004742#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004743#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (ssl->handshake->group_list_heap_allocated) {
4745 mbedtls_free((void *) handshake->group_list);
4746 }
Brett Warrene0edc842021-08-17 09:53:13 +01004747 handshake->group_list = NULL;
4748#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004749#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004750
Ronald Crone68ab4f2022-10-05 12:46:29 +02004751#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->handshake->sig_algs_heap_allocated) {
4754 mbedtls_free((void *) handshake->sig_algs);
4755 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004756 handshake->sig_algs = NULL;
4757#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004758#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (ssl->handshake->certificate_request_context) {
4760 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004761 }
4762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004763#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004764
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004765#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4767 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004768 handshake->async_in_progress = 0;
4769 }
4770#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004772#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004773#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004775#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004776 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004777#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004778#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004779#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004780#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004782#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004783 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004784#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004785#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004786
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004789#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004790#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004791 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004793#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004794
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004795#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004796#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004798 /*
4799 * Opaque keys are not stored in the handshake's data and it's the user
4800 * responsibility to destroy them. Clear ones, instead, are created by
4801 * the TLS library and should be destroyed at the same level
4802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4804 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004805 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004806 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4807#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004809#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004810#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004812 handshake->ecjpake_cache = NULL;
4813 handshake->ecjpake_cache_len = 0;
4814#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004815#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004816
Valerio Setti7aeec542023-07-05 18:57:21 +02004817#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004818 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004819 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004820 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004822#endif
4823
Ronald Cron73fe8df2022-10-05 14:31:43 +02004824#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004825#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004827 /* The maintenance of the external PSK key slot is the
4828 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (ssl->handshake->psk_opaque_is_internal) {
4830 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004831 ssl->handshake->psk_opaque_is_internal = 0;
4832 }
4833 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4834 }
Neil Armstronge952a302022-05-03 10:22:14 +02004835#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004837 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004838 }
Neil Armstronge952a302022-05-03 10:22:14 +02004839#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004840#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004842#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4843 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004844 /*
4845 * Free only the linked list wrapper, not the keys themselves
4846 * since the belong to the SNI callback
4847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004849#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004850
Gilles Peskineeccd8882020-03-10 12:19:08 +01004851#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4853 if (handshake->ecrs_peer_cert != NULL) {
4854 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4855 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004856 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004857#endif
4858
Hanno Becker75173122019-02-06 16:18:31 +00004859#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4860 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004862#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4863
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004864#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4866 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004867#endif /* MBEDTLS_SSL_CLI_C &&
4868 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004869
4870#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 mbedtls_ssl_flight_free(handshake->flight);
4872 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004873#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004874
Valerio Settiea59c432023-07-25 11:14:03 +02004875#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004876 if (handshake->xxdh_psa_privkey_is_external == 0) {
4877 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 }
Valerio Settiea59c432023-07-25 11:14:03 +02004879#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004880
Ronald Cron6f135e12021-12-08 16:57:54 +01004881#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(handshake->transform_handshake);
4883 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004884#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4886 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004887#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004888#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004889
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004890
4891#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4892 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4893 * processes datagrams and the fact that a datagram is allowed to have
4894 * several records in it, it is possible that the I/O buffers are not
4895 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4897 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004898#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004899
Jerry Yuba9c7272021-10-30 11:54:10 +08004900 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 mbedtls_platform_zeroize(handshake,
4902 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004903}
4904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004906{
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004908 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004913#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004914
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004915#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004916#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4917 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004919#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004920#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4921 defined(MBEDTLS_SSL_SRV_C)
4922 mbedtls_free(session->alpn);
4923#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004925#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004928}
4929
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004930#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004931
4932#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4933#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4934#else
4935#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4936#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4937
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004938#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004939
4940#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4941#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4942#else
4943#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4944#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4945
4946#if defined(MBEDTLS_SSL_ALPN)
4947#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4948#else
4949#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4950#endif /* MBEDTLS_SSL_ALPN */
4951
4952#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4953#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4954#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4956
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 ((uint32_t) ( \
4959 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4960 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4961 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4962 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4963 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4964 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4965 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4966 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004967
Chien Wong4e9683e2023-12-28 17:07:43 +08004968static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004969 MBEDTLS_VERSION_MAJOR,
4970 MBEDTLS_VERSION_MINOR,
4971 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4973 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4974 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4975 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4976 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004977};
4978
Paul Bakker5121ce52009-01-03 21:22:43 +00004979/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004980 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004981 *
4982 * The format of the serialized data is:
4983 * (in the presentation language of TLS, RFC 8446 section 3)
4984 *
4985 * // header
4986 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004987 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004988 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004989 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004990 * Note: When updating the format, remember to keep these
4991 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004992 *
4993 * // session sub-structure
4994 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4995 * // transform sub-structure
4996 * uint8 random[64]; // ServerHello.random+ClientHello.random
4997 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4998 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4999 * // fields from ssl_context
5000 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5001 * uint64 in_window_top; // DTLS: last validated record seq_num
5002 * uint64 in_window; // DTLS: bitmask for replay protection
5003 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5004 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5005 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5006 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5007 *
5008 * Note that many fields of the ssl_context or sub-structures are not
5009 * serialized, as they fall in one of the following categories:
5010 *
5011 * 1. forced value (eg in_left must be 0)
5012 * 2. pointer to dynamically-allocated memory (eg session, transform)
5013 * 3. value can be re-derived from other data (eg session keys from MS)
5014 * 4. value was temporary (eg content of input buffer)
5015 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005017int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5018 unsigned char *buf,
5019 size_t buf_len,
5020 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005021{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005022 unsigned char *p = buf;
5023 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005024 size_t session_len;
5025 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005026
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005027 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005028 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5029 * this function's documentation.
5030 *
5031 * These are due to assumptions/limitations in the implementation. Some of
5032 * them are likely to stay (no handshake in progress) some might go away
5033 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005034 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005035 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5037 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005039 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (ssl->handshake != NULL) {
5041 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005043 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005044 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if (ssl->transform == NULL || ssl->session == NULL) {
5046 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005048 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005049 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (mbedtls_ssl_check_pending(ssl) != 0) {
5051 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (ssl->out_left != 0) {
5055 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005057 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005058 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5060 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005062 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005063 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5065 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005067 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005068 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5070 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005072 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005073 /* Renegotiation must not be enabled */
5074#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5076 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005078 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005079#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005080
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005081 /*
5082 * Version and format identifier
5083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (used <= buf_len) {
5087 memcpy(p, ssl_serialized_context_header,
5088 sizeof(ssl_serialized_context_header));
5089 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005090 }
5091
5092 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005093 * Session (length + data)
5094 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5096 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5097 return ret;
5098 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005099
5100 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 if (used <= buf_len) {
5102 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005103 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 ret = ssl_session_save(ssl->session, 1,
5106 p, session_len, &session_len);
5107 if (ret != 0) {
5108 return ret;
5109 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005110
5111 p += session_len;
5112 }
5113
5114 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005115 * Transform
5116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 used += sizeof(ssl->transform->randbytes);
5118 if (used <= buf_len) {
5119 memcpy(p, ssl->transform->randbytes,
5120 sizeof(ssl->transform->randbytes));
5121 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005122 }
5123
5124#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005125 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005127 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005129 p += ssl->transform->in_cid_len;
5130
5131 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005133 p += ssl->transform->out_cid_len;
5134 }
5135#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5136
5137 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005138 * Saved fields from top-level ssl_context structure
5139 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005140 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (used <= buf_len) {
5142 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005143 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005144 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005145
5146#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5147 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 if (used <= buf_len) {
5149 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005150 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005151
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005153 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154 }
5155#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5156
5157#if defined(MBEDTLS_SSL_PROTO_DTLS)
5158 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005160 *p++ = ssl->disable_datagram_packing;
5161 }
5162#endif /* MBEDTLS_SSL_PROTO_DTLS */
5163
Jerry Yuae0b2e22021-10-08 15:21:19 +08005164 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (used <= buf_len) {
5166 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005167 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005168 }
5169
5170#if defined(MBEDTLS_SSL_PROTO_DTLS)
5171 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (used <= buf_len) {
5173 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005174 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005175 }
5176#endif /* MBEDTLS_SSL_PROTO_DTLS */
5177
5178#if defined(MBEDTLS_SSL_ALPN)
5179 {
5180 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005182 : 0;
5183
5184 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005186 *p++ = alpn_len;
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (ssl->alpn_chosen != NULL) {
5189 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005190 p += alpn_len;
5191 }
5192 }
5193 }
5194#endif /* MBEDTLS_SSL_ALPN */
5195
5196 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005197 * Done
5198 */
5199 *olen = used;
5200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (used > buf_len) {
5202 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5203 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005208}
5209
5210/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005211 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005212 *
5213 * This internal version is wrapped by a public function that cleans up in
5214 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005215 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005217static int ssl_context_load(mbedtls_ssl_context *ssl,
5218 const unsigned char *buf,
5219 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005220{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005221 const unsigned char *p = buf;
5222 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005223 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005225#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005226 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005227#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005228
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005229 /*
5230 * The context should have been freshly setup or reset.
5231 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005232 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005233 * renegotiating, or if the user mistakenly loaded a session first.)
5234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5236 ssl->session != NULL) {
5237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005238 }
5239
5240 /*
5241 * We can't check that the config matches the initial one, but we can at
5242 * least check it matches the requirements for serializing.
5243 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005244 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005245#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005246 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005247#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005248 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5249 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5250 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5251 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005253 }
5254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005256
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005257 /*
5258 * Check version identifier
5259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5261 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005262 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005263
5264 if (memcmp(p, ssl_serialized_context_header,
5265 sizeof(ssl_serialized_context_header)) != 0) {
5266 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5267 }
5268 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005269
5270 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005271 * Session
5272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if ((size_t) (end - p) < 4) {
5274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5275 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005276
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005277 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005278 p += 4;
5279
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005280 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005281 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005282 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005283 ssl->session_in = ssl->session;
5284 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005285 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if ((size_t) (end - p) < session_len) {
5288 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5289 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 ret = ssl_session_load(ssl->session, 1, p, session_len);
5292 if (ret != 0) {
5293 mbedtls_ssl_session_free(ssl->session);
5294 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005295 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005296
5297 p += session_len;
5298
5299 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005300 * Transform
5301 */
5302
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005303 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005304 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005305#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005306 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005307 ssl->transform_in = ssl->transform;
5308 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005310#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005311
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005312#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5314 if (prf_func == NULL) {
5315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5316 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005317
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005318 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5320 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5321 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005322
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 ret = ssl_tls12_populate_transform(ssl->transform,
5324 ssl->session->ciphersuite,
5325 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005326#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005328#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 prf_func,
5330 p, /* currently pointing to randbytes */
5331 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5332 ssl->conf->endpoint,
5333 ssl);
5334 if (ret != 0) {
5335 return ret;
5336 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005337#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005339
5340#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5341 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 if ((size_t) (end - p) < 1) {
5343 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5344 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005345
5346 ssl->transform->in_cid_len = *p++;
5347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5350 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005351
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005353 p += ssl->transform->in_cid_len;
5354
5355 ssl->transform->out_cid_len = *p++;
5356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5358 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5359 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005362 p += ssl->transform->out_cid_len;
5363#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5364
5365 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005366 * Saved fields from top-level ssl_context structure
5367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 if ((size_t) (end - p) < 4) {
5369 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5370 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005371
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005372 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005373 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005374
5375#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if ((size_t) (end - p) < 16) {
5377 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5378 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005379
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005380 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005381 p += 8;
5382
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005383 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005384 p += 8;
5385#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5386
5387#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if ((size_t) (end - p) < 1) {
5389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5390 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005391
5392 ssl->disable_datagram_packing = *p++;
5393#endif /* MBEDTLS_SSL_PROTO_DTLS */
5394
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5397 }
5398 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5399 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400
5401#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if ((size_t) (end - p) < 2) {
5403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5404 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005405
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005406 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005407 p += 2;
5408#endif /* MBEDTLS_SSL_PROTO_DTLS */
5409
5410#if defined(MBEDTLS_SSL_ALPN)
5411 {
5412 uint8_t alpn_len;
5413 const char **cur;
5414
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if ((size_t) (end - p) < 1) {
5416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5417 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005418
5419 alpn_len = *p++;
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005422 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5424 if (strlen(*cur) == alpn_len &&
5425 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005426 ssl->alpn_chosen = *cur;
5427 break;
5428 }
5429 }
5430 }
5431
5432 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5434 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5435 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005436
5437 p += alpn_len;
5438 }
5439#endif /* MBEDTLS_SSL_ALPN */
5440
5441 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005442 * Forced fields from top-level ssl_context structure
5443 *
5444 * Most of them already set to the correct value by mbedtls_ssl_init() and
5445 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5446 */
5447 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005448 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005449
Hanno Becker361b10d2019-08-30 10:42:49 +01005450 /* Adjust pointers for header fields of outgoing records to
5451 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005453
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005454#if defined(MBEDTLS_SSL_PROTO_DTLS)
5455 ssl->in_epoch = 1;
5456#endif
5457
5458 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5459 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005460 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5461 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 if (ssl->handshake != NULL) {
5463 mbedtls_ssl_handshake_free(ssl);
5464 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005465 ssl->handshake = NULL;
5466 }
5467
5468 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005469 * Done - should have consumed entire buffer
5470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (p != end) {
5472 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5473 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005476}
5477
5478/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005479 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005481int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5482 const unsigned char *buf,
5483 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005484{
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (ret != 0) {
5488 mbedtls_ssl_free(context);
5489 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005492}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005493#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005494
5495/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005496 * Free an SSL context
5497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005499{
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005501 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005507#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5508 size_t out_buf_len = ssl->out_buf_len;
5509#else
5510 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5511#endif
5512
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005513 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005514 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005515 }
5516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005518#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5519 size_t in_buf_len = ssl->in_buf_len;
5520#else
5521 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5522#endif
5523
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005524 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005525 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005526 }
5527
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 if (ssl->transform) {
5529 mbedtls_ssl_transform_free(ssl->transform);
5530 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005531 }
5532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (ssl->handshake) {
5534 mbedtls_ssl_handshake_free(ssl);
5535 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005536
5537#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5539 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005540#endif
5541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 mbedtls_ssl_session_free(ssl->session_negotiate);
5543 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005544 }
5545
Ronald Cron6f135e12021-12-08 16:57:54 +01005546#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 mbedtls_ssl_transform_free(ssl->transform_application);
5548 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005549#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005550
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 if (ssl->session) {
5552 mbedtls_ssl_session_free(ssl->session);
5553 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005554 }
5555
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005556#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005558 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005559 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005560#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005561
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005562#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005564#endif
5565
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005567
Paul Bakker86f04f42013-02-14 11:20:09 +01005568 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005570}
5571
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005572/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005573 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005575void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576{
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005578}
5579
Gilles Peskineae270bf2021-06-02 00:05:29 +02005580/* The selection should be the same as mbedtls_x509_crt_profile_default in
5581 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005582 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005583 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005584 * about this list.
5585 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005586static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005587#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005588 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005589#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005590#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005591 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005592#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005593#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005594 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005595#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005596#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005597 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005598#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005599#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005600 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005601#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005602#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005603 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005604#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005605#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005606 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005607#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005608#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005609 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005610#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005611#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005612 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5613 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5614 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5615 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5616 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5617#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005618 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005619};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005620
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005621static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005622 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5623 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5624 0
5625};
5626
Ronald Crone68ab4f2022-10-05 12:46:29 +02005627#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005628
Jerry Yu909df7b2022-01-22 11:56:27 +08005629/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005630 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005631 * rules SHOULD be upheld.
5632 * - No duplicate entries.
5633 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005634 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005635 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005636 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005637static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005638
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005639#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005640 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005641 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005642 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005643 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5644#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005645
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005646#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005647 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005648 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005649 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005650 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5651#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005652
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005653#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005654 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005655 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005656 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005657 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5658#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005659
Yanray Wang1136fad2023-11-22 16:54:31 +08005660#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005661 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005662#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005663
Yanray Wang1136fad2023-11-22 16:54:31 +08005664#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005665 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005666#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005667
Yanray Wang1136fad2023-11-22 16:54:31 +08005668#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005669 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005670#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005671
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005672#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005673 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005674#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005675
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005676#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005677 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005678#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005679
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005680#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005681 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005682#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005683
Gabor Mezei15b95a62022-05-09 16:37:58 +02005684 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005685};
5686
5687/* NOTICE: see above */
5688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5689static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005690
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005691#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005692#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005694#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005695#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5696 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005697#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005698#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005700#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005701#endif /* MBEDTLS_MD_CAN_SHA512 */
5702
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005703#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005704#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005706#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005707#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5708 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005709#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005710#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005712#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005713#endif /* MBEDTLS_MD_CAN_SHA384 */
5714
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005715#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005716#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005718#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005719#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5720 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005721#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005722#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005724#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005725#endif /* MBEDTLS_MD_CAN_SHA256 */
5726
Gabor Mezei15b95a62022-05-09 16:37:58 +02005727 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005728};
5729#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005730
Jerry Yu909df7b2022-01-22 11:56:27 +08005731/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005732static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005733
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005734#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005735 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005736 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005737 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005738 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5739#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005740
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005741#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005742 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005743 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005744 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005745 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5746#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005747
Gabor Mezei15b95a62022-05-09 16:37:58 +02005748 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005749};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005750
Jerry Yu909df7b2022-01-22 11:56:27 +08005751/* NOTICE: see above */
5752#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5753static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005754
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005755#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005756#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005758#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005759#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005760
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005761#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005762#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005764#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005765#endif /* MBEDTLS_MD_CAN_SHA384 */
5766
Gabor Mezei15b95a62022-05-09 16:37:58 +02005767 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005768};
Jerry Yu909df7b2022-01-22 11:56:27 +08005769#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5770
Ronald Crone68ab4f2022-10-05 12:46:29 +02005771#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005772
Chien Wong4e9683e2023-12-28 17:07:43 +08005773static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005774#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005775 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005776#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005777#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005778 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005779#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005780 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005781};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005782
Ronald Crone68ab4f2022-10-05 12:46:29 +02005783#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005784/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005785 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005786MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005787static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005788{
5789 size_t i, j;
5790 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005791
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5793 for (j = 0; j < i; j++) {
5794 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005795 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 }
5797 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5798 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5799 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005800 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005801 }
5802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005804}
5805
Ronald Crone68ab4f2022-10-05 12:46:29 +02005806#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005807
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005808/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005809 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005811int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5812 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005813{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005814#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005815 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005816#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005817
Ronald Crone68ab4f2022-10-05 12:46:29 +02005818#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5820 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5821 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005822 }
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5825 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5826 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005827 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005828
5829#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5831 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5832 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005833 }
5834
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5836 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5837 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005838 }
5839#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005840#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005841
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005842 /* Use the functions here so that they are covered in tests,
5843 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 mbedtls_ssl_conf_endpoint(conf, endpoint);
5845 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005846
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005847 /*
5848 * Things that are common to all presets
5849 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005850#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005852 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5853#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5854 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5855#endif
5856 }
5857#endif
5858
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005859#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5860 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5861#endif
5862
5863#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5864 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5865#endif
5866
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005867#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005868 conf->f_cookie_write = ssl_cookie_write_dummy;
5869 conf->f_cookie_check = ssl_cookie_check_dummy;
5870#endif
5871
5872#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5873 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5874#endif
5875
Janos Follath088ce432017-04-10 12:42:31 +01005876#if defined(MBEDTLS_SSL_SRV_C)
5877 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005878 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005879#endif
5880
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005881#if defined(MBEDTLS_SSL_PROTO_DTLS)
5882 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5883 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5884#endif
5885
5886#if defined(MBEDTLS_SSL_RENEGOTIATION)
5887 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005888 memset(conf->renego_period, 0x00, 2);
5889 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005890#endif
5891
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005892#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005894 const unsigned char dhm_p[] =
5895 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5896 const unsigned char dhm_g[] =
5897 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005898
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5900 dhm_p, sizeof(dhm_p),
5901 dhm_g, sizeof(dhm_g))) != 0) {
5902 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005903 }
5904 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005905#endif
5906
Ronald Cron6f135e12021-12-08 16:57:54 +01005907#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005908
5909#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005910 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005911#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005912 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005913#endif
5914#endif /* MBEDTLS_SSL_EARLY_DATA */
5915
Jerry Yud0766ec2022-09-22 10:46:57 +08005916#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005917 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005919#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005920 /*
5921 * Allow all TLS 1.3 key exchange modes by default.
5922 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005923 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005924#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005927#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005928 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005929 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005930#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005932#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005934#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005935 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5936 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005937#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5938 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5939 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5940#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5941 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5942 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5943#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005945#endif
5946 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005947
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005948 /*
5949 * Preset-specific defaults
5950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005952 /*
5953 * NSA Suite B
5954 */
5955 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005956
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005957 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005958
5959#if defined(MBEDTLS_X509_CRT_PARSE_C)
5960 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005961#endif
5962
Ronald Crone68ab4f2022-10-05 12:46:29 +02005963#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005966 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005968#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005970#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005971
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005972#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005973 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005974#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005975 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005976 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005977
5978 /*
5979 * Default
5980 */
5981 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005982
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005983 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005984
5985#if defined(MBEDTLS_X509_CRT_PARSE_C)
5986 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5987#endif
5988
Ronald Crone68ab4f2022-10-05 12:46:29 +02005989#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005990#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005992 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005994#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005996#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005997
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005998#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005999 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006001 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006002
6003#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6004 conf->dhm_min_bitlen = 1024;
6005#endif
6006 }
6007
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006009}
6010
6011/*
6012 * Free mbedtls_ssl_config
6013 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006014void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006015{
6016#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 mbedtls_mpi_free(&conf->dhm_P);
6018 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006019#endif
6020
Ronald Cron73fe8df2022-10-05 14:31:43 +02006021#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006022#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006024 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6025 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006026#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006028 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006029 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006030 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006031 }
6032
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006034 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006035 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006036 conf->psk_identity_len = 0;
6037 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006038#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006039
6040#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006042#endif
6043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006045}
6046
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006047#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006048 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006049/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006050 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006052unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006053{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006054#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6056 return MBEDTLS_SSL_SIG_RSA;
6057 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006058#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006059#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6061 return MBEDTLS_SSL_SIG_ECDSA;
6062 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006063#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006065}
6066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006068{
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006070 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006072 case MBEDTLS_PK_ECDSA:
6073 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006075 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006077 }
6078}
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006081{
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006083#if defined(MBEDTLS_RSA_C)
6084 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006086#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006087#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006088 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006090#endif
6091 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006093 }
6094}
Valerio Settie9646ec2023-08-02 20:02:28 +02006095#endif /* MBEDTLS_PK_C &&
6096 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006097
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006098/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006099 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006101mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006102{
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006104#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006105 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006107#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006108#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006109 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006111#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006112#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006113 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006115#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006116#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006117 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006119#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006120#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006121 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006124#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006125 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006127#endif
6128 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006130 }
6131}
6132
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006133/*
6134 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6135 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006136unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006137{
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006139#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006140 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006142#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006143#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006144 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006146#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006147#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006148 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006150#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006151#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006152 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006154#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006155#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006156 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006159#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162#endif
6163 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006165 }
6166}
6167
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006168/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006169 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006170 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006172int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006173{
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (group_list == NULL) {
6177 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006178 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 for (; *group_list != 0; group_list++) {
6181 if (*group_list == tls_id) {
6182 return 0;
6183 }
6184 }
6185
6186 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006187}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006188
Valerio Setti49e69072023-06-27 17:27:51 +02006189#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006190/*
6191 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006193int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006194{
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006198 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006202}
Valerio Setti49e69072023-06-27 17:27:51 +02006203#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006204
Valerio Setti18c9fed2022-12-30 17:44:24 +01006205static const struct {
6206 uint16_t tls_id;
6207 mbedtls_ecp_group_id ecp_group_id;
6208 psa_ecc_family_t psa_family;
6209 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006210} tls_id_match_table[] =
6211{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006212#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006213 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006214#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006215#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006216 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006217#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006218#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006219 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006220#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006221#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006222 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006223#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006224#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006225 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006226#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006227#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006228 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006229#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006230#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006231 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006232#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006233#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006234 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006235#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006236#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006237 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006238#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006239#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006240 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006242#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006243 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006244#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006245#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006246 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006247#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006248#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006251 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006252};
6253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006255 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257{
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6259 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006260 if (type != NULL) {
6261 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 }
6263 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006264 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006266 return PSA_SUCCESS;
6267 }
6268 }
6269
6270 return PSA_ERROR_NOT_SUPPORTED;
6271}
6272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006274{
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6276 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006277 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006279 }
6280
6281 return MBEDTLS_ECP_DP_NONE;
6282}
6283
Gilles Peskine449bd832023-01-11 14:50:10 +01006284uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006285{
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6287 i++) {
6288 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006289 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006291 }
6292
6293 return 0;
6294}
6295
Valerio Setti67419f02023-01-04 16:12:42 +01006296#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006297static const struct {
6298 uint16_t tls_id;
6299 const char *name;
6300} tls_id_curve_name_table[] =
6301{
Valerio Setti54e23792023-07-07 10:49:27 +02006302 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6303 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6304 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6305 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6306 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6307 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6308 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6309 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006315 { 0, NULL },
6316};
6317
Gilles Peskine449bd832023-01-11 14:50:10 +01006318const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006319{
Valerio Settiacd32c02023-06-29 18:06:29 +02006320 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6321 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6322 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006324 }
6325
6326 return NULL;
6327}
Valerio Setti67419f02023-01-04 16:12:42 +01006328#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006330#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006331int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6332 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6333 int cert_endpoint,
6334 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006335{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006336 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006337 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006338 const char *ext_oid;
6339 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006340
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006342 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006343 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006344 case MBEDTLS_KEY_EXCHANGE_RSA:
6345 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006346 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006347 break;
6348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006349 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6350 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6351 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6352 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006353 break;
6354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006355 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6356 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006357 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006358 break;
6359
6360 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006361 case MBEDTLS_KEY_EXCHANGE_NONE:
6362 case MBEDTLS_KEY_EXCHANGE_PSK:
6363 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6364 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006365 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006366 usage = 0;
6367 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006369 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6370 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006371 }
6372
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006374 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006375 ret = -1;
6376 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006377
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006379 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6381 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006382 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006384 }
6385
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006387 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006388 ret = -1;
6389 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006390
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006392}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006393#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006394
Jerry Yu148165c2021-09-24 23:20:59 +08006395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006396int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6397 const mbedtls_md_type_t md,
6398 unsigned char *dst,
6399 size_t dst_len,
6400 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006401{
Ronald Cronf6893e12022-01-07 22:09:01 +01006402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6403 psa_hash_operation_t *hash_operation_to_clone;
6404 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6405
Jerry Yu148165c2021-09-24 23:20:59 +08006406 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006407
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006409#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 case MBEDTLS_MD_SHA384:
6411 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6412 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006413#endif
6414
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006415#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 case MBEDTLS_MD_SHA256:
6417 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6418 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006419#endif
6420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 default:
6422 goto exit;
6423 }
6424
6425 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6426 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006427 goto exit;
6428 }
6429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6431 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006432 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006434
6435exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006436#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6437 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006438 (void) ssl;
6439#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006440 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006441}
6442#else /* MBEDTLS_USE_PSA_CRYPTO */
6443
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006444#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006445MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006446static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6447 unsigned char *dst,
6448 size_t dst_len,
6449 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006450{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006451 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006452 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 if (dst_len < 48) {
6455 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6456 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006457
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006458 mbedtls_md_init(&sha384);
6459 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006460 if (ret != 0) {
6461 goto exit;
6462 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006463 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006464 if (ret != 0) {
6465 goto exit;
6466 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006467
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006468 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006469 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006470 goto exit;
6471 }
6472
6473 *olen = 48;
6474
6475exit:
6476
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006477 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006479}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006480#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006481
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006482#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006483MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006484static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6485 unsigned char *dst,
6486 size_t dst_len,
6487 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006488{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006489 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006490 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006491
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 if (dst_len < 32) {
6493 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6494 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006496 mbedtls_md_init(&sha256);
6497 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6498 if (ret != 0) {
6499 goto exit;
6500 }
6501 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6502 if (ret != 0) {
6503 goto exit;
6504 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006505
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006506 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6507 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006508 goto exit;
6509 }
6510
6511 *olen = 32;
6512
6513exit:
6514
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006515 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006517}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006518#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6521 const mbedtls_md_type_t md,
6522 unsigned char *dst,
6523 size_t dst_len,
6524 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006525{
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006527
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006528#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006529 case MBEDTLS_MD_SHA384:
6530 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006531#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006532
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006533#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 case MBEDTLS_MD_SHA256:
6535 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006536#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006539#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6540 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 (void) ssl;
6542 (void) dst;
6543 (void) dst_len;
6544 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006545#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006547 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006549}
XiaokangQian647719a2021-12-07 09:16:29 +00006550
Jerry Yu148165c2021-09-24 23:20:59 +08006551#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006552
Ronald Crone68ab4f2022-10-05 12:46:29 +02006553#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006554/* mbedtls_ssl_parse_sig_alg_ext()
6555 *
6556 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6557 * value (TLS 1.3 RFC8446):
6558 * enum {
6559 * ....
6560 * ecdsa_secp256r1_sha256( 0x0403 ),
6561 * ecdsa_secp384r1_sha384( 0x0503 ),
6562 * ecdsa_secp521r1_sha512( 0x0603 ),
6563 * ....
6564 * } SignatureScheme;
6565 *
6566 * struct {
6567 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6568 * } SignatureSchemeList;
6569 *
6570 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6571 * value (TLS 1.2 RFC5246):
6572 * enum {
6573 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6574 * sha512(6), (255)
6575 * } HashAlgorithm;
6576 *
6577 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6578 * SignatureAlgorithm;
6579 *
6580 * struct {
6581 * HashAlgorithm hash;
6582 * SignatureAlgorithm signature;
6583 * } SignatureAndHashAlgorithm;
6584 *
6585 * SignatureAndHashAlgorithm
6586 * supported_signature_algorithms<2..2^16-2>;
6587 *
6588 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6589 * generalization of the TLS 1.2 signature algorithm extension.
6590 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6591 * `SignatureScheme` field of TLS 1.3
6592 *
6593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006594int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6595 const unsigned char *buf,
6596 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006597{
6598 const unsigned char *p = buf;
6599 size_t supported_sig_algs_len = 0;
6600 const unsigned char *supported_sig_algs_end;
6601 uint16_t sig_alg;
6602 uint32_t common_idx = 0;
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6605 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006606 p += 2;
6607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 memset(ssl->handshake->received_sig_algs, 0,
6609 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006612 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 while (p < supported_sig_algs_end) {
6614 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6615 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006616 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6618 sig_alg,
6619 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006620#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6622 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6623 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006624 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006625 }
6626#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6629 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006630
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006632 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6633 common_idx += 1;
6634 }
6635 }
6636 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (p != end) {
6638 MBEDTLS_SSL_DEBUG_MSG(1,
6639 ("Signature algorithms extension length misaligned"));
6640 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6641 MBEDTLS_ERR_SSL_DECODE_ERROR);
6642 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006643 }
6644
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 if (common_idx == 0) {
6646 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6647 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6648 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6649 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006650 }
6651
Gabor Mezei15b95a62022-05-09 16:37:58 +02006652 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006654}
6655
Ronald Crone68ab4f2022-10-05 12:46:29 +02006656#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006657
Jerry Yudc7bd172022-02-17 13:44:15 +08006658#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6659
6660#if defined(MBEDTLS_USE_PSA_CRYPTO)
6661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6663 mbedtls_svc_key_id_t key,
6664 psa_algorithm_t alg,
6665 const unsigned char *raw_psk, size_t raw_psk_length,
6666 const unsigned char *seed, size_t seed_length,
6667 const unsigned char *label, size_t label_length,
6668 const unsigned char *other_secret,
6669 size_t other_secret_length,
6670 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006671{
6672 psa_status_t status;
6673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 status = psa_key_derivation_setup(derivation, alg);
6675 if (status != PSA_SUCCESS) {
6676 return status;
6677 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6680 status = psa_key_derivation_input_bytes(derivation,
6681 PSA_KEY_DERIVATION_INPUT_SEED,
6682 seed, seed_length);
6683 if (status != PSA_SUCCESS) {
6684 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006685 }
6686
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (other_secret != NULL) {
6688 status = psa_key_derivation_input_bytes(derivation,
6689 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6690 other_secret, other_secret_length);
6691 if (status != PSA_SUCCESS) {
6692 return status;
6693 }
6694 }
6695
6696 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006697 status = psa_key_derivation_input_bytes(
6698 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 raw_psk, raw_psk_length);
6700 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006701 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006703 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (status != PSA_SUCCESS) {
6705 return status;
6706 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 status = psa_key_derivation_input_bytes(derivation,
6709 PSA_KEY_DERIVATION_INPUT_LABEL,
6710 label, label_length);
6711 if (status != PSA_SUCCESS) {
6712 return status;
6713 }
6714 } else {
6715 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006716 }
6717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 status = psa_key_derivation_set_capacity(derivation, capacity);
6719 if (status != PSA_SUCCESS) {
6720 return status;
6721 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006722
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006724}
6725
Andrzej Kurek57d10632022-10-24 10:32:01 -04006726#if defined(PSA_WANT_ALG_SHA_384) || \
6727 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006728MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006729static int tls_prf_generic(mbedtls_md_type_t md_type,
6730 const unsigned char *secret, size_t slen,
6731 const char *label,
6732 const unsigned char *random, size_t rlen,
6733 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006734{
6735 psa_status_t status;
6736 psa_algorithm_t alg;
6737 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6738 psa_key_derivation_operation_t derivation =
6739 PSA_KEY_DERIVATION_OPERATION_INIT;
6740
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006742 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006746
6747 /* Normally a "secret" should be long enough to be impossible to
6748 * find by brute force, and in particular should not be empty. But
6749 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6750 * and for this use case it makes sense to have a 0-length "secret".
6751 * Since the key API doesn't allow importing a key of length 0,
6752 * keep master_key=0, which setup_psa_key_derivation() understands
6753 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006755 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6757 psa_set_key_algorithm(&key_attributes, alg);
6758 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006759
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6761 if (status != PSA_SUCCESS) {
6762 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6763 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006764 }
6765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 status = setup_psa_key_derivation(&derivation,
6767 master_key, alg,
6768 NULL, 0,
6769 random, rlen,
6770 (unsigned char const *) label,
6771 (size_t) strlen(label),
6772 NULL, 0,
6773 dlen);
6774 if (status != PSA_SUCCESS) {
6775 psa_key_derivation_abort(&derivation);
6776 psa_destroy_key(master_key);
6777 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006778 }
6779
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6781 if (status != PSA_SUCCESS) {
6782 psa_key_derivation_abort(&derivation);
6783 psa_destroy_key(master_key);
6784 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006785 }
6786
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 status = psa_key_derivation_abort(&derivation);
6788 if (status != PSA_SUCCESS) {
6789 psa_destroy_key(master_key);
6790 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006791 }
6792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 if (!mbedtls_svc_key_id_is_null(master_key)) {
6794 status = psa_destroy_key(master_key);
6795 }
6796 if (status != PSA_SUCCESS) {
6797 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6798 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006801}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006802#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006803#else /* MBEDTLS_USE_PSA_CRYPTO */
6804
Andrzej Kurek57d10632022-10-24 10:32:01 -04006805#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006806 (defined(MBEDTLS_MD_CAN_SHA256) || \
6807 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006808MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006809static int tls_prf_generic(mbedtls_md_type_t md_type,
6810 const unsigned char *secret, size_t slen,
6811 const char *label,
6812 const unsigned char *random, size_t rlen,
6813 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006814{
6815 size_t nb;
6816 size_t i, j, k, md_len;
6817 unsigned char *tmp;
6818 size_t tmp_len = 0;
6819 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6820 const mbedtls_md_info_t *md_info;
6821 mbedtls_md_context_t md_ctx;
6822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6827 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6828 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 tmp_len = md_len + strlen(label) + rlen;
6833 tmp = mbedtls_calloc(1, tmp_len);
6834 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006835 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6836 goto exit;
6837 }
6838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 nb = strlen(label);
6840 memcpy(tmp + md_len, label, nb);
6841 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006842 nb += rlen;
6843
6844 /*
6845 * Compute P_<hash>(secret, label + random)[0..dlen]
6846 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006848 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6852 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006853 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 }
6855 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6856 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006857 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 }
6859 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6860 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006861 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 for (i = 0; i < dlen; i += md_len) {
6865 ret = mbedtls_md_hmac_reset(&md_ctx);
6866 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006867 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 }
6869 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6870 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006871 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 }
6873 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6874 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006875 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 ret = mbedtls_md_hmac_reset(&md_ctx);
6879 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006880 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 }
6882 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6883 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 }
6886 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6887 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006888 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006894 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006896 }
6897
6898exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (tmp != NULL) {
6902 mbedtls_platform_zeroize(tmp, tmp_len);
6903 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006910}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006911#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006912#endif /* MBEDTLS_USE_PSA_CRYPTO */
6913
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006914#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006915MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006916static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6917 const char *label,
6918 const unsigned char *random, size_t rlen,
6919 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006920{
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6922 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006923}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006924#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006925
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006926#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006927MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006928static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6929 const char *label,
6930 const unsigned char *random, size_t rlen,
6931 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006932{
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6934 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006935}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006936#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006937
Jerry Yuf009d862022-02-17 14:01:37 +08006938/*
6939 * Set appropriate PRF function and other SSL / TLS1.2 functions
6940 *
6941 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006942 * - hash associated with the ciphersuite (only used by TLS 1.2)
6943 *
6944 * Outputs:
6945 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6946 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006947MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006948static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6949 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006950{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006951#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006953 handshake->tls_prf = tls_prf_sha384;
6954 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6955 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006957#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006958#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006959 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006960 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006961 handshake->tls_prf = tls_prf_sha256;
6962 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6963 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6964 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006965#else
Jerry Yuf009d862022-02-17 14:01:37 +08006966 {
Jerry Yuf009d862022-02-17 14:01:37 +08006967 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006968 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006970 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006971#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006974}
Jerry Yud6ab2352022-02-17 14:03:43 +08006975
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006976/*
6977 * Compute master secret if needed
6978 *
6979 * Parameters:
6980 * [in/out] handshake
6981 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6982 * (PSA-PSK) ciphersuite_info, psk_opaque
6983 * [out] premaster (cleared)
6984 * [out] master
6985 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6986 * debug: conf->f_dbg, conf->p_dbg
6987 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006988 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006989 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006990MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006991static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6992 unsigned char *master,
6993 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006994{
6995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6996
6997 /* cf. RFC 5246, Section 8.1:
6998 * "The master secret is always exactly 48 bytes in length." */
6999 size_t const master_secret_len = 48;
7000
7001#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7002 unsigned char session_hash[48];
7003#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7004
7005 /* The label for the KDF used for key expansion.
7006 * This is either "master secret" or "extended master secret"
7007 * depending on whether the Extended Master Secret extension
7008 * is used. */
7009 char const *lbl = "master secret";
7010
Przemek Stekielae4ed302022-04-05 17:15:55 +02007011 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007012 * - If the Extended Master Secret extension is not used,
7013 * this is ClientHello.Random + ServerHello.Random
7014 * (see Sect. 8.1 in RFC 5246).
7015 * - If the Extended Master Secret extension is used,
7016 * this is the transcript of the handshake so far.
7017 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007018 unsigned char const *seed = handshake->randbytes;
7019 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007020
7021#if !defined(MBEDTLS_DEBUG_C) && \
7022 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7023 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007025 ssl = NULL; /* make sure we don't use it except for those cases */
7026 (void) ssl;
7027#endif
7028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (handshake->resume != 0) {
7030 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7031 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007032 }
7033
7034#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007036 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007037 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007038 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7039 if (ret != 0) {
7040 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7041 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7044 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007046#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007047
Przemek Stekiel99114f32022-04-22 11:20:09 +02007048#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007049 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007051 /* Perform PSK-to-MS expansion in a single step. */
7052 psa_status_t status;
7053 psa_algorithm_t alg;
7054 mbedtls_svc_key_id_t psk;
7055 psa_key_derivation_operation_t derivation =
7056 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007057 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007066 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007068
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007069 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007073 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007074 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007075 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007076 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007077 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007078 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007079 other_secret_len = 48;
7080 other_secret = handshake->premaster + 2;
7081 break;
7082 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007083 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007084 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7085 other_secret = handshake->premaster + 2;
7086 break;
7087 default:
7088 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007089 }
7090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 status = setup_psa_key_derivation(&derivation, psk, alg,
7092 ssl->conf->psk, ssl->conf->psk_len,
7093 seed, seed_len,
7094 (unsigned char const *) lbl,
7095 (size_t) strlen(lbl),
7096 other_secret, other_secret_len,
7097 master_secret_len);
7098 if (status != PSA_SUCCESS) {
7099 psa_key_derivation_abort(&derivation);
7100 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007101 }
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 status = psa_key_derivation_output_bytes(&derivation,
7104 master,
7105 master_secret_len);
7106 if (status != PSA_SUCCESS) {
7107 psa_key_derivation_abort(&derivation);
7108 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007109 }
7110
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 status = psa_key_derivation_abort(&derivation);
7112 if (status != PSA_SUCCESS) {
7113 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7114 }
7115 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007116#endif
7117 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007118#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7120 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007121 psa_status_t status;
7122 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7123 psa_key_derivation_operation_t derivation =
7124 PSA_KEY_DERIVATION_OPERATION_INIT;
7125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007127
7128 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 status = psa_key_derivation_setup(&derivation, alg);
7131 if (status != PSA_SUCCESS) {
7132 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007133 }
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 status = psa_key_derivation_set_capacity(&derivation,
7136 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7137 if (status != PSA_SUCCESS) {
7138 psa_key_derivation_abort(&derivation);
7139 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007140 }
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7143 &derivation);
7144 if (status != PSA_SUCCESS) {
7145 psa_key_derivation_abort(&derivation);
7146 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007147 }
7148
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 status = psa_key_derivation_output_bytes(&derivation,
7150 handshake->premaster,
7151 handshake->pmslen);
7152 if (status != PSA_SUCCESS) {
7153 psa_key_derivation_abort(&derivation);
7154 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7155 }
7156
7157 status = psa_key_derivation_abort(&derivation);
7158 if (status != PSA_SUCCESS) {
7159 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007160 }
7161 }
7162#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7164 lbl, seed, seed_len,
7165 master,
7166 master_secret_len);
7167 if (ret != 0) {
7168 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7169 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007170 }
7171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7173 handshake->premaster,
7174 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 mbedtls_platform_zeroize(handshake->premaster,
7177 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007178 }
7179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007181}
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007184{
7185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7186 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7187 ssl->handshake->ciphersuite_info;
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007190
7191 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007193 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 if (ret != 0) {
7195 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7196 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007197 }
7198
7199 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 ret = ssl_compute_master(ssl->handshake,
7201 ssl->session_negotiate->master,
7202 ssl);
7203 if (ret != 0) {
7204 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7205 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007206 }
7207
7208 /* Swap the client and server random values:
7209 * - MS derivation wanted client+server (RFC 5246 8.1)
7210 * - key derivation wants server+client (RFC 5246 6.3) */
7211 {
7212 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 memcpy(tmp, ssl->handshake->randbytes, 64);
7214 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7215 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7216 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007217 }
7218
7219 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7221 ssl->session_negotiate->ciphersuite,
7222 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007223#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007225#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 ssl->handshake->tls_prf,
7227 ssl->handshake->randbytes,
7228 ssl->tls_version,
7229 ssl->conf->endpoint,
7230 ssl);
7231 if (ret != 0) {
7232 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7233 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007234 }
7235
7236 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7238 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007239
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007241
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007243}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007244
Gilles Peskine449bd832023-01-11 14:50:10 +01007245int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007246{
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007248#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007249 case MBEDTLS_SSL_HASH_SHA384:
7250 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7251 break;
7252#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007253#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007254 case MBEDTLS_SSL_HASH_SHA256:
7255 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7256 break;
7257#endif
7258 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007260 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007261#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7262 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007263 (void) ssl;
7264#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007266}
7267
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007268#if defined(MBEDTLS_USE_PSA_CRYPTO)
7269static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7270 const psa_hash_operation_t *hs_op,
7271 size_t buffer_size,
7272 unsigned char *hash,
7273 size_t *hlen)
7274{
7275 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007276 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007277
7278#if !defined(MBEDTLS_DEBUG_C)
7279 (void) ssl;
7280#endif
7281 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007282 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007283 if (status != PSA_SUCCESS) {
7284 goto exit;
7285 }
7286
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007287 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007288 if (status != PSA_SUCCESS) {
7289 goto exit;
7290 }
7291
7292 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7293 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7294
7295exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007296 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007297 return mbedtls_md_error_from_psa(status);
7298}
7299#else
7300static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7301 const mbedtls_md_context_t *hs_ctx,
7302 unsigned char *hash,
7303 size_t *hlen)
7304{
7305 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007306 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007307
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007308 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007309
7310#if !defined(MBEDTLS_DEBUG_C)
7311 (void) ssl;
7312#endif
7313 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7314
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007315 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007316 if (ret != 0) {
7317 goto exit;
7318 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007319 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007320 if (ret != 0) {
7321 goto exit;
7322 }
7323
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007324 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007325 if (ret != 0) {
7326 goto exit;
7327 }
7328
7329 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7330
7331 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7332 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7333
7334exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007335 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007336 return ret;
7337}
7338#endif /* MBEDTLS_USE_PSA_CRYPTO */
7339
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007340#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007341int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7342 unsigned char *hash,
7343 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007344{
7345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007346 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7347 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007348#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007349 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7350 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007351#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007352}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007353#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007354
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007355#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007356int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7357 unsigned char *hash,
7358 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007359{
7360#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007361 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7362 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007363#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007364 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7365 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007366#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007367}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007368#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007369
Neil Armstrong80f6f322022-05-03 17:56:38 +02007370#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7371 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007372int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007373{
7374 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007376 const unsigned char *psk = NULL;
7377 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007381 /*
7382 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007383 * checked before calling this function.
7384 *
7385 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007386 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007387 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7389 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7390 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007391 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007392 }
7393
7394 /*
7395 * PMS = struct {
7396 * opaque other_secret<0..2^16-1>;
7397 * opaque psk<0..2^16-1>;
7398 * };
7399 * with "other_secret" depending on the particular key exchange
7400 */
7401#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7403 if (end - p < 2) {
7404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7405 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007408 p += 2;
7409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 if (end < p || (size_t) (end - p) < psk_len) {
7411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7412 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007413
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007415 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007417#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7418#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007420 /*
7421 * other_secret already set by the ClientKeyExchange message,
7422 * and is 48 bytes long
7423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (end - p < 2) {
7425 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7426 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007427
7428 *p++ = 0;
7429 *p++ = 48;
7430 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007432#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7433#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7436 size_t len;
7437
7438 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007440 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7442 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7443 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007444 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007446 p += 2 + len;
7447
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7449 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007450#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007451#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007453 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7454 size_t zlen;
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007457 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7459 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7460 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007461 }
7462
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007464 p += 2 + zlen;
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7467 MBEDTLS_DEBUG_ECDH_Z);
7468 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007469#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007470 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007473 }
7474
7475 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if (end - p < 2) {
7477 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7478 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007479
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007481 p += 2;
7482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (end < p || (size_t) (end - p) < psk_len) {
7484 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7485 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007486
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007488 p += psk_len;
7489
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007490 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007493}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007494#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007495
7496#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007497MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007498static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007499
7500#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007501int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007502{
7503 /* If renegotiation is not enforced, retransmit until we would reach max
7504 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007506 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7507 unsigned char doublings = 1;
7508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007510 ++doublings;
7511 ratio >>= 1;
7512 }
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (++ssl->renego_records_seen > doublings) {
7515 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7516 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007517 }
7518 }
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007521}
7522#endif
7523#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007524
Jerry Yud9526692022-02-17 14:23:47 +08007525/*
7526 * Handshake functions
7527 */
7528#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7529/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007530int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007531{
7532 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7533 ssl->handshake->ciphersuite_info;
7534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7538 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007539 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007541 }
7542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7544 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007545}
7546
Gilles Peskine449bd832023-01-11 14:50:10 +01007547int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007548{
7549 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7550 ssl->handshake->ciphersuite_info;
7551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7555 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007556 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007558 }
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7561 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007562}
7563
7564#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7565/* Some certificate support -> implement write and parse */
7566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007568{
7569 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7570 size_t i, n;
7571 const mbedtls_x509_crt *crt;
7572 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7573 ssl->handshake->ciphersuite_info;
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7578 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007579 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007581 }
7582
7583#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7585 if (ssl->handshake->client_auth == 0) {
7586 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007587 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007589 }
7590 }
7591#endif /* MBEDTLS_SSL_CLI_C */
7592#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7594 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007595 /* Should never happen because we shouldn't have picked the
7596 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007598 }
7599 }
7600#endif
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007603
7604 /*
7605 * 0 . 0 handshake type
7606 * 1 . 3 handshake length
7607 * 4 . 6 length of all certs
7608 * 7 . 9 length of cert. 1
7609 * 10 . n-1 peer certificate
7610 * n . n+2 length of cert. 2
7611 * n+3 . ... upper level cert, etc.
7612 */
7613 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007617 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7619 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7620 " > %" MBEDTLS_PRINTF_SIZET,
7621 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7622 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007623 }
7624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7626 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7627 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007630 i += n; crt = crt->next;
7631 }
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7634 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7635 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007636
7637 ssl->out_msglen = i;
7638 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7639 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7640
7641 ssl->state++;
7642
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7644 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7645 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007646 }
7647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007651}
7652
7653#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7654
7655#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007656MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007657static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7658 unsigned char *crt_buf,
7659 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007660{
7661 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7662
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 if (peer_crt == NULL) {
7664 return -1;
7665 }
Jerry Yud9526692022-02-17 14:23:47 +08007666
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 if (peer_crt->raw.len != crt_buf_len) {
7668 return -1;
7669 }
Jerry Yud9526692022-02-17 14:23:47 +08007670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007672}
7673#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007674MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007675static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7676 unsigned char *crt_buf,
7677 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007678{
7679 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7680 unsigned char const * const peer_cert_digest =
7681 ssl->session->peer_cert_digest;
7682 mbedtls_md_type_t const peer_cert_digest_type =
7683 ssl->session->peer_cert_digest_type;
7684 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007686 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7687 size_t digest_len;
7688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 if (peer_cert_digest == NULL || digest_info == NULL) {
7690 return -1;
7691 }
Jerry Yud9526692022-02-17 14:23:47 +08007692
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 digest_len = mbedtls_md_get_size(digest_info);
7694 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7695 return -1;
7696 }
Jerry Yud9526692022-02-17 14:23:47 +08007697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7699 if (ret != 0) {
7700 return -1;
7701 }
Jerry Yud9526692022-02-17 14:23:47 +08007702
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007704}
7705#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7706#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7707
7708/*
7709 * Once the certificate message is read, parse it into a cert chain and
7710 * perform basic checks, but leave actual verification to the caller
7711 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007713static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7714 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007715{
7716 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7717#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007719#endif
7720 size_t i, n;
7721 uint8_t alert;
7722
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7724 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7725 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7726 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7727 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007728 }
7729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7731 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7732 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7733 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007734 }
7735
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7737 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7738 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7739 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7740 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007741 }
7742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007744
7745 /*
7746 * Same message structure as in mbedtls_ssl_write_certificate()
7747 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007748 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007749
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 if (ssl->in_msg[i] != 0 ||
7751 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7752 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7753 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7754 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7755 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007756 }
7757
7758 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7759 i += 3;
7760
7761 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007763 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 if (i + 3 > ssl->in_hslen) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7766 mbedtls_ssl_send_alert_message(ssl,
7767 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7768 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7769 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007770 }
7771 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7772 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 if (ssl->in_msg[i] != 0) {
7774 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7775 mbedtls_ssl_send_alert_message(ssl,
7776 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7777 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7778 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007779 }
7780
7781 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007782 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007783 i += 3;
7784
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 if (n < 128 || i + n > ssl->in_hslen) {
7786 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7787 mbedtls_ssl_send_alert_message(ssl,
7788 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7789 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7790 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007791 }
7792
7793 /* Check if we're handling the first CRT in the chain. */
7794#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007796 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007798 /* During client-side renegotiation, check that the server's
7799 * end-CRTs hasn't changed compared to the initial handshake,
7800 * mitigating the triple handshake attack. On success, reuse
7801 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7803 if (ssl_check_peer_crt_unchanged(ssl,
7804 &ssl->in_msg[i],
7805 n) != 0) {
7806 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7807 mbedtls_ssl_send_alert_message(ssl,
7808 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7809 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7810 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007811 }
7812
7813 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007815 }
7816#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7817
7818 /* Parse the next certificate in the chain. */
7819#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007821#else
7822 /* If we don't need to store the CRT chain permanently, parse
7823 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007825#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007827 case 0: /*ok*/
7828 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7829 /* Ignore certificate with an unknown algorithm: maybe a
7830 prior certificate was already trusted. */
7831 break;
7832
7833 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7834 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7835 goto crt_parse_der_failed;
7836
7837 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7838 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7839 goto crt_parse_der_failed;
7840
7841 default:
7842 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007843crt_parse_der_failed:
7844 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7845 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7846 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007847 }
7848
7849 i += n;
7850 }
7851
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7853 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007854}
7855
7856#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007857MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007858static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007859{
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7861 return -1;
7862 }
Jerry Yud9526692022-02-17 14:23:47 +08007863
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007865 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7866 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7868 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7869 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007872}
7873#endif /* MBEDTLS_SSL_SRV_C */
7874
7875/* Check if a certificate message is expected.
7876 * Return either
7877 * - SSL_CERTIFICATE_EXPECTED, or
7878 * - SSL_CERTIFICATE_SKIP
7879 * indicating whether a Certificate message is expected or not.
7880 */
7881#define SSL_CERTIFICATE_EXPECTED 0
7882#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007883MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007884static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7885 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007886{
7887 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7888 ssl->handshake->ciphersuite_info;
7889
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7891 return SSL_CERTIFICATE_SKIP;
7892 }
Jerry Yud9526692022-02-17 14:23:47 +08007893
7894#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7896 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7897 return SSL_CERTIFICATE_SKIP;
7898 }
Jerry Yud9526692022-02-17 14:23:47 +08007899
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007901 ssl->session_negotiate->verify_result =
7902 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007904 }
7905 }
7906#else
7907 ((void) authmode);
7908#endif /* MBEDTLS_SSL_SRV_C */
7909
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007911}
7912
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007914static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7915 int authmode,
7916 mbedtls_x509_crt *chain,
7917 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007918{
7919 int ret = 0;
7920 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7921 ssl->handshake->ciphersuite_info;
7922 int have_ca_chain = 0;
7923
7924 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7925 void *p_vrfy;
7926
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7928 return 0;
7929 }
Jerry Yud9526692022-02-17 14:23:47 +08007930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (ssl->f_vrfy != NULL) {
7932 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007933 f_vrfy = ssl->f_vrfy;
7934 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 } else {
7936 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007937 f_vrfy = ssl->conf->f_vrfy;
7938 p_vrfy = ssl->conf->p_vrfy;
7939 }
7940
7941 /*
7942 * Main check: verify certificate
7943 */
7944#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007946 ((void) rs_ctx);
7947 have_ca_chain = 1;
7948
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007950 ret = mbedtls_x509_crt_verify_with_ca_cb(
7951 chain,
7952 ssl->conf->f_ca_cb,
7953 ssl->conf->p_ca_cb,
7954 ssl->conf->cert_profile,
7955 ssl->hostname,
7956 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 f_vrfy, p_vrfy);
7958 } else
Jerry Yud9526692022-02-17 14:23:47 +08007959#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7960 {
7961 mbedtls_x509_crt *ca_chain;
7962 mbedtls_x509_crl *ca_crl;
7963
7964#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007966 ca_chain = ssl->handshake->sni_ca_chain;
7967 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 } else
Jerry Yud9526692022-02-17 14:23:47 +08007969#endif
7970 {
7971 ca_chain = ssl->conf->ca_chain;
7972 ca_crl = ssl->conf->ca_crl;
7973 }
7974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007976 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 }
Jerry Yud9526692022-02-17 14:23:47 +08007978
7979 ret = mbedtls_x509_crt_verify_restartable(
7980 chain,
7981 ca_chain, ca_crl,
7982 ssl->conf->cert_profile,
7983 ssl->hostname,
7984 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007986 }
7987
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 if (ret != 0) {
7989 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007990 }
7991
7992#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7994 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7995 }
Jerry Yud9526692022-02-17 14:23:47 +08007996#endif
7997
7998 /*
7999 * Secondary checks: always done, but change 'ret' only if it was 0
8000 */
8001
Valerio Settiacd32c02023-06-29 18:06:29 +02008002#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08008003 {
8004 const mbedtls_pk_context *pk = &chain->pk;
8005
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008006 /* If certificate uses an EC key, make sure the curve is OK.
8007 * This is a public key, so it can't be opaque, so can_do() is a good
8008 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008010 /* and in the unlikely case the above assumption no longer holds
8011 * we are making sure that pk_ec() here does not return a NULL
8012 */
Valerio Settif9362b72023-11-29 08:42:27 +01008013 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008014 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8015 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008017 }
Valerio Setti97207782023-05-18 18:59:06 +02008018 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008019 ssl->session_negotiate->verify_result |=
8020 MBEDTLS_X509_BADCERT_BAD_KEY;
8021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8023 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008024 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008026 }
Jerry Yud9526692022-02-17 14:23:47 +08008027 }
8028 }
Valerio Settiacd32c02023-06-29 18:06:29 +02008029#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08008030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 if (mbedtls_ssl_check_cert_usage(chain,
8032 ciphersuite_info,
8033 !ssl->conf->endpoint,
8034 &ssl->session_negotiate->verify_result) != 0) {
8035 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8036 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008037 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 }
Jerry Yud9526692022-02-17 14:23:47 +08008039 }
8040
8041 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8042 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8043 * with details encoded in the verification flags. All other kinds
8044 * of error codes, including those from the user provided f_vrfy
8045 * functions, are treated as fatal and lead to a failure of
8046 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8048 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8049 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008050 ret = 0;
8051 }
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8054 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008055 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8056 }
8057
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008059 uint8_t alert;
8060
8061 /* The certificate may have been rejected for several reasons.
8062 Pick one and send the corresponding alert. Which alert to send
8063 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008065 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008067 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008069 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008071 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008073 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008075 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008077 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008079 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008083 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008085 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 }
8087 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8088 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008089 }
8090
8091#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 if (ssl->session_negotiate->verify_result != 0) {
8093 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8094 (unsigned int) ssl->session_negotiate->verify_result));
8095 } else {
8096 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008097 }
8098#endif /* MBEDTLS_DEBUG_C */
8099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008101}
8102
8103#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008104MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008105static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8106 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008107{
8108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8109 /* Remember digest of the peer's end-CRT. */
8110 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8112 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8113 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8114 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8115 mbedtls_ssl_send_alert_message(ssl,
8116 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8117 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008118
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008120 }
8121
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 ret = mbedtls_md(mbedtls_md_info_from_type(
8123 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8124 start, len,
8125 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008126
8127 ssl->session_negotiate->peer_cert_digest_type =
8128 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8129 ssl->session_negotiate->peer_cert_digest_len =
8130 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8131
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008133}
8134
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008135MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008136static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8137 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008138{
8139 unsigned char *end = start + len;
8140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8141
8142 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8144 ret = mbedtls_pk_parse_subpubkey(&start, end,
8145 &ssl->handshake->peer_pubkey);
8146 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008147 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008149 }
8150
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008152}
8153#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8154
Gilles Peskine449bd832023-01-11 14:50:10 +01008155int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008156{
8157 int ret = 0;
8158 int crt_expected;
8159#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8160 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8161 ? ssl->handshake->sni_authmode
8162 : ssl->conf->authmode;
8163#else
8164 const int authmode = ssl->conf->authmode;
8165#endif
8166 void *rs_ctx = NULL;
8167 mbedtls_x509_crt *chain = NULL;
8168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008170
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8172 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8173 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008174 goto exit;
8175 }
8176
8177#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 if (ssl->handshake->ecrs_enabled &&
8179 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008180 chain = ssl->handshake->ecrs_peer_cert;
8181 ssl->handshake->ecrs_peer_cert = NULL;
8182 goto crt_verify;
8183 }
8184#endif
8185
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008187 /* mbedtls_ssl_read_record may have sent an alert already. We
8188 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008190 goto exit;
8191 }
8192
8193#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008195 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8196
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008198 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 }
Jerry Yud9526692022-02-17 14:23:47 +08008200
8201 goto exit;
8202 }
8203#endif /* MBEDTLS_SSL_SRV_C */
8204
8205 /* Clear existing peer CRT structure in case we tried to
8206 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008208
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8210 if (chain == NULL) {
8211 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8212 sizeof(mbedtls_x509_crt)));
8213 mbedtls_ssl_send_alert_message(ssl,
8214 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8215 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008216
8217 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8218 goto exit;
8219 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008221
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 ret = ssl_parse_certificate_chain(ssl, chain);
8223 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 }
Jerry Yud9526692022-02-17 14:23:47 +08008226
8227#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008229 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 }
Jerry Yud9526692022-02-17 14:23:47 +08008231
8232crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008234 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 }
Jerry Yud9526692022-02-17 14:23:47 +08008236#endif
8237
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 ret = ssl_parse_certificate_verify(ssl, authmode,
8239 chain, rs_ctx);
8240 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 }
Jerry Yud9526692022-02-17 14:23:47 +08008243
8244#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8245 {
8246 unsigned char *crt_start, *pk_start;
8247 size_t crt_len, pk_len;
8248
8249 /* We parse the CRT chain without copying, so
8250 * these pointers point into the input buffer,
8251 * and are hence still valid after freeing the
8252 * CRT chain. */
8253
8254 crt_start = chain->raw.p;
8255 crt_len = chain->raw.len;
8256
8257 pk_start = chain->pk_raw.p;
8258 pk_len = chain->pk_raw.len;
8259
8260 /* Free the CRT structures before computing
8261 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008262 mbedtls_x509_crt_free(chain);
8263 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008264 chain = NULL;
8265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8267 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 }
Jerry Yud9526692022-02-17 14:23:47 +08008270
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8272 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 }
Jerry Yud9526692022-02-17 14:23:47 +08008275 }
8276#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8277 /* Pass ownership to session structure. */
8278 ssl->session_negotiate->peer_cert = chain;
8279 chain = NULL;
8280#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8281
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008283
8284exit:
8285
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008287 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 }
Jerry Yud9526692022-02-17 14:23:47 +08008289
8290#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008292 ssl->handshake->ecrs_peer_cert = chain;
8293 chain = NULL;
8294 }
8295#endif
8296
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (chain != NULL) {
8298 mbedtls_x509_crt_free(chain);
8299 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008300 }
8301
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008303}
8304#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8305
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008306static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8307 unsigned char *padbuf, size_t hlen,
8308 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008309{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008310 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008311 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008312#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008313 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008314 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008315 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008316 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008317#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008319 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008320 mbedtls_md_context_t cloned_ctx;
8321 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008322#endif
8323
8324 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008325 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008326 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008328
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008330 ? "client finished"
8331 : "server finished";
8332
8333#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008334 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008335
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008336 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008338 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008339 }
8340
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008341 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008343 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008344 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008345 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008346#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008347 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008348
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008349 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008350 if (ret != 0) {
8351 goto exit;
8352 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008353 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008354 if (ret != 0) {
8355 goto exit;
8356 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008357
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008358 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008359 if (ret != 0) {
8360 goto exit;
8361 }
8362#endif /* MBEDTLS_USE_PSA_CRYPTO */
8363
8364 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8365
Jerry Yu615bd6f2022-02-17 14:25:15 +08008366 /*
8367 * TLSv1.2:
8368 * hash = PRF( master, finished_label,
8369 * Hash( handshake ) )[0.11]
8370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008372 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008373
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008375
Paul Elliottecb95be2023-08-11 16:41:04 +01008376 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008377
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008378 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008379
8380exit:
8381#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008382 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008383 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008384#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008385 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008386 return ret;
8387#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008388}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008389
8390#if defined(MBEDTLS_MD_CAN_SHA256)
8391static int ssl_calc_finished_tls_sha256(
8392 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8393{
8394 unsigned char padbuf[32];
8395 return ssl_calc_finished_tls_generic(ssl,
8396#if defined(MBEDTLS_USE_PSA_CRYPTO)
8397 &ssl->handshake->fin_sha256_psa,
8398#else
8399 &ssl->handshake->fin_sha256,
8400#endif
8401 padbuf, sizeof(padbuf),
8402 buf, from);
8403}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008404#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008405
Jerry Yub7ba49e2022-02-17 14:25:53 +08008406
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008407#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008408static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008410{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008411 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008412 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008413#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008414 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008415#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008416 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008417#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008418 padbuf, sizeof(padbuf),
8419 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008420}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008421#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008422
Gilles Peskine449bd832023-01-11 14:50:10 +01008423void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008424{
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008426
8427 /*
8428 * Free our handshake params
8429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 mbedtls_ssl_handshake_free(ssl);
8431 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008432 ssl->handshake = NULL;
8433
8434 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008435 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 if (ssl->transform) {
8438 mbedtls_ssl_transform_free(ssl->transform);
8439 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008440 }
8441 ssl->transform = ssl->transform_negotiate;
8442 ssl->transform_negotiate = NULL;
8443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008445}
8446
Gilles Peskine449bd832023-01-11 14:50:10 +01008447void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008448{
8449 int resume = ssl->handshake->resume;
8450
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008452
8453#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008455 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8456 ssl->renego_records_seen = 0;
8457 }
8458#endif
8459
8460 /*
8461 * Free the previous session and switch in the current one
8462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008464#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8465 /* RFC 7366 3.1: keep the EtM state */
8466 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008468#endif
8469
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 mbedtls_ssl_session_free(ssl->session);
8471 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008472 }
8473 ssl->session = ssl->session_negotiate;
8474 ssl->session_negotiate = NULL;
8475
8476 /*
8477 * Add cache entry
8478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008480 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 resume == 0) {
8482 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8483 ssl->session->id,
8484 ssl->session->id_len,
8485 ssl->session) != 0) {
8486 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8487 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008488 }
8489
8490#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8492 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008493 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008495
8496 /* Keep last flight around in case we need to resend it:
8497 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8499 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008500#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008502
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008503 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008504
Gilles Peskine449bd832023-01-11 14:50:10 +01008505 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008506}
8507
Gilles Peskine449bd832023-01-11 14:50:10 +01008508int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008509{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008510 int ret;
8511 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008512
Gilles Peskine449bd832023-01-11 14:50:10 +01008513 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008514
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008516
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008517 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8518 if (ret != 0) {
8519 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8520 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008521
8522 /*
8523 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8524 * may define some other value. Currently (early 2016), no defined
8525 * ciphersuite does this (and this is unlikely to change as activity has
8526 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8527 */
8528 hash_len = 12;
8529
8530#if defined(MBEDTLS_SSL_RENEGOTIATION)
8531 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008533#endif
8534
8535 ssl->out_msglen = 4 + hash_len;
8536 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8537 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8538
8539 /*
8540 * In case of session resuming, invert the client and server
8541 * ChangeCipherSpec messages order.
8542 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008544#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008546 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008548#endif
8549#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008551 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008553#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008555 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008557
8558 /*
8559 * Switch to our negotiated transform and session parameters for outbound
8560 * data.
8561 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008563
8564#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008566 unsigned char i;
8567
8568 /* Remember current epoch settings for resending */
8569 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8571 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008572
8573 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008575
8576
8577 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 for (i = 2; i > 0; i--) {
8579 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008580 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 }
8582 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008583
8584 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 if (i == 0) {
8586 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8587 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008590#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008592
8593 ssl->transform_out = ssl->transform_negotiate;
8594 ssl->session_out = ssl->session_negotiate;
8595
8596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8598 mbedtls_ssl_send_flight_completed(ssl);
8599 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008600#endif
8601
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8603 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8604 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008605 }
8606
8607#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8609 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8610 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8611 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008612 }
8613#endif
8614
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008616
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008618}
8619
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008620#define SSL_MAX_HASH_LEN 12
8621
Gilles Peskine449bd832023-01-11 14:50:10 +01008622int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008623{
8624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8625 unsigned int hash_len = 12;
8626 unsigned char buf[SSL_MAX_HASH_LEN];
8627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008629
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008630 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8631 if (ret != 0) {
8632 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8633 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008634
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8636 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008637 goto exit;
8638 }
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8641 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8642 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8643 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008644 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8645 goto exit;
8646 }
8647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8649 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8650 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008651 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8652 goto exit;
8653 }
8654
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8656 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8657 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8658 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008659 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8660 goto exit;
8661 }
8662
Gilles Peskine449bd832023-01-11 14:50:10 +01008663 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8664 buf, hash_len) != 0) {
8665 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8666 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8667 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008668 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8669 goto exit;
8670 }
8671
8672#if defined(MBEDTLS_SSL_RENEGOTIATION)
8673 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008674 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008675#endif
8676
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008678#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008680 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008682#endif
8683#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008685 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008687#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008689 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008691
8692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8694 mbedtls_ssl_recv_flight_completed(ssl);
8695 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008696#endif
8697
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008699
8700exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 mbedtls_platform_zeroize(buf, hash_len);
8702 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008703}
8704
Jerry Yu392112c2022-02-17 14:34:10 +08008705#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8706/*
8707 * Helper to get TLS 1.2 PRF from ciphersuite
8708 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008710static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008711{
Jerry Yu392112c2022-02-17 14:34:10 +08008712 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008714#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8716 return tls_prf_sha384;
8717 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008718#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008719#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008720 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8722 return tls_prf_sha256;
8723 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008724 }
8725#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008726#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8727 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008728 (void) ciphersuite_info;
8729#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008730
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008732}
8733#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008734
Gilles Peskine449bd832023-01-11 14:50:10 +01008735static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008736{
8737 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008738#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 if (tls_prf == tls_prf_sha384) {
8740 return MBEDTLS_SSL_TLS_PRF_SHA384;
8741 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008742#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008743#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 if (tls_prf == tls_prf_sha256) {
8745 return MBEDTLS_SSL_TLS_PRF_SHA256;
8746 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008747#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008749}
8750
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008751/*
8752 * Populate a transform structure with session keys and all the other
8753 * necessary information.
8754 *
8755 * Parameters:
8756 * - [in/out]: transform: structure to populate
8757 * [in] must be just initialised with mbedtls_ssl_transform_init()
8758 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8759 * - [in] ciphersuite
8760 * - [in] master
8761 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008762 * - [in] tls_prf: pointer to PRF to use for key derivation
8763 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008764 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008765 * - [in] endpoint: client or server
8766 * - [in] ssl: used for:
8767 * - ssl->conf->{f,p}_export_keys
8768 * [in] optionally used for:
8769 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8770 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008771MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008772static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8773 int ciphersuite,
8774 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008775#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008777#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 ssl_tls_prf_t tls_prf,
8779 const unsigned char randbytes[64],
8780 mbedtls_ssl_protocol_version tls_version,
8781 unsigned endpoint,
8782 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008783{
8784 int ret = 0;
8785 unsigned char keyblk[256];
8786 unsigned char *key1;
8787 unsigned char *key2;
8788 unsigned char *mac_enc;
8789 unsigned char *mac_dec;
8790 size_t mac_key_len = 0;
8791 size_t iv_copy_len;
8792 size_t keylen;
8793 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008794 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008795#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008796 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008797 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008798#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008799
8800#if defined(MBEDTLS_USE_PSA_CRYPTO)
8801 psa_key_type_t key_type;
8802 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8803 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008804 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008805 size_t key_bits;
8806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8807#endif
8808
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008809 /*
8810 * Some data just needs copying into the structure
8811 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008812#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008813 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008814#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008815 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008816
8817#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819#endif
8820
8821#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008822 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008823 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8824 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008826 }
8827#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8828
8829 /*
8830 * Get various info structures
8831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8833 if (ciphersuite_info == NULL) {
8834 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8835 ciphersuite));
8836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008837 }
8838
Neil Armstrongab555e02022-04-04 11:07:59 +02008839 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008840#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008842#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008844
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008846 transform->taglen =
8847 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008849
8850#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008851 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 transform->taglen,
8853 &alg,
8854 &key_type,
8855 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008856 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008858 goto end;
8859 }
8860#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008861 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 if (cipher_info == NULL) {
8863 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8864 ciphersuite_info->cipher));
8865 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008866 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008867#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008868
Neil Armstronge4512952022-03-08 09:08:22 +01008869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008870 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008872 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 (unsigned) ciphersuite_info->mac));
8874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008875 }
8876#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008877 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if (md_info == NULL) {
8879 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8880 (unsigned) ciphersuite_info->mac));
8881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008882 }
Neil Armstronge4512952022-03-08 09:08:22 +01008883#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008884
8885#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8886 /* Copy own and peer's CID if the use of the CID
8887 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8889 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008890
8891 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8893 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8894 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008895
8896 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8898 ssl->handshake->peer_cid_len);
8899 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8900 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008901 }
8902#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8903
8904 /*
8905 * Compute key block using the PRF
8906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8908 if (ret != 0) {
8909 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8910 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008911 }
8912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8914 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8915 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8916 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8917 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008918
8919 /*
8920 * Determine the appropriate key, IV and MAC length.
8921 */
8922
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008923#if defined(MBEDTLS_USE_PSA_CRYPTO)
8924 keylen = PSA_BITS_TO_BYTES(key_bits);
8925#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008927#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008928
Valerio Settie5707042023-10-11 11:54:42 +02008929#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931 size_t explicit_ivlen;
8932
8933 transform->maclen = 0;
8934 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008935
8936 /* All modes haves 96-bit IVs, but the length of the static parts vary
8937 * with mode and version:
8938 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8939 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8940 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8941 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8942 * sequence number).
8943 */
8944 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008945
8946 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008947#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008949#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8951 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008952#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008953
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008955 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008957 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008959
8960 /* Minimum length of encrypted record */
8961 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8962 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 } else
Valerio Settie5707042023-10-11 11:54:42 +02008964#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008965#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008967 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008969#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008970 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008971#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008972 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008973#endif /* MBEDTLS_USE_PSA_CRYPTO */
8974
8975#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008976 /* Get MAC length */
8977 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8978#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008979 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8981 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8982 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008983 goto end;
8984 }
8985
8986 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008988#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008989 transform->maclen = mac_key_len;
8990
8991 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008992#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008994#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008995 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008996#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008997
8998 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009000 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009002 /*
9003 * GenericBlockCipher:
9004 * 1. if EtM is in use: one block plus MAC
9005 * otherwise: * first multiple of blocklen greater than maclen
9006 * 2. IV
9007 */
9008#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009010 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 + block_size;
9012 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009013#endif
9014 {
9015 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009016 + block_size
9017 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009018 }
9019
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009021 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 } else {
9023 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009024 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9025 goto end;
9026 }
9027 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9030 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9032 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009033 }
9034
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9036 (unsigned) keylen,
9037 (unsigned) transform->minlen,
9038 (unsigned) transform->ivlen,
9039 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009040
9041 /*
9042 * Finally setup the cipher contexts, IVs and MAC secrets.
9043 */
9044#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009046 key1 = keyblk + mac_key_len * 2;
9047 key2 = keyblk + mac_key_len * 2 + keylen;
9048
9049 mac_enc = keyblk;
9050 mac_dec = keyblk + mac_key_len;
9051
Gilles Peskine449bd832023-01-11 14:50:10 +01009052 iv_copy_len = (transform->fixed_ivlen) ?
9053 transform->fixed_ivlen : transform->ivlen;
9054 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9055 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9056 iv_copy_len);
9057 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009058#endif /* MBEDTLS_SSL_CLI_C */
9059#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009061 key1 = keyblk + mac_key_len * 2 + keylen;
9062 key2 = keyblk + mac_key_len * 2;
9063
9064 mac_enc = keyblk + mac_key_len;
9065 mac_dec = keyblk;
9066
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 iv_copy_len = (transform->fixed_ivlen) ?
9068 transform->fixed_ivlen : transform->ivlen;
9069 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9070 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9071 iv_copy_len);
9072 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009073#endif /* MBEDTLS_SSL_SRV_C */
9074 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009076 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9077 goto end;
9078 }
9079
Paul Elliott4fb19552023-10-18 12:15:30 +01009080 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 ssl->f_export_keys(ssl->p_export_keys,
9082 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9083 master, 48,
9084 randbytes + 32,
9085 randbytes,
9086 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009087 }
9088
9089#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009090 transform->psa_alg = alg;
9091
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9093 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9094 psa_set_key_algorithm(&attributes, alg);
9095 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009096
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 if ((status = psa_import_key(&attributes,
9098 key1,
9099 PSA_BITS_TO_BYTES(key_bits),
9100 &transform->psa_key_enc)) != PSA_SUCCESS) {
9101 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009102 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009104 goto end;
9105 }
9106
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009108
Gilles Peskine449bd832023-01-11 14:50:10 +01009109 if ((status = psa_import_key(&attributes,
9110 key2,
9111 PSA_BITS_TO_BYTES(key_bits),
9112 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009113 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009114 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009115 goto end;
9116 }
9117 }
9118#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9120 cipher_info)) != 0) {
9121 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009122 goto end;
9123 }
9124
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9126 cipher_info)) != 0) {
9127 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009128 goto end;
9129 }
9130
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9132 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9133 MBEDTLS_ENCRYPT)) != 0) {
9134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009135 goto end;
9136 }
9137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9139 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9140 MBEDTLS_DECRYPT)) != 0) {
9141 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009142 goto end;
9143 }
9144
9145#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009146 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9147 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9148 MBEDTLS_PADDING_NONE)) != 0) {
9149 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009150 goto end;
9151 }
9152
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9154 MBEDTLS_PADDING_NONE)) != 0) {
9155 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009156 goto end;
9157 }
9158 }
9159#endif /* MBEDTLS_CIPHER_MODE_CBC */
9160#endif /* MBEDTLS_USE_PSA_CRYPTO */
9161
Neil Armstrong29c0c042022-03-17 17:47:28 +01009162#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9163 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9164 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009166#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9170 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9171 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009172
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 if ((status = psa_import_key(&attributes,
9174 mac_enc, mac_key_len,
9175 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009176 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009178 goto end;
9179 }
9180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9182 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009187 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9189 PSA_KEY_USAGE_VERIFY_HASH);
9190 } else {
9191 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9192 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 if ((status = psa_import_key(&attributes,
9195 mac_dec, mac_key_len,
9196 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009197 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009199 goto end;
9200 }
9201#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9203 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009204 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 }
9206 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9207 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009208 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009210#endif /* MBEDTLS_USE_PSA_CRYPTO */
9211 }
9212#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9213
9214 ((void) mac_dec);
9215 ((void) mac_enc);
9216
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009217end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9219 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009220}
9221
Valerio Settia08b1a42022-11-17 15:10:02 +01009222#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9223 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009224int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 psa_pake_operation_t *pake_ctx,
9226 const unsigned char *buf,
9227 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009228{
9229 psa_status_t status;
9230 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009231 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009232 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9233 * At round two perform a single cycle
9234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009236
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 for (; remaining_steps > 0; remaining_steps--) {
9238 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009239 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009241 /* Length is stored at the first byte */
9242 size_t length = buf[input_offset];
9243 input_offset += 1;
9244
Gilles Peskine449bd832023-01-11 14:50:10 +01009245 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009246 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9247 }
9248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 status = psa_pake_input(pake_ctx, step,
9250 buf + input_offset, length);
9251 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009252 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009253 }
9254
9255 input_offset += length;
9256 }
9257 }
9258
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009260 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009264}
9265
Valerio Setti6b3dab02022-11-17 17:14:54 +01009266int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 psa_pake_operation_t *pake_ctx,
9268 unsigned char *buf,
9269 size_t len, size_t *olen,
9270 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009271{
9272 psa_status_t status;
9273 size_t output_offset = 0;
9274 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009275 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009276 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9277 * At round two perform a single cycle
9278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009280
Gilles Peskine449bd832023-01-11 14:50:10 +01009281 for (; remaining_steps > 0; remaining_steps--) {
9282 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9283 step <= PSA_PAKE_STEP_ZK_PROOF;
9284 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009285 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009286 * For each step, prepend 1 byte with the length of the data as
9287 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 status = psa_pake_output(pake_ctx, step,
9290 buf + output_offset + 1,
9291 len - output_offset - 1,
9292 &output_len);
9293 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009294 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009295 }
9296
Valerio Setti99d88c12022-11-22 16:03:43 +01009297 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009298
9299 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009300 }
9301 }
9302
9303 *olen = output_offset;
9304
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009306}
Valerio Settia08b1a42022-11-17 15:10:02 +01009307#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9308
Jerry Yuee40f9d2022-02-17 14:55:16 +08009309#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009310int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9311 unsigned char *hash, size_t *hashlen,
9312 unsigned char *data, size_t data_len,
9313 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009314{
9315 psa_status_t status;
9316 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009317 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009318
Gilles Peskine449bd832023-01-11 14:50:10 +01009319 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009320
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 if ((status = psa_hash_setup(&hash_operation,
9322 hash_alg)) != PSA_SUCCESS) {
9323 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009324 goto exit;
9325 }
9326
Gilles Peskine449bd832023-01-11 14:50:10 +01009327 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9328 64)) != PSA_SUCCESS) {
9329 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009330 goto exit;
9331 }
9332
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 if ((status = psa_hash_update(&hash_operation,
9334 data, data_len)) != PSA_SUCCESS) {
9335 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009336 goto exit;
9337 }
9338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9340 hashlen)) != PSA_SUCCESS) {
9341 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9342 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009343 }
9344
9345exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009346 if (status != PSA_SUCCESS) {
9347 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9348 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9349 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009350 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009351 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009352 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9353 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009354 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009357 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009359 }
9360 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009362}
9363
9364#else
9365
Gilles Peskine449bd832023-01-11 14:50:10 +01009366int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9367 unsigned char *hash, size_t *hashlen,
9368 unsigned char *data, size_t data_len,
9369 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009370{
9371 int ret = 0;
9372 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9374 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009375
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009377
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009379
9380 /*
9381 * digitally-signed struct {
9382 * opaque client_random[32];
9383 * opaque server_random[32];
9384 * ServerDHParams params;
9385 * };
9386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9388 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009389 goto exit;
9390 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9392 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009393 goto exit;
9394 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009395 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9396 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009397 goto exit;
9398 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009399 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9400 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009401 goto exit;
9402 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009403 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9404 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009405 goto exit;
9406 }
9407
9408exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009410
Gilles Peskine449bd832023-01-11 14:50:10 +01009411 if (ret != 0) {
9412 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9413 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9414 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009415
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009417}
9418#endif /* MBEDTLS_USE_PSA_CRYPTO */
9419
Jerry Yud9d91da2022-02-17 14:57:06 +08009420#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9421
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009422/* Find the preferred hash for a given signature algorithm. */
9423unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 mbedtls_ssl_context *ssl,
9425 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009426{
Gabor Mezei078e8032022-04-27 21:17:56 +02009427 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009428 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009429
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9431 return MBEDTLS_SSL_HASH_NONE;
9432 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009433
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009435 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9437 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009438 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9440 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009441
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009442 mbedtls_md_type_t md_alg =
9443 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9444 if (md_alg == MBEDTLS_MD_NONE) {
9445 continue;
9446 }
9447
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009449#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009451 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009452 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009453
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9455 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9456 PSA_ALG_ECDSA(psa_hash_alg),
9457 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009458 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009460
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9462 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9463 PSA_ALG_RSA_PKCS1V15_SIGN(
9464 psa_hash_alg),
9465 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009468 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009469#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009472 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009473 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009474
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009476}
9477
9478#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9479
Jerry Yudc7bd172022-02-17 13:44:15 +08009480#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9481
XiaokangQian75d40ef2022-04-20 11:05:24 +00009482int mbedtls_ssl_validate_ciphersuite(
9483 const mbedtls_ssl_context *ssl,
9484 const mbedtls_ssl_ciphersuite_t *suite_info,
9485 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009486 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009487{
9488 (void) ssl;
9489
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 if (suite_info == NULL) {
9491 return -1;
9492 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009493
Gilles Peskine449bd832023-01-11 14:50:10 +01009494 if ((suite_info->min_tls_version > max_tls_version) ||
9495 (suite_info->max_tls_version < min_tls_version)) {
9496 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009497 }
9498
XiaokangQian060d8672022-04-21 09:24:56 +00009499#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009500#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009501#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9503 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009504#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9506 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009507#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009508 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009509 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009510 }
9511#endif
9512
9513 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9514#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9516 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9517 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009518 }
9519#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9520#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9521
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009523}
9524
Ronald Crone68ab4f2022-10-05 12:46:29 +02009525#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009526/*
9527 * Function for writing a signature algorithm extension.
9528 *
9529 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9530 * value (TLS 1.3 RFC8446):
9531 * enum {
9532 * ....
9533 * ecdsa_secp256r1_sha256( 0x0403 ),
9534 * ecdsa_secp384r1_sha384( 0x0503 ),
9535 * ecdsa_secp521r1_sha512( 0x0603 ),
9536 * ....
9537 * } SignatureScheme;
9538 *
9539 * struct {
9540 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9541 * } SignatureSchemeList;
9542 *
9543 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9544 * value (TLS 1.2 RFC5246):
9545 * enum {
9546 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9547 * sha512(6), (255)
9548 * } HashAlgorithm;
9549 *
9550 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9551 * SignatureAlgorithm;
9552 *
9553 * struct {
9554 * HashAlgorithm hash;
9555 * SignatureAlgorithm signature;
9556 * } SignatureAndHashAlgorithm;
9557 *
9558 * SignatureAndHashAlgorithm
9559 * supported_signature_algorithms<2..2^16-2>;
9560 *
9561 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9562 * generalization of the TLS 1.2 signature algorithm extension.
9563 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9564 * `SignatureScheme` field of TLS 1.3
9565 *
9566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009567int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9568 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009569{
9570 unsigned char *p = buf;
9571 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9572 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9573
9574 *out_len = 0;
9575
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009577
9578 /* Check if we have space for header and length field:
9579 * - extension_type (2 bytes)
9580 * - extension_data_length (2 bytes)
9581 * - supported_signature_algorithms_length (2 bytes)
9582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009584 p += 6;
9585
9586 /*
9587 * Write supported_signature_algorithms
9588 */
9589 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009590 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9591 if (sig_alg == NULL) {
9592 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9593 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009594
Gilles Peskine449bd832023-01-11 14:50:10 +01009595 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9596 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9597 *sig_alg,
9598 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9599 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009600 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 }
9602 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9603 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009604 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9606 *sig_alg,
9607 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009608 }
9609
9610 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009611 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 if (supported_sig_alg_len == 0) {
9613 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9614 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009615 }
9616
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9618 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9619 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009620
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009621 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009622
9623#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009625#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009626
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009628}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009629#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009630
XiaokangQian40a35232022-05-07 09:02:40 +00009631#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009632/*
9633 * mbedtls_ssl_parse_server_name_ext
9634 *
9635 * Structure of server_name extension:
9636 *
9637 * enum {
9638 * host_name(0), (255)
9639 * } NameType;
9640 * opaque HostName<1..2^16-1>;
9641 *
9642 * struct {
9643 * NameType name_type;
9644 * select (name_type) {
9645 * case host_name: HostName;
9646 * } name;
9647 * } ServerName;
9648 * struct {
9649 * ServerName server_name_list<1..2^16-1>
9650 * } ServerNameList;
9651 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009652MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009653int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9654 const unsigned char *buf,
9655 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009656{
9657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9658 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009659 size_t server_name_list_len, hostname_len;
9660 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009661
Gilles Peskine449bd832023-01-11 14:50:10 +01009662 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009663
Gilles Peskine449bd832023-01-11 14:50:10 +01009664 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9665 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009666 p += 2;
9667
Gilles Peskine449bd832023-01-11 14:50:10 +01009668 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009669 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009670 while (p < server_name_list_end) {
9671 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9672 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9673 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9674 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009675
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009677 /* sni_name is intended to be used only during the parsing of the
9678 * ClientHello message (it is reset to NULL before the end of
9679 * the message parsing). Thus it is ok to just point to the
9680 * reception buffer and not make a copy of it.
9681 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009682 ssl->handshake->sni_name = p + 3;
9683 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009684 if (ssl->conf->f_sni == NULL) {
9685 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009686 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009687 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9688 ssl, p + 3, hostname_len);
9689 if (ret != 0) {
9690 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9691 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9692 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9693 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9694 }
9695 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009696 }
9697
9698 p += hostname_len + 3;
9699 }
9700
Gilles Peskine449bd832023-01-11 14:50:10 +01009701 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009702}
9703#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9704
XiaokangQianacb39922022-06-17 10:18:48 +00009705#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009706MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009707int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9708 const unsigned char *buf,
9709 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009710{
9711 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009712 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009713 const unsigned char *protocol_name_list;
9714 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009715 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009716
9717 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009718 if (ssl->conf->alpn_list == NULL) {
9719 return 0;
9720 }
XiaokangQianacb39922022-06-17 10:18:48 +00009721
9722 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009723 * RFC7301, section 3.1
9724 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009725 *
XiaokangQianc7403452022-06-23 03:24:12 +00009726 * struct {
9727 * ProtocolName protocol_name_list<2..2^16-1>
9728 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009729 */
9730
XiaokangQianc7403452022-06-23 03:24:12 +00009731 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009732 * protocol_name_list_len 2 bytes
9733 * protocol_name_len 1 bytes
9734 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009736 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009737
Gilles Peskine449bd832023-01-11 14:50:10 +01009738 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009739 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009740 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009741 protocol_name_list = p;
9742 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009743
9744 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009745 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009746 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9748 protocol_name_len);
9749 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009750 MBEDTLS_SSL_PEND_FATAL_ALERT(
9751 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009752 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9753 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009754 }
9755
9756 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009757 }
9758
9759 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009760 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9761 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009762 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009763 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009764 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009765 if (protocol_name_len == alpn_len &&
9766 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009767 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009768 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009769 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009770
9771 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009772 }
9773 }
9774
XiaokangQian95d5f542022-06-24 02:29:26 +00009775 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009776 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009777 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9778 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9779 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009780}
9781
Gilles Peskine449bd832023-01-11 14:50:10 +01009782int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9783 unsigned char *buf,
9784 unsigned char *end,
9785 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009786{
9787 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009788 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009789 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009790
Gilles Peskine449bd832023-01-11 14:50:10 +01009791 if (ssl->alpn_chosen == NULL) {
9792 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009793 }
9794
Gilles Peskine449bd832023-01-11 14:50:10 +01009795 protocol_name_len = strlen(ssl->alpn_chosen);
9796 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009797
Gilles Peskine449bd832023-01-11 14:50:10 +01009798 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009799 /*
9800 * 0 . 1 ext identifier
9801 * 2 . 3 ext length
9802 * 4 . 5 protocol list length
9803 * 6 . 6 protocol name length
9804 * 7 . 7+n protocol name
9805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009806 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009807
XiaokangQian95d5f542022-06-24 02:29:26 +00009808 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009809
Gilles Peskine449bd832023-01-11 14:50:10 +01009810 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9811 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009812 /* Note: the length of the chosen protocol has been checked to be less
9813 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009815 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009816
Gilles Peskine449bd832023-01-11 14:50:10 +01009817 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009818
9819#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009820 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009821#endif
9822
Gilles Peskine449bd832023-01-11 14:50:10 +01009823 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009824}
9825#endif /* MBEDTLS_SSL_ALPN */
9826
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009827#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009828 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009829 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009830 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009831int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9832 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009833{
9834 /* Initialize to suppress unnecessary compiler warning */
9835 size_t hostname_len = 0;
9836
9837 /* Check if new hostname is valid before
9838 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009839 if (hostname != NULL) {
9840 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009841
Gilles Peskine449bd832023-01-11 14:50:10 +01009842 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9843 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9844 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009845 }
9846
9847 /* Now it's clear that we will overwrite the old hostname,
9848 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009849 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009850 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009851 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009852 }
9853
9854 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009855 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009856 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009857 } else {
9858 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9859 if (session->hostname == NULL) {
9860 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9861 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009862
Gilles Peskine449bd832023-01-11 14:50:10 +01009863 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009864 }
9865
Gilles Peskine449bd832023-01-11 14:50:10 +01009866 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009867}
Xiaokang Qian03409292022-10-12 02:49:52 +00009868#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9869 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009870 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009871 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009873#endif /* MBEDTLS_SSL_TLS_C */