blob: 50024434a1724fba8353d4c4414375d1d435721b [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
135 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200278#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (src->ticket != NULL) {
280 dst->ticket = mbedtls_calloc(1, src->ticket_len);
281 if (dst->ticket == NULL) {
282 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
283 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200286 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000287
288#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
289 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
293 if (ret != 0) {
294 return ret;
295 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000296 }
297#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
298 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200299#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200302}
303
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500304#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
309 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800310 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500312
313 /* We want to copy len_new bytes when downsizing the buffer, and
314 * len_old bytes when upsizing, so we choose the smaller of two sizes,
315 * to fit one buffer into another. Size checks, ensuring that no data is
316 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 memcpy(resized_buffer, *buffer,
318 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100319 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500320
321 *buffer = resized_buffer;
322 *len_old = len_new;
323
324 return 0;
325}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200326
Gilles Peskine449bd832023-01-11 14:50:10 +0100327static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
328 size_t in_buf_new_len,
329 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200330{
331 int modified = 0;
332 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
333 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200335 written_in = ssl->in_msg - ssl->in_buf;
336 iv_offset_in = ssl->in_iv - ssl->in_buf;
337 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200339 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl->in_buf_len < in_buf_new_len) {
341 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
343 } else {
344 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
345 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 modified = 1;
347 }
348 }
349 }
350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200352 written_out = ssl->out_msg - ssl->out_buf;
353 iv_offset_out = ssl->out_iv - ssl->out_buf;
354 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 ssl->out_buf_len < out_buf_new_len) {
358 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
360 } else {
361 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
362 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 modified = 1;
364 }
365 }
366 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 /* Fields below might not be properly updated with record
371 * splitting or with CID, so they are manually updated here. */
372 ssl->out_msg = ssl->out_buf + written_out;
373 ssl->out_len = ssl->out_buf + len_offset_out;
374 ssl->out_iv = ssl->out_buf + iv_offset_out;
375
376 ssl->in_msg = ssl->in_buf + written_in;
377 ssl->in_len = ssl->in_buf + len_offset_in;
378 ssl->in_iv = ssl->in_buf + iv_offset_in;
379 }
380}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500381#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
382
Jerry Yudb8c48a2022-01-27 14:54:54 +0800383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800384
385#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100386typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
387 const char *label,
388 const unsigned char *random, size_t rlen,
389 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800390
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800392
393#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
394
395/* Type for the TLS PRF */
396typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
397 const unsigned char *, size_t,
398 unsigned char *, size_t);
399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200400MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
402 int ciphersuite,
403 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200406#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 ssl_tls_prf_t tls_prf,
408 const unsigned char randbytes[64],
409 mbedtls_ssl_protocol_version tls_version,
410 unsigned endpoint,
411 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800412
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100413#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300416 const char *label,
417 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100419static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
420static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100421
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100422#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100424#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100425MBEDTLS_CHECK_RETURN_CRITICAL
426static int tls_prf_sha384(const unsigned char *secret, size_t slen,
427 const char *label,
428 const unsigned char *random, size_t rlen,
429 unsigned char *dstbuf, size_t dlen);
430
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100431static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
432static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100433#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100434
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int ssl_tls12_session_load(mbedtls_ssl_session *session,
437 const unsigned char *buf,
438 size_t len);
439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100443#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100445#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100447#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100448static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100449#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100450
451int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
452 const unsigned char *secret, size_t slen,
453 const char *label,
454 const unsigned char *random, size_t rlen,
455 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300456{
457 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
458
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100461#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300462 case MBEDTLS_SSL_TLS_PRF_SHA384:
463 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100465#endif /* MBEDTLS_MD_CAN_SHA384*/
466#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 case MBEDTLS_SSL_TLS_PRF_SHA256:
468 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100470#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 default:
473 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300474 }
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477}
478
Jerry Yuc73c6182022-02-08 20:29:25 +0800479#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800481{
482#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 if (session->peer_cert != NULL) {
484 mbedtls_x509_crt_free(session->peer_cert);
485 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800486 session->peer_cert = NULL;
487 }
488#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800490 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800492 session->peer_cert_digest = NULL;
493 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
494 session->peer_cert_digest_len = 0;
495 }
496#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
497}
498#endif /* MBEDTLS_X509_CRT_PARSE_C */
499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800503 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800505
506 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
Jan Bruckner151f6422023-02-10 12:45:19 +0100581 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
582 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
583
Jerry Yu7a485c12022-10-31 13:08:18 +0800584 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 }
588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590}
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800593{
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800595}
596
Jerry Yud25cab02022-10-31 12:48:30 +0800597#if defined(MBEDTLS_DEBUG_C)
598static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800599 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800600 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
601 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
602 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
603 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
604 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
605 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
606 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
607 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
608 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
609 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
610 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
611 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
612 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
613 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
614 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
615 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
616 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
617 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
618 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
619 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
620 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
621 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
622 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
623 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
624 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
625 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100626 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
627 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800628};
629
Chien Wong4e9683e2023-12-28 17:07:43 +0800630static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800631 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
632 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
633 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
634 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
635 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
636 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
637 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
638 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
639 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
640 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
641 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
642 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
643 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
644 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
645 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
646 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
647 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
648 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
649 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
650 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
651 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
652 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
653 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
654 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
655 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
656 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
657 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100658 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
659 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800660};
661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800663{
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 return extension_name_table[
665 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800666}
667
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800671 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800673 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800675 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800677 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800679 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800687}
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
690 int level, const char *file, int line,
691 int hs_msg_type, unsigned int extension_type,
692 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800693{
694 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 mbedtls_debug_print_msg(
697 ssl, level, file, line,
698 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 ssl_tls13_get_hs_msg_name(hs_msg_type),
700 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800701 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800703 return;
704 }
705
706 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800708 mbedtls_debug_print_msg(
709 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
711 mbedtls_ssl_get_extension_name(extension_type), extension_type,
712 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 mbedtls_debug_print_msg(
717 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
719 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800720}
721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
723 int level, const char *file, int line,
724 int hs_msg_type, uint32_t extensions_mask,
725 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800726{
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 for (unsigned i = 0;
729 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
730 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800731 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800732 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800734 }
735}
736
Pengyu Lvee455c02023-01-12 14:37:24 +0800737#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800738static const char *ticket_flag_name_table[] =
739{
740 [0] = "ALLOW_PSK_RESUMPTION",
741 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
742 [3] = "ALLOW_EARLY_DATA",
743};
744
Pengyu Lv4938a562023-01-16 11:28:49 +0800745void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
746 int level, const char *file, int line,
747 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748{
749 size_t i;
750
751 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800752 "print ticket_flags (0x%02x)", flags);
753
754 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800755
756 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800757 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800758 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
759 ticket_flag_name_table[i]);
760 }
761 }
762}
763#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
764
Jerry Yud25cab02022-10-31 12:48:30 +0800765#endif /* MBEDTLS_DEBUG_C */
766
Gilles Peskine449bd832023-01-11 14:50:10 +0100767void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
768 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800769{
770 ((void) ciphersuite_info);
771
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100772#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800774 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800776#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100777#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800779 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800781#endif
782 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 return;
785 }
786}
787
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100788int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100789 unsigned hs_type,
790 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100791{
792 unsigned char hs_hdr[4];
793
794 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
796 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
797 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
798 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100799
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100800 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 unsigned char const *msg,
806 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100807{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100808 int ret;
809 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100810 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100812 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814}
815
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100816int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800817{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100818#if defined(MBEDTLS_MD_CAN_SHA256) || \
819 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100820#if defined(MBEDTLS_USE_PSA_CRYPTO)
821 psa_status_t status;
822#else
823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
824#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100825#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800826 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100827#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100828#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
831 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200832 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 }
834 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
835 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200836 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100837 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800838#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100839 mbedtls_md_free(&ssl->handshake->fin_sha256);
840 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100841 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
842 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
843 0);
844 if (ret != 0) {
845 return ret;
846 }
847 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 if (ret != 0) {
849 return ret;
850 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800851#endif
852#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100853#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha384);
865 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
868 if (ret != 0) {
869 return ret;
870 }
871 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 if (ret != 0) {
873 return ret;
874 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800875#endif
876#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100877 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800878}
879
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100881 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800882{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100883#if defined(MBEDTLS_MD_CAN_SHA256) || \
884 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100885#if defined(MBEDTLS_USE_PSA_CRYPTO)
886 psa_status_t status;
887#else
888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
889#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100890#else /* SHA-256 or SHA-384 */
891 ((void) ssl);
892 (void) buf;
893 (void) len;
894#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100895#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100897 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
898 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200899 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800901#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100902 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 if (ret != 0) {
904 return ret;
905 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800906#endif
907#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100908#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
911 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200912 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800914#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100915 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 if (ret != 0) {
917 return ret;
918 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800919#endif
920#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100921 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800922}
923
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100924#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100925static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100926 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800927{
928#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200929 return mbedtls_md_error_from_psa(psa_hash_update(
930 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100932 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934}
935#endif
936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100937#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100938static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100939 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800940{
941#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200942 return mbedtls_md_error_from_psa(psa_hash_update(
943 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100945 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#endif
947}
948#endif
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100954#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500957#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100958 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200959#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100961#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500962#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500963 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500964#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100965 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
969 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200974#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200975 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200978#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200979#if defined(MBEDTLS_USE_PSA_CRYPTO)
980 handshake->psa_pake_ctx = psa_pake_operation_init();
981 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
982#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200984#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200985#if defined(MBEDTLS_SSL_CLI_C)
986 handshake->ecjpake_cache = NULL;
987 handshake->ecjpake_cache_len = 0;
988#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200989#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200990
Gilles Peskineeccd8882020-03-10 12:19:08 +0100991#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200993#endif
994
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
996 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
997#endif
Hanno Becker75173122019-02-06 16:18:31 +0000998
999#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1000 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001002#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006{
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001008
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001009#if defined(MBEDTLS_USE_PSA_CRYPTO)
1010 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1011 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001012#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1014 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001015#endif
1016
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001017#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001018#if defined(MBEDTLS_USE_PSA_CRYPTO)
1019 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1020 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001021#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_md_init(&transform->md_ctx_enc);
1023 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001024#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001025#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001026}
1027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029{
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031}
1032
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001034static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001035{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1037
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001038 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001039#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (ssl->transform_negotiate) {
1041 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1042 }
Jerry Yu2e199812022-12-01 18:57:19 +08001043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 if (ssl->session_negotiate) {
1045 mbedtls_ssl_session_free(ssl->session_negotiate);
1046 }
1047 if (ssl->handshake) {
1048 mbedtls_ssl_handshake_free(ssl);
1049 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001050
Jerry Yu2e199812022-12-01 18:57:19 +08001051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /*
1053 * Either the pointers are now NULL or cleared properly and can be freed.
1054 * Now allocate missing structures.
1055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->transform_negotiate == NULL) {
1057 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001058 }
Jerry Yu2e199812022-12-01 18:57:19 +08001059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 if (ssl->session_negotiate == NULL) {
1062 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001063 }
Paul Bakker48916f92012-09-16 19:57:18 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->handshake == NULL) {
1066 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001067 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001068#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1069 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1072 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001073#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001077#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001078 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001079#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ssl->session_negotiate == NULL) {
1081 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001084 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001085
1086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001088 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001089#endif
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001092 ssl->session_negotiate = NULL;
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001095 }
1096
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001097#if defined(MBEDTLS_SSL_EARLY_DATA)
1098#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron90e22332024-01-22 15:24:21 +01001099 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_UNKNOWN;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001100#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001101#if defined(MBEDTLS_SSL_SRV_C)
1102 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1103#endif
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;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001554 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001557
1558 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559#if defined(MBEDTLS_SSL_RENEGOTIATION)
1560 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001561 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001562
1563 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1565 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001566#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001568
Hanno Beckerb0302c42021-08-03 09:39:42 +01001569 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001570 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 if (ssl->session) {
1572 mbedtls_ssl_session_free(ssl->session);
1573 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001574 ssl->session = NULL;
1575 }
1576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001578 ssl->alpn_chosen = NULL;
1579#endif
1580
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001581#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001582 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001583#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001585#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (free_cli_id) {
1587 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 ssl->cli_id = NULL;
1589 ssl->cli_id_len = 0;
1590 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001591#endif
1592
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 if ((ret = ssl_handshake_init(ssl)) != 0) {
1594 return ret;
1595 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001598}
1599
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001600/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001601 * Reset an initialized and used SSL context for re-use while retaining
1602 * all application-set variables, function pointers and data.
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605{
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001607}
1608
1609/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001610 * SSL set accessors
1611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001612void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001613{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001614 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001615}
1616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001618{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001619 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001620}
1621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001624{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001625 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001626}
1627#endif
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001630{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001631 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001632}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001635
Gilles Peskine449bd832023-01-11 14:50:10 +01001636void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1637 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001638{
1639 ssl->disable_datagram_packing = !allow_packing;
1640}
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1643 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001645 conf->hs_timeout_min = min;
1646 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001647}
1648#endif
1649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001653}
1654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001656void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1657 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1658 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->f_vrfy = f_vrfy;
1661 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001662}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1666 int (*f_rng)(void *, unsigned char *, size_t),
1667 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001669 conf->f_rng = f_rng;
1670 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1674 void (*f_dbg)(void *, int, const char *, int, const char *),
1675 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001676{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001677 conf->f_dbg = f_dbg;
1678 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001679}
1680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1682 void *p_bio,
1683 mbedtls_ssl_send_t *f_send,
1684 mbedtls_ssl_recv_t *f_recv,
1685 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001686{
1687 ssl->p_bio = p_bio;
1688 ssl->f_send = f_send;
1689 ssl->f_recv = f_recv;
1690 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001691}
1692
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001694void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001695{
1696 ssl->mtu = mtu;
1697}
1698#endif
1699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001701{
1702 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001703}
1704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1706 void *p_timer,
1707 mbedtls_ssl_set_timer_t *f_set_timer,
1708 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001709{
1710 ssl->p_timer = p_timer;
1711 ssl->f_set_timer = f_set_timer;
1712 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001713
1714 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001716}
1717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001719void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1720 void *p_cache,
1721 mbedtls_ssl_cache_get_t *f_get_cache,
1722 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001723{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001724 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001726 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001727}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001731int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001732{
Janos Follath865b3eb2019-12-16 11:46:15 +00001733 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001736 session == NULL ||
1737 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001740 }
1741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 if (ssl->handshake->resume == 1) {
1743 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1744 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001745
Jerry Yu21092062022-10-10 21:21:31 +08001746#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001748 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001752 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1754 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1755 session->ciphersuite));
1756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001757 }
Jerry Yu40afab62022-10-08 10:42:13 +08001758 }
Jerry Yu21092062022-10-10 21:21:31 +08001759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1762 session)) != 0) {
1763 return ret;
1764 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Paul Bakker0a597072012-09-25 21:55:46 +00001766 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001769}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1773 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001774{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001775 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001776}
1777
Ronald Cron6f135e12021-12-08 16:57:54 +01001778#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001779void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1780 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001782 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001783}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001784
1785#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001786void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1787 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001788{
1789 conf->early_data_enabled = early_data_enabled;
1790}
Jerry Yucc4e0072022-11-22 17:22:22 +08001791
1792#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001793void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001795{
Jerry Yu39da9852022-12-06 16:58:36 +08001796 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001797}
1798#endif /* MBEDTLS_SSL_SRV_C */
1799
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001800#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001801#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001804void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1805 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001806{
1807 conf->cert_profile = profile;
1808}
1809
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001811{
1812 mbedtls_ssl_key_cert *cur = key_cert, *next;
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 cur = next;
1818 }
1819}
1820
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001821/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001823static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1824 mbedtls_x509_crt *cert,
1825 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826{
niisato8ee24222018-06-25 19:05:48 +09001827 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001834 }
1835
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1837 if (new_cert == NULL) {
1838 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1839 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001840
niisato8ee24222018-06-25 19:05:48 +09001841 new_cert->cert = cert;
1842 new_cert->key = key;
1843 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001844
Glenn Strauss36872db2022-01-22 05:06:31 -05001845 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001847 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001851 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 }
niisato8ee24222018-06-25 19:05:48 +09001853 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001854 }
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857}
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001862{
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001867 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001869{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001870 conf->ca_chain = ca_chain;
1871 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001872
1873#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1874 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1875 * cannot be used together. */
1876 conf->f_ca_cb = NULL;
1877 conf->p_ca_cb = NULL;
1878#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001879}
Hanno Becker5adaad92019-03-27 16:54:37 +00001880
1881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001882void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1883 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1884 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001885{
1886 conf->f_ca_cb = f_ca_cb;
1887 conf->p_ca_cb = p_ca_cb;
1888
1889 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1890 * cannot be used together. */
1891 conf->ca_chain = NULL;
1892 conf->ca_crl = NULL;
1893}
1894#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001896
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001897#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001898const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1899 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001900{
1901 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001903}
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1906 mbedtls_x509_crt *own_cert,
1907 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001908{
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1910 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1914 mbedtls_x509_crt *ca_chain,
1915 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001916{
1917 ssl->handshake->sni_ca_chain = ca_chain;
1918 ssl->handshake->sni_ca_crl = ca_crl;
1919}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001920
Glenn Strauss999ef702022-03-11 01:37:23 -05001921#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1923 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001924{
1925 ssl->handshake->dn_hints = crt;
1926}
1927#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1930 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001931{
1932 ssl->handshake->sni_authmode = authmode;
1933}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001934#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1935
Hanno Becker8927c832019-04-03 12:52:50 +01001936#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1938 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1939 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001940{
1941 ssl->f_vrfy = f_vrfy;
1942 ssl->p_vrfy = p_vrfy;
1943}
1944#endif
1945
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001946#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001947
Valerio Setti016f6822022-12-09 14:17:50 +01001948#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001949static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1950static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1951
Valerio Setti016f6822022-12-09 14:17:50 +01001952static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 mbedtls_ssl_context *ssl,
1954 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001955{
1956 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001957 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001960 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001961 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1963 psa_pake_cs_set_primitive(&cipher_suite,
1964 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1965 PSA_ECC_FAMILY_SECP_R1,
1966 256));
1967 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1970 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001971 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001975 user = jpake_server_id;
1976 user_len = sizeof(jpake_server_id);
1977 peer = jpake_client_id;
1978 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001980 user = jpake_client_id;
1981 user_len = sizeof(jpake_client_id);
1982 peer = jpake_server_id;
1983 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001985
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001986 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1987 if (status != PSA_SUCCESS) {
1988 return status;
1989 }
1990
1991 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001993 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
Valerio Setti016f6822022-12-09 14:17:50 +01001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1997 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001998 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 }
Valerio Setti016f6822022-12-09 14:17:50 +01002000
2001 ssl->handshake->psa_pake_ctx_is_ok = 1;
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002004}
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2007 const unsigned char *pw,
2008 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002009{
2010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2011 psa_status_t status;
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if (ssl->handshake == NULL || ssl->conf == NULL) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002015 }
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 /* Empty password is not valid */
2018 if ((pw == NULL) || (pw_len == 0)) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
2021
2022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2023 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2024 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2025
2026 status = psa_import_key(&attributes, pw, pw_len,
2027 &ssl->handshake->psa_pake_password);
2028 if (status != PSA_SUCCESS) {
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2033 ssl->handshake->psa_pake_password);
2034 if (status != PSA_SUCCESS) {
2035 psa_destroy_key(ssl->handshake->psa_pake_password);
2036 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2038 }
2039
2040 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002041}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2044 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046 psa_status_t status;
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ssl->handshake == NULL || ssl->conf == NULL) {
2049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (mbedtls_svc_key_id_is_null(pwd)) {
2053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2057 if (status != PSA_SUCCESS) {
2058 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2059 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2060 }
2061
2062 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002063}
2064#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002065int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2066 const unsigned char *pw,
2067 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068{
2069 mbedtls_ecjpake_role role;
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->handshake == NULL || ssl->conf == NULL) {
2072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2073 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074
Valerio Settic689ed82022-12-07 14:40:38 +01002075 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if ((pw == NULL) || (pw_len == 0)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
Valerio Settic689ed82022-12-07 14:40:38 +01002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2087 role,
2088 MBEDTLS_MD_SHA256,
2089 MBEDTLS_ECP_DP_SECP256R1,
2090 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091}
Valerio Setti02c25b52022-11-15 14:08:42 +01002092#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002093#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094
Ronald Cron73fe8df2022-10-05 14:31:43 +02002095#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097{
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (conf->psk_identity == NULL ||
2099 conf->psk_identity_len == 0) {
2100 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002101 }
2102
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2105 return 1;
2106 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (conf->psk != NULL && conf->psk_len != 0) {
2110 return 1;
2111 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002114}
2115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117{
2118 /* Remove reference to existing PSK, if any. */
2119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 /* The maintenance of the PSK key slot is the
2122 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002123 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002127 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 conf->psk = NULL;
2129 conf->psk_len = 0;
2130 }
2131
2132 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk_identity != NULL) {
2134 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002135 conf->psk_identity = NULL;
2136 conf->psk_identity_len = 0;
2137 }
2138}
2139
Hanno Becker7390c712018-11-15 13:33:04 +00002140/* This function assumes that PSK identity in the SSL config is unset.
2141 * It checks that the provided identity is well-formed and attempts
2142 * to make a copy of it in the SSL config.
2143 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002145static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2146 unsigned char const *psk_identity,
2147 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002148{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002149 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002151 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 (psk_identity_len >> 16) != 0 ||
2153 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002155 }
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2158 if (conf->psk_identity == NULL) {
2159 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2160 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002161
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002162 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002166}
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2169 const unsigned char *psk, size_t psk_len,
2170 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002171{
Janos Follath865b3eb2019-12-16 11:46:15 +00002172 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002173
2174 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2176 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2177 }
Hanno Becker7390c712018-11-15 13:33:04 +00002178
2179 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (psk == NULL) {
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2182 }
2183 if (psk_len == 0) {
2184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2185 }
2186 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2187 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2188 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2191 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2192 }
Hanno Becker7390c712018-11-15 13:33:04 +00002193 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002195
2196 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2198 if (ret != 0) {
2199 ssl_conf_remove_psk(conf);
2200 }
Hanno Becker7390c712018-11-15 13:33:04 +00002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002203}
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002206{
2207#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002209 /* The maintenance of the external PSK key slot is the
2210 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->handshake->psk_opaque_is_internal) {
2212 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002213 ssl->handshake->psk_opaque_is_internal = 0;
2214 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002215 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002216 }
Neil Armstronge952a302022-05-03 10:22:14 +02002217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002219 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002221 ssl->handshake->psk_len = 0;
2222 }
Neil Armstronge952a302022-05-03 10:22:14 +02002223#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224}
2225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2227 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002228{
Neil Armstrong501c9322022-05-03 09:35:09 +02002229#if defined(MBEDTLS_USE_PSA_CRYPTO)
2230 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002232 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002234#endif /* MBEDTLS_USE_PSA_CRYPTO */
2235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 if (psk == NULL || ssl->handshake == NULL) {
2237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2238 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2242 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002243
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Neil Armstrong501c9322022-05-03 09:35:09 +02002246#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002247#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2249 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2250 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2251 } else {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2253 }
2254 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002255 }
2256#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002257
Jerry Yu568ec252022-07-22 21:27:34 +08002258#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2260 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2261 psa_set_key_usage_flags(&key_attributes,
2262 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002263 }
2264#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 psa_set_key_algorithm(&key_attributes, alg);
2267 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2270 if (status != PSA_SUCCESS) {
2271 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2272 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002273
2274 /* Allow calling psa_destroy_key() on psk remove */
2275 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002277#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2279 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2280 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002281
2282 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002286#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002287}
2288
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002289#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002290int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2291 mbedtls_svc_key_id_t psk,
2292 const unsigned char *psk_identity,
2293 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002294{
Janos Follath865b3eb2019-12-16 11:46:15 +00002295 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002296
2297 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2299 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2300 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002301
Hanno Becker7390c712018-11-15 13:33:04 +00002302 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (mbedtls_svc_key_id_is_null(psk)) {
2304 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2305 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002306 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002307
2308 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2310 psk_identity_len);
2311 if (ret != 0) {
2312 ssl_conf_remove_psk(conf);
2313 }
Hanno Becker7390c712018-11-15 13:33:04 +00002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002316}
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2319 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002320{
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 if ((mbedtls_svc_key_id_is_null(psk)) ||
2322 (ssl->handshake == NULL)) {
2323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2324 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329}
2330#endif /* MBEDTLS_USE_PSA_CRYPTO */
2331
Jerry Yu8897c072022-08-12 13:56:53 +08002332#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002333void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2334 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2335 size_t),
2336 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002337{
2338 conf->f_psk = f_psk;
2339 conf->p_psk = p_psk;
2340}
Jerry Yu8897c072022-08-12 13:56:53 +08002341#endif /* MBEDTLS_SSL_SRV_C */
2342
Ronald Cron73fe8df2022-10-05 14:31:43 +02002343#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002344
2345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002346static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002348{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002349#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 if (alg == PSA_ALG_CBC_NO_PADDING) {
2351 return MBEDTLS_SSL_MODE_CBC;
2352 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002353#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (PSA_ALG_IS_AEAD(alg)) {
2355 return MBEDTLS_SSL_MODE_AEAD;
2356 }
2357 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002358}
2359
2360#else /* MBEDTLS_USE_PSA_CRYPTO */
2361
2362static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002364{
2365#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (mode == MBEDTLS_MODE_CBC) {
2367 return MBEDTLS_SSL_MODE_CBC;
2368 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002369#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2370
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371#if defined(MBEDTLS_GCM_C) || \
2372 defined(MBEDTLS_CCM_C) || \
2373 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002375 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 mode == MBEDTLS_MODE_CHACHAPOLY) {
2377 return MBEDTLS_SSL_MODE_AEAD;
2378 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002379#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382}
Gilles Peskine301711e2022-04-26 16:57:05 +02002383#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384
Gilles Peskinee108d982022-04-26 16:50:40 +02002385static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2386 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002388{
2389#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2391 base_mode == MBEDTLS_SSL_MODE_CBC) {
2392 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002393 }
2394#else
2395 (void) encrypt_then_mac;
2396#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002398}
2399
Neil Armstrongab555e02022-04-04 11:07:59 +02002400mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402{
Gilles Peskinee108d982022-04-26 16:50:40 +02002403 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002408#endif
2409 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002412#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 encrypt_then_mac = transform->encrypt_then_mac;
2414#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416}
2417
Neil Armstrongab555e02022-04-04 11:07:59 +02002418mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423{
Gilles Peskinee108d982022-04-26 16:50:40 +02002424 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2425
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426#if defined(MBEDTLS_USE_PSA_CRYPTO)
2427 psa_status_t status;
2428 psa_algorithm_t alg;
2429 psa_key_type_t type;
2430 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002431 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2432 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 if (status == PSA_SUCCESS) {
2434 base_mode = mbedtls_ssl_get_base_mode(alg);
2435 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002436#else
2437 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002438 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002440 base_mode =
2441 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002443 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002444#endif /* MBEDTLS_USE_PSA_CRYPTO */
2445
Gilles Peskinee108d982022-04-26 16:50:40 +02002446#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2447 int encrypt_then_mac = 0;
2448#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002450}
2451
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002452#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2455 size_t taglen,
2456 psa_algorithm_t *alg,
2457 psa_key_type_t *key_type,
2458 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002459{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002460#if !defined(MBEDTLS_SSL_HAVE_CCM)
2461 (void) taglen;
2462#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002464#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002465 case MBEDTLS_CIPHER_AES_128_CBC:
2466 *alg = PSA_ALG_CBC_NO_PADDING;
2467 *key_type = PSA_KEY_TYPE_AES;
2468 *key_size = 128;
2469 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002470#endif
2471#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002472 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002474 *key_type = PSA_KEY_TYPE_AES;
2475 *key_size = 128;
2476 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002477#endif
2478#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002479 case MBEDTLS_CIPHER_AES_128_GCM:
2480 *alg = PSA_ALG_GCM;
2481 *key_type = PSA_KEY_TYPE_AES;
2482 *key_size = 128;
2483 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002484#endif
2485#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 *key_type = PSA_KEY_TYPE_AES;
2489 *key_size = 192;
2490 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002491#endif
2492#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002493 case MBEDTLS_CIPHER_AES_192_GCM:
2494 *alg = PSA_ALG_GCM;
2495 *key_type = PSA_KEY_TYPE_AES;
2496 *key_size = 192;
2497 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002498#endif
2499#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 case MBEDTLS_CIPHER_AES_256_CBC:
2501 *alg = PSA_ALG_CBC_NO_PADDING;
2502 *key_type = PSA_KEY_TYPE_AES;
2503 *key_size = 256;
2504 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002505#endif
2506#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002507 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 *key_type = PSA_KEY_TYPE_AES;
2510 *key_size = 256;
2511 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002512#endif
2513#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002514 case MBEDTLS_CIPHER_AES_256_GCM:
2515 *alg = PSA_ALG_GCM;
2516 *key_type = PSA_KEY_TYPE_AES;
2517 *key_size = 256;
2518 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002519#endif
2520#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 case MBEDTLS_CIPHER_ARIA_128_CBC:
2522 *alg = PSA_ALG_CBC_NO_PADDING;
2523 *key_type = PSA_KEY_TYPE_ARIA;
2524 *key_size = 128;
2525 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002526#endif
2527#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002528 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 *key_type = PSA_KEY_TYPE_ARIA;
2531 *key_size = 128;
2532 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002533#endif
2534#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002535 case MBEDTLS_CIPHER_ARIA_128_GCM:
2536 *alg = PSA_ALG_GCM;
2537 *key_type = PSA_KEY_TYPE_ARIA;
2538 *key_size = 128;
2539 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002540#endif
2541#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 *key_type = PSA_KEY_TYPE_ARIA;
2545 *key_size = 192;
2546 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002547#endif
2548#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002549 case MBEDTLS_CIPHER_ARIA_192_GCM:
2550 *alg = PSA_ALG_GCM;
2551 *key_type = PSA_KEY_TYPE_ARIA;
2552 *key_size = 192;
2553 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002554#endif
2555#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 case MBEDTLS_CIPHER_ARIA_256_CBC:
2557 *alg = PSA_ALG_CBC_NO_PADDING;
2558 *key_type = PSA_KEY_TYPE_ARIA;
2559 *key_size = 256;
2560 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002561#endif
2562#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002563 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 *key_type = PSA_KEY_TYPE_ARIA;
2566 *key_size = 256;
2567 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002568#endif
2569#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002570 case MBEDTLS_CIPHER_ARIA_256_GCM:
2571 *alg = PSA_ALG_GCM;
2572 *key_type = PSA_KEY_TYPE_ARIA;
2573 *key_size = 256;
2574 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002575#endif
2576#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2578 *alg = PSA_ALG_CBC_NO_PADDING;
2579 *key_type = PSA_KEY_TYPE_CAMELLIA;
2580 *key_size = 128;
2581 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002582#endif
2583#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002584 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 *key_type = PSA_KEY_TYPE_CAMELLIA;
2587 *key_size = 128;
2588 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002589#endif
2590#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002591 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2592 *alg = PSA_ALG_GCM;
2593 *key_type = PSA_KEY_TYPE_CAMELLIA;
2594 *key_size = 128;
2595 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002596#endif
2597#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 *key_type = PSA_KEY_TYPE_CAMELLIA;
2601 *key_size = 192;
2602 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002603#endif
2604#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002605 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2606 *alg = PSA_ALG_GCM;
2607 *key_type = PSA_KEY_TYPE_CAMELLIA;
2608 *key_size = 192;
2609 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002610#endif
2611#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2613 *alg = PSA_ALG_CBC_NO_PADDING;
2614 *key_type = PSA_KEY_TYPE_CAMELLIA;
2615 *key_size = 256;
2616 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002617#endif
2618#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002619 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 *key_type = PSA_KEY_TYPE_CAMELLIA;
2622 *key_size = 256;
2623 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002624#endif
2625#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002626 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2627 *alg = PSA_ALG_GCM;
2628 *key_type = PSA_KEY_TYPE_CAMELLIA;
2629 *key_size = 256;
2630 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002631#endif
2632#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002633 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2634 *alg = PSA_ALG_CHACHA20_POLY1305;
2635 *key_type = PSA_KEY_TYPE_CHACHA20;
2636 *key_size = 256;
2637 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002638#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002639 case MBEDTLS_CIPHER_NULL:
2640 *alg = MBEDTLS_SSL_NULL_CIPHER;
2641 *key_type = 0;
2642 *key_size = 0;
2643 break;
2644 default:
2645 return PSA_ERROR_NOT_SUPPORTED;
2646 }
2647
2648 return PSA_SUCCESS;
2649}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002650#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002651
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002652#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002653int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2654 const unsigned char *dhm_P, size_t P_len,
2655 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002656{
Janos Follath865b3eb2019-12-16 11:46:15 +00002657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 mbedtls_mpi_free(&conf->dhm_P);
2660 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2663 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2664 mbedtls_mpi_free(&conf->dhm_P);
2665 mbedtls_mpi_free(&conf->dhm_G);
2666 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002667 }
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002670}
Paul Bakker5121ce52009-01-03 21:22:43 +00002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002673{
Janos Follath865b3eb2019-12-16 11:46:15 +00002674 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 mbedtls_mpi_free(&conf->dhm_P);
2677 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2680 &conf->dhm_P)) != 0 ||
2681 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2682 &conf->dhm_G)) != 0) {
2683 mbedtls_mpi_free(&conf->dhm_P);
2684 mbedtls_mpi_free(&conf->dhm_G);
2685 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002686 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002689}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002690#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002691
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002692#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2693/*
2694 * Set the minimum length for Diffie-Hellman parameters
2695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002696void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2697 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002698{
2699 conf->dhm_min_bitlen = bitlen;
2700}
2701#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2702
Ronald Crone68ab4f2022-10-05 12:46:29 +02002703#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002704#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002705/*
2706 * Set allowed/preferred hashes for handshake signatures
2707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002708void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2709 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002710{
2711 conf->sig_hashes = hashes;
2712}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002713#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002714
Jerry Yuf017ee42022-01-12 15:49:48 +08002715/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2717 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002718{
Jerry Yuf017ee42022-01-12 15:49:48 +08002719#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2720 conf->sig_hashes = NULL;
2721#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2722 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002723}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002724#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002725
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002726#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002727#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002728/*
2729 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002730 *
2731 * mbedtls_ssl_setup() takes the provided list
2732 * and translates it to a list of IANA TLS group identifiers,
2733 * stored in ssl->handshake->group_list.
2734 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002736void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2737 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002738{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002739 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002740 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002741}
Brett Warrene0edc842021-08-17 09:53:13 +01002742#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002743#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002744
Brett Warrene0edc842021-08-17 09:53:13 +01002745/*
2746 * Set the allowed groups
2747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002748void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2749 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002750{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002752 conf->curve_list = NULL;
2753#endif
2754 conf->group_list = group_list;
2755}
2756
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002757#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002758int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002759{
Hanno Becker947194e2017-04-07 13:25:49 +01002760 /* Initialize to suppress unnecessary compiler warning */
2761 size_t hostname_len = 0;
2762
2763 /* Check if new hostname is valid before
2764 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (hostname != NULL) {
2766 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2770 }
Hanno Becker947194e2017-04-07 13:25:49 +01002771 }
2772
2773 /* Now it's clear that we will overwrite the old hostname,
2774 * so we can free it safely */
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002777 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002778 }
2779
2780 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002783 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 } else {
2785 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2786 if (ssl->hostname == NULL) {
2787 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2788 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002791
Hanno Becker947194e2017-04-07 13:25:49 +01002792 ssl->hostname[hostname_len] = '\0';
2793 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002796}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002797#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002798
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002799#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002800void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2801 int (*f_sni)(void *, mbedtls_ssl_context *,
2802 const unsigned char *, size_t),
2803 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002804{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002805 conf->f_sni = f_sni;
2806 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002807}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002811int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002812{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002813 size_t cur_len, tot_len;
2814 const char **p;
2815
2816 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002817 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2818 * MUST NOT be truncated."
2819 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002820 */
2821 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 for (p = protos; *p != NULL; p++) {
2823 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002824 tot_len += cur_len;
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if ((cur_len == 0) ||
2827 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2828 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2830 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002831 }
2832
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002833 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002836}
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002839{
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002841}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002843
Johan Pascalb62bb512015-12-03 21:56:45 +01002844#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002845void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2846 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002847{
2848 conf->dtls_srtp_mki_support = support_mki_value;
2849}
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2852 unsigned char *mki_value,
2853 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002854{
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002857 }
Ron Eldor591f1622018-01-22 12:30:04 +02002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2860 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002861 }
Ron Eldor591f1622018-01-22 12:30:04 +02002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002864 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002866}
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2869 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002870{
Johan Pascal253d0262020-09-22 13:04:45 +02002871 const mbedtls_ssl_srtp_profile *p;
2872 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002873
Johan Pascal253d0262020-09-22 13:04:45 +02002874 /* check the profiles list: all entry must be valid,
2875 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2877 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2878 p++) {
2879 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002880 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002882 /* unsupported value, stop parsing and set the size to an error value */
2883 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002884 }
2885 }
2886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2888 conf->dtls_srtp_profile_list = NULL;
2889 conf->dtls_srtp_profile_list_len = 0;
2890 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002891 }
2892
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002893 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002894 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002897}
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2900 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002901{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002902 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2903 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002905 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002907 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2909 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002910 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002911}
Johan Pascalb62bb512015-12-03 21:56:45 +01002912#endif /* MBEDTLS_SSL_DTLS_SRTP */
2913
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302914#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002915void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002916{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002917 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002918}
2919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002921{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002922 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002923}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302924#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002925
Janos Follath088ce432017-04-10 12:42:31 +01002926#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002927void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2928 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002929{
2930 conf->cert_req_ca_list = cert_req_ca_list;
2931}
2932#endif
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002936{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002938}
2939#endif
2940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002942void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002943{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002944 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002945}
2946#endif
2947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002949int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002950{
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2952 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002954 }
2955
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002956 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002959}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002963{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002964 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002965}
2966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002968void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002969{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002970 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002971}
2972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002974{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002975 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002976}
2977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2979 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002980{
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002982}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002986#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002988{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002989 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002990}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002991#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002992
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002993#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002994
Jerry Yud0766ec2022-09-22 10:46:57 +08002995#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002996void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2997 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002998{
Jerry Yud0766ec2022-09-22 10:46:57 +08002999 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003000}
3001#endif
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3004 mbedtls_ssl_ticket_write_t *f_ticket_write,
3005 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3006 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003007{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003008 conf->f_ticket_write = f_ticket_write;
3009 conf->f_ticket_parse = f_ticket_parse;
3010 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003011}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003012#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3016 mbedtls_ssl_export_keys_t *f_export_keys,
3017 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003018{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003019 ssl->f_export_keys = f_export_keys;
3020 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003021}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003022
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003023#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003024void mbedtls_ssl_conf_async_private_cb(
3025 mbedtls_ssl_config *conf,
3026 mbedtls_ssl_async_sign_t *f_async_sign,
3027 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3028 mbedtls_ssl_async_resume_t *f_async_resume,
3029 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003031{
3032 conf->f_async_sign_start = f_async_sign;
3033 conf->f_async_decrypt_start = f_async_decrypt;
3034 conf->f_async_resume = f_async_resume;
3035 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003036 conf->p_async_config_data = async_config_data;
3037}
3038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003040{
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003042}
3043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003045{
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (ssl->handshake == NULL) {
3047 return NULL;
3048 } else {
3049 return ssl->handshake->user_async_ctx;
3050 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003051}
3052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3054 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003055{
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003057 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003059}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003060#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003061
Paul Bakker5121ce52009-01-03 21:22:43 +00003062/*
3063 * SSL get accessors
3064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003065uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003066{
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 if (ssl->session != NULL) {
3068 return ssl->session->verify_result;
3069 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003070
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 if (ssl->session_negotiate != NULL) {
3072 return ssl->session_negotiate->verify_result;
3073 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003079{
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (ssl == NULL || ssl->session == NULL) {
3081 return 0;
3082 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003085}
3086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003088{
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (ssl == NULL || ssl->session == NULL) {
3090 return NULL;
3091 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003097{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3100 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003101 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003103 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003105 }
3106 }
3107#endif
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003110 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003112 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003114 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003116 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003117}
3118
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003119#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3120
3121size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3122{
3123 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3124 size_t record_size_limit = max_len;
3125
3126 if (ssl->session != NULL &&
3127 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3128 ssl->session->record_size_limit < max_len) {
3129 record_size_limit = ssl->session->record_size_limit;
3130 }
3131
3132 // TODO: this is currently untested
3133 /* During a handshake, use the value being negotiated */
3134 if (ssl->session_negotiate != NULL &&
3135 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3136 ssl->session_negotiate->record_size_limit < max_len) {
3137 record_size_limit = ssl->session_negotiate->record_size_limit;
3138 }
3139
3140 return record_size_limit;
3141}
3142#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3143
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003144#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003145size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003146{
David Horstmann95d516f2021-05-04 18:36:56 +01003147 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003148 size_t read_mfl;
3149
Jerry Yuddda0502022-12-01 19:43:12 +08003150#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003151 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3153 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3154 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003155 }
Jerry Yuddda0502022-12-01 19:43:12 +08003156#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003157
3158 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 if (ssl->session_out != NULL) {
3160 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3161 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003162 max_len = read_mfl;
3163 }
3164 }
3165
Jerry Yuddda0502022-12-01 19:43:12 +08003166 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 if (ssl->session_negotiate != NULL) {
3168 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3169 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003170 max_len = read_mfl;
3171 }
3172 }
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003175}
3176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003178{
3179 size_t max_len;
3180
3181 /*
3182 * Assume mfl_code is correct since it was checked when set
3183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003185
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003186 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 if (ssl->session_out != NULL &&
3188 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3189 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003190 }
3191
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003192 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 if (ssl->session_negotiate != NULL &&
3194 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3195 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003196 }
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003199}
3200#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3201
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003202#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003203size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003204{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003205 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3207 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3208 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3209 return 0;
3210 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3213 return ssl->mtu;
3214 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 if (ssl->mtu == 0) {
3217 return ssl->handshake->mtu;
3218 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 return ssl->mtu < ssl->handshake->mtu ?
3221 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003222}
3223#endif /* MBEDTLS_SSL_PROTO_DTLS */
3224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003226{
3227 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3228
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003229#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003230 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003231 !defined(MBEDTLS_SSL_PROTO_DTLS)
3232 (void) ssl;
3233#endif
3234
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003235#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003237
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003239 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003241#endif
3242
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003243#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3244 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3245
3246 if (max_len > record_size_limit) {
3247 max_len = record_size_limit;
3248 }
3249#endif
3250
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003251 if (ssl->transform_out != NULL &&
3252 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003253 /*
3254 * In TLS 1.3 case, when records are protected, `max_len` as computed
3255 * above is the maximum length of the TLSInnerPlaintext structure that
3256 * along the plaintext payload contains the inner content type (one byte)
3257 * and some zero padding. Given the algorithm used for padding
3258 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3259 * the plaintext payload. Round down to a multiple of
3260 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3261 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003262 */
3263 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3264 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3265 }
3266
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003267#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3269 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3270 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003271 const size_t overhead = (size_t) ret;
3272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 if (ret < 0) {
3274 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003275 }
3276
Gilles Peskine449bd832023-01-11 14:50:10 +01003277 if (mtu <= overhead) {
3278 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3279 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3280 }
3281
3282 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003283 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003285 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003286#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287
Hanno Becker0defedb2018-08-10 12:35:02 +01003288#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003289 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3290 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003291 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003292#endif
3293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295}
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003298{
3299 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3300
3301#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3302 (void) ssl;
3303#endif
3304
3305#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003309 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003311#endif
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003314}
3315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003317const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003318{
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl == NULL || ssl->session == NULL) {
3320 return NULL;
3321 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003322
Hanno Beckere6824572019-02-07 13:18:46 +00003323#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003325#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003327#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003328}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003332int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3333 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003334{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003335 int ret;
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003338 dst == NULL ||
3339 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3341 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003342 }
3343
Hanno Beckere810bbc2021-05-14 16:01:05 +01003344 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3345 * idempotent: Each session can only be exported once.
3346 *
3347 * (This is in preparation for TLS 1.3 support where we will
3348 * need the ability to export multiple sessions (aka tickets),
3349 * which will be achieved by calling mbedtls_ssl_get_session()
3350 * multiple times until it fails.)
3351 *
3352 * Check whether we have already exported the current session,
3353 * and fail if so.
3354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 if (ssl->session->exported == 1) {
3356 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3357 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3360 if (ret != 0) {
3361 return ret;
3362 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003363
3364 /* Remember that we've exported the session. */
3365 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003369
David Horstmanncb01b362024-02-29 17:31:46 +00003370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3371
3372/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003373 *
David Horstmanncb01b362024-02-29 17:31:46 +00003374 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003375 */
3376static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3377 unsigned char *buf,
3378 size_t buf_len)
3379{
3380 unsigned char *p = buf;
3381 size_t used = 0;
3382
3383#if defined(MBEDTLS_HAVE_TIME)
3384 uint64_t start;
3385#endif
3386#if defined(MBEDTLS_X509_CRT_PARSE_C)
3387#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3388 size_t cert_len;
3389#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3390#endif /* MBEDTLS_X509_CRT_PARSE_C */
3391
3392 /*
3393 * Time
3394 */
3395#if defined(MBEDTLS_HAVE_TIME)
3396 used += 8;
3397
3398 if (used <= buf_len) {
3399 start = (uint64_t) session->start;
3400
3401 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3402 p += 8;
3403 }
3404#endif /* MBEDTLS_HAVE_TIME */
3405
3406 /*
3407 * Basic mandatory fields
3408 */
3409 used += 1 /* id_len */
3410 + sizeof(session->id)
3411 + sizeof(session->master)
3412 + 4; /* verify_result */
3413
3414 if (used <= buf_len) {
3415 *p++ = MBEDTLS_BYTE_0(session->id_len);
3416 memcpy(p, session->id, 32);
3417 p += 32;
3418
3419 memcpy(p, session->master, 48);
3420 p += 48;
3421
3422 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3423 p += 4;
3424 }
3425
3426 /*
3427 * Peer's end-entity certificate
3428 */
3429#if defined(MBEDTLS_X509_CRT_PARSE_C)
3430#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3431 if (session->peer_cert == NULL) {
3432 cert_len = 0;
3433 } else {
3434 cert_len = session->peer_cert->raw.len;
3435 }
3436
3437 used += 3 + cert_len;
3438
3439 if (used <= buf_len) {
3440 *p++ = MBEDTLS_BYTE_2(cert_len);
3441 *p++ = MBEDTLS_BYTE_1(cert_len);
3442 *p++ = MBEDTLS_BYTE_0(cert_len);
3443
3444 if (session->peer_cert != NULL) {
3445 memcpy(p, session->peer_cert->raw.p, cert_len);
3446 p += cert_len;
3447 }
3448 }
3449#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3450 if (session->peer_cert_digest != NULL) {
3451 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3452 if (used <= buf_len) {
3453 *p++ = (unsigned char) session->peer_cert_digest_type;
3454 *p++ = (unsigned char) session->peer_cert_digest_len;
3455 memcpy(p, session->peer_cert_digest,
3456 session->peer_cert_digest_len);
3457 p += session->peer_cert_digest_len;
3458 }
3459 } else {
3460 used += 2;
3461 if (used <= buf_len) {
3462 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3463 *p++ = 0;
3464 }
3465 }
3466#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3467#endif /* MBEDTLS_X509_CRT_PARSE_C */
3468
3469 /*
3470 * Session ticket if any, plus associated data
3471 */
3472#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3473#if defined(MBEDTLS_SSL_CLI_C)
3474 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3475 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3476
3477 if (used <= buf_len) {
3478 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3479 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3480 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3481
3482 if (session->ticket != NULL) {
3483 memcpy(p, session->ticket, session->ticket_len);
3484 p += session->ticket_len;
3485 }
3486
3487 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3488 p += 4;
3489 }
3490 }
3491#endif /* MBEDTLS_SSL_CLI_C */
3492#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3493 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3494 used += 8;
3495
3496 if (used <= buf_len) {
3497 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3498 p += 8;
3499 }
3500 }
3501#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3502#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3503
3504 /*
3505 * Misc extension-related info
3506 */
3507#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3508 used += 1;
3509
3510 if (used <= buf_len) {
3511 *p++ = session->mfl_code;
3512 }
3513#endif
3514
3515#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3516 used += 1;
3517
3518 if (used <= buf_len) {
3519 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3520 }
3521#endif
3522
3523 return used;
3524}
3525
3526MBEDTLS_CHECK_RETURN_CRITICAL
3527static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3528 const unsigned char *buf,
3529 size_t len)
3530{
3531#if defined(MBEDTLS_HAVE_TIME)
3532 uint64_t start;
3533#endif
3534#if defined(MBEDTLS_X509_CRT_PARSE_C)
3535#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3536 size_t cert_len;
3537#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3538#endif /* MBEDTLS_X509_CRT_PARSE_C */
3539
3540 const unsigned char *p = buf;
3541 const unsigned char * const end = buf + len;
3542
3543 /*
3544 * Time
3545 */
3546#if defined(MBEDTLS_HAVE_TIME)
3547 if (8 > (size_t) (end - p)) {
3548 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3549 }
3550
3551 start = MBEDTLS_GET_UINT64_BE(p, 0);
3552 p += 8;
3553
3554 session->start = (time_t) start;
3555#endif /* MBEDTLS_HAVE_TIME */
3556
3557 /*
3558 * Basic mandatory fields
3559 */
3560 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3561 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3562 }
3563
3564 session->id_len = *p++;
3565 memcpy(session->id, p, 32);
3566 p += 32;
3567
3568 memcpy(session->master, p, 48);
3569 p += 48;
3570
3571 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3572 p += 4;
3573
3574 /* Immediately clear invalid pointer values that have been read, in case
3575 * we exit early before we replaced them with valid ones. */
3576#if defined(MBEDTLS_X509_CRT_PARSE_C)
3577#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3578 session->peer_cert = NULL;
3579#else
3580 session->peer_cert_digest = NULL;
3581#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3582#endif /* MBEDTLS_X509_CRT_PARSE_C */
3583#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3584 session->ticket = NULL;
3585#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3586
3587 /*
3588 * Peer certificate
3589 */
3590#if defined(MBEDTLS_X509_CRT_PARSE_C)
3591#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3592 /* Deserialize CRT from the end of the ticket. */
3593 if (3 > (size_t) (end - p)) {
3594 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3595 }
3596
3597 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3598 p += 3;
3599
3600 if (cert_len != 0) {
3601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3602
3603 if (cert_len > (size_t) (end - p)) {
3604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3605 }
3606
3607 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3608
3609 if (session->peer_cert == NULL) {
3610 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3611 }
3612
3613 mbedtls_x509_crt_init(session->peer_cert);
3614
3615 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3616 p, cert_len)) != 0) {
3617 mbedtls_x509_crt_free(session->peer_cert);
3618 mbedtls_free(session->peer_cert);
3619 session->peer_cert = NULL;
3620 return ret;
3621 }
3622
3623 p += cert_len;
3624 }
3625#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3626 /* Deserialize CRT digest from the end of the ticket. */
3627 if (2 > (size_t) (end - p)) {
3628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3629 }
3630
3631 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3632 session->peer_cert_digest_len = (size_t) *p++;
3633
3634 if (session->peer_cert_digest_len != 0) {
3635 const mbedtls_md_info_t *md_info =
3636 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3637 if (md_info == NULL) {
3638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3639 }
3640 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3642 }
3643
3644 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3646 }
3647
3648 session->peer_cert_digest =
3649 mbedtls_calloc(1, session->peer_cert_digest_len);
3650 if (session->peer_cert_digest == NULL) {
3651 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3652 }
3653
3654 memcpy(session->peer_cert_digest, p,
3655 session->peer_cert_digest_len);
3656 p += session->peer_cert_digest_len;
3657 }
3658#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3659#endif /* MBEDTLS_X509_CRT_PARSE_C */
3660
3661 /*
3662 * Session ticket and associated data
3663 */
3664#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3665#if defined(MBEDTLS_SSL_CLI_C)
3666 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3667 if (3 > (size_t) (end - p)) {
3668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3669 }
3670
3671 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3672 p += 3;
3673
3674 if (session->ticket_len != 0) {
3675 if (session->ticket_len > (size_t) (end - p)) {
3676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3677 }
3678
3679 session->ticket = mbedtls_calloc(1, session->ticket_len);
3680 if (session->ticket == NULL) {
3681 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3682 }
3683
3684 memcpy(session->ticket, p, session->ticket_len);
3685 p += session->ticket_len;
3686 }
3687
3688 if (4 > (size_t) (end - p)) {
3689 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3690 }
3691
3692 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3693 p += 4;
3694 }
3695#endif /* MBEDTLS_SSL_CLI_C */
3696#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3697 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3698 if (8 > (size_t) (end - p)) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3702 p += 8;
3703 }
3704#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3705#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3706
3707 /*
3708 * Misc extension-related info
3709 */
3710#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3711 if (1 > (size_t) (end - p)) {
3712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3713 }
3714
3715 session->mfl_code = *p++;
3716#endif
3717
3718#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3719 if (1 > (size_t) (end - p)) {
3720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3721 }
3722
3723 session->encrypt_then_mac = *p++;
3724#endif
3725
3726 /* Done, should have consumed entire buffer */
3727 if (p != end) {
3728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3729 }
3730
3731 return 0;
3732}
3733
3734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3735
3736#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3737/* Serialization of TLS 1.3 sessions:
3738 *
David Horstmanncb01b362024-02-29 17:31:46 +00003739 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003740 */
3741#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3742MBEDTLS_CHECK_RETURN_CRITICAL
3743static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3744 unsigned char *buf,
3745 size_t buf_len,
3746 size_t *olen)
3747{
3748 unsigned char *p = buf;
3749#if defined(MBEDTLS_SSL_CLI_C) && \
3750 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3751 size_t hostname_len = (session->hostname == NULL) ?
3752 0 : strlen(session->hostname) + 1;
3753#endif
3754 size_t needed = 4 /* ticket_age_add */
3755 + 1 /* ticket_flags */
3756 + 1; /* resumption_key length */
3757 *olen = 0;
3758
3759 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3761 }
3762 needed += session->resumption_key_len; /* resumption_key */
3763
3764#if defined(MBEDTLS_SSL_EARLY_DATA)
3765 needed += 4; /* max_early_data_size */
3766#endif
3767#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3768 needed += 2; /* record_size_limit */
3769#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3770
3771#if defined(MBEDTLS_HAVE_TIME)
3772 needed += 8; /* ticket_creation_time or ticket_reception_time */
3773#endif
3774
3775#if defined(MBEDTLS_SSL_CLI_C)
3776 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3777#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3778 needed += 2 /* hostname_len */
3779 + hostname_len; /* hostname */
3780#endif
3781
3782 needed += 4 /* ticket_lifetime */
3783 + 2; /* ticket_len */
3784
3785 /* Check size_t overflow */
3786 if (session->ticket_len > SIZE_MAX - needed) {
3787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3788 }
3789
3790 needed += session->ticket_len; /* ticket */
3791 }
3792#endif /* MBEDTLS_SSL_CLI_C */
3793
3794 *olen = needed;
3795 if (needed > buf_len) {
3796 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3797 }
3798
3799 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3800 p[4] = session->ticket_flags;
3801
3802 /* save resumption_key */
3803 p[5] = session->resumption_key_len;
3804 p += 6;
3805 memcpy(p, session->resumption_key, session->resumption_key_len);
3806 p += session->resumption_key_len;
3807
3808#if defined(MBEDTLS_SSL_EARLY_DATA)
3809 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3810 p += 4;
3811#endif
3812#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3813 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3814 p += 2;
3815#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3816
3817#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3818 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3819 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3820 p += 8;
3821 }
3822#endif /* MBEDTLS_HAVE_TIME */
3823
3824#if defined(MBEDTLS_SSL_CLI_C)
3825 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3826#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3827 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3828 p += 2;
3829 if (hostname_len > 0) {
3830 /* save host name */
3831 memcpy(p, session->hostname, hostname_len);
3832 p += hostname_len;
3833 }
3834#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3835
3836#if defined(MBEDTLS_HAVE_TIME)
3837 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3838 p += 8;
3839#endif
3840 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3841 p += 4;
3842
3843 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3844 p += 2;
3845
3846 if (session->ticket != NULL && session->ticket_len > 0) {
3847 memcpy(p, session->ticket, session->ticket_len);
3848 p += session->ticket_len;
3849 }
3850 }
3851#endif /* MBEDTLS_SSL_CLI_C */
3852 return 0;
3853}
3854
3855MBEDTLS_CHECK_RETURN_CRITICAL
3856static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3857 const unsigned char *buf,
3858 size_t len)
3859{
3860 const unsigned char *p = buf;
3861 const unsigned char *end = buf + len;
3862
3863 if (end - p < 6) {
3864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3865 }
3866 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3867 session->ticket_flags = p[4];
3868
3869 /* load resumption_key */
3870 session->resumption_key_len = p[5];
3871 p += 6;
3872
3873 if (end - p < session->resumption_key_len) {
3874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3875 }
3876
3877 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3879 }
3880 memcpy(session->resumption_key, p, session->resumption_key_len);
3881 p += session->resumption_key_len;
3882
3883#if defined(MBEDTLS_SSL_EARLY_DATA)
3884 if (end - p < 4) {
3885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3886 }
3887 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3888 p += 4;
3889#endif
3890#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3891 if (end - p < 2) {
3892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3893 }
3894 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3895 p += 2;
3896#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3897
3898#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3899 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3900 if (end - p < 8) {
3901 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3902 }
3903 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3904 p += 8;
3905 }
3906#endif /* MBEDTLS_HAVE_TIME */
3907
3908#if defined(MBEDTLS_SSL_CLI_C)
3909 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3910#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3911 size_t hostname_len;
3912 /* load host name */
3913 if (end - p < 2) {
3914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3915 }
3916 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3917 p += 2;
3918
3919 if (end - p < (long int) hostname_len) {
3920 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3921 }
3922 if (hostname_len > 0) {
3923 session->hostname = mbedtls_calloc(1, hostname_len);
3924 if (session->hostname == NULL) {
3925 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3926 }
3927 memcpy(session->hostname, p, hostname_len);
3928 p += hostname_len;
3929 }
3930#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3931
3932#if defined(MBEDTLS_HAVE_TIME)
3933 if (end - p < 8) {
3934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3935 }
3936 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3937 p += 8;
3938#endif
3939 if (end - p < 4) {
3940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3941 }
3942 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3943 p += 4;
3944
3945 if (end - p < 2) {
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3947 }
3948 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3949 p += 2;
3950
3951 if (end - p < (long int) session->ticket_len) {
3952 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3953 }
3954 if (session->ticket_len > 0) {
3955 session->ticket = mbedtls_calloc(1, session->ticket_len);
3956 if (session->ticket == NULL) {
3957 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3958 }
3959 memcpy(session->ticket, p, session->ticket_len);
3960 p += session->ticket_len;
3961 }
3962 }
3963#endif /* MBEDTLS_SSL_CLI_C */
3964
3965 return 0;
3966
3967}
3968#else /* MBEDTLS_SSL_SESSION_TICKETS */
3969MBEDTLS_CHECK_RETURN_CRITICAL
3970static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3971 unsigned char *buf,
3972 size_t buf_len,
3973 size_t *olen)
3974{
3975 ((void) session);
3976 ((void) buf);
3977 ((void) buf_len);
3978 *olen = 0;
3979 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3980}
3981
3982static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
3983 unsigned char *buf,
3984 size_t buf_len)
3985{
3986 ((void) session);
3987 ((void) buf);
3988 ((void) buf_len);
3989 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3990}
3991#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3992#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3993
Paul Bakker5121ce52009-01-03 21:22:43 +00003994/*
Hanno Beckera835da52019-05-16 12:39:07 +01003995 * Define ticket header determining Mbed TLS version
3996 * and structure of the ticket.
3997 */
3998
Hanno Becker94ef3b32019-05-16 12:50:45 +01003999/*
Hanno Becker50b59662019-05-28 14:30:45 +01004000 * Define bitflag determining compile-time settings influencing
4001 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004002 */
4003
Hanno Becker50b59662019-05-28 14:30:45 +01004004#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004005#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004006#else
Hanno Becker3e088662019-05-29 11:10:18 +01004007#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004008#endif /* MBEDTLS_HAVE_TIME */
4009
4010#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004011#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004012#else
Hanno Becker3e088662019-05-29 11:10:18 +01004013#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004014#endif /* MBEDTLS_X509_CRT_PARSE_C */
4015
David Horstmann5c5a32f2024-02-13 17:53:35 +00004016#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004017#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004018#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004019#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004020#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4021
Hanno Becker94ef3b32019-05-16 12:50:45 +01004022#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004023#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004024#else
Hanno Becker3e088662019-05-29 11:10:18 +01004025#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004026#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4027
4028#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004029#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004030#else
Hanno Becker3e088662019-05-29 11:10:18 +01004031#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004032#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4033
Hanno Becker94ef3b32019-05-16 12:50:45 +01004034#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004035#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004036#else
Hanno Becker3e088662019-05-29 11:10:18 +01004037#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004038#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4039
Hanno Becker94ef3b32019-05-16 12:50:45 +01004040#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4041#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4042#else
4043#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4044#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4045
David Horstmann92b258b2024-02-13 17:23:34 +00004046#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4047#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4048#else
4049#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4050#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4051
4052#if defined(MBEDTLS_SSL_EARLY_DATA)
4053#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4054#else
4055#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4056#endif /* MBEDTLS_SSL_EARLY_DATA */
4057
4058#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4059#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4060#else
4061#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4062#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4063
Hanno Becker3e088662019-05-29 11:10:18 +01004064#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4065#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4066#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4067#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004068#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4069#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004070#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004071#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4072#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4073#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Hanno Becker3e088662019-05-29 11:10:18 +01004074
Hanno Becker50b59662019-05-28 14:30:45 +01004075#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 ((uint16_t) ( \
4077 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4078 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4079 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4080 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4081 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4082 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004083 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004084 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4085 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004086 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4087 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4088 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4089 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
4090 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091
Chien Wong4e9683e2023-12-28 17:07:43 +08004092static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093 MBEDTLS_VERSION_MAJOR,
4094 MBEDTLS_VERSION_MINOR,
4095 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4097 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004098};
Hanno Beckera835da52019-05-16 12:39:07 +01004099
4100/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004101 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004102 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004103 *
David Horstmanncb01b362024-02-29 17:31:46 +00004104 * TLS 1.2 session:
4105 *
4106 * struct {
4107 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4108 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4109 * uint32 ticket_lifetime;
4110 * #endif
4111 * } ClientOnlyData;
4112 *
4113 * struct {
4114 * #if defined(MBEDTLS_HAVE_TIME)
4115 * uint64 start_time;
4116 * #endif
4117 * uint8 session_id_len; // at most 32
4118 * opaque session_id[32];
4119 * opaque master[48]; // fixed length in the standard
4120 * uint32 verify_result;
4121 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4122 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4123 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004124 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004125 * opaque peer_cert_digest<0..2^8-1>
4126 * #endif
4127 * select (endpoint) {
4128 * case client: ClientOnlyData;
4129 * case server: uint64 ticket_creation_time;
4130 * };
4131 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4132 * uint8 mfl_code; // up to 255 according to standard
4133 * #endif
4134 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4135 * uint8 encrypt_then_mac; // 0 or 1
4136 * #endif
4137 * } serialized_session_tls12;
4138 *
4139 *
4140 * TLS 1.3 Session:
4141 *
4142 * struct {
4143 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4144 * opaque hostname<0..2^16-1>;
4145 * #endif
4146 * #if defined(MBEDTLS_HAVE_TIME)
4147 * uint64 ticket_reception_time;
4148 * #endif
4149 * uint32 ticket_lifetime;
4150 * opaque ticket<1..2^16-1>;
4151 * } ClientOnlyData;
4152 *
4153 * struct {
4154 * uint32 ticket_age_add;
4155 * uint8 ticket_flags;
4156 * opaque resumption_key<0..255>;
4157 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4158 * uint32 max_early_data_size;
4159 * #endif
4160 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4161 * uint16 record_size_limit;
4162 * #endif
4163 * select ( endpoint ) {
4164 * case client: ClientOnlyData;
4165 * #if defined(MBEDTLS_HAVE_TIME)
4166 * case server: uint64 ticket_creation_time;
4167 * #endif
4168 * };
4169 * } serialized_session_tls13;
4170 *
4171 *
4172 * SSL session:
4173 *
4174 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004175 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004176 * opaque mbedtls_version[3]; // library version: major, minor, patch
4177 * opaque session_format[2]; // library-version specific 16-bit field
4178 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004179 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004180 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004181 * Note: When updating the format, remember to keep
4182 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004183 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004184 * // In this version, `session_format` determines
4185 * // the setting of those compile-time
4186 * // configuration options which influence
4187 * // the structure of mbedtls_ssl_session.
4188 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004189 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004190 * // - TLS 1.2 (0x0303)
4191 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004192 * uint8_t endpoint;
4193 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004194 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004195 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004196 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004197 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004198 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004199 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004200 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004201 *
4202 * };
4203 *
4204 * } serialized_session;
4205 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004206 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004207
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004208MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004209static int ssl_session_save(const mbedtls_ssl_session *session,
4210 unsigned char omit_header,
4211 unsigned char *buf,
4212 size_t buf_len,
4213 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004214{
4215 unsigned char *p = buf;
4216 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004217 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004218#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4219 size_t out_len;
4220 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4221#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (session == NULL) {
4223 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4224 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004227 /*
4228 * Add Mbed TLS version identifier
4229 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004231
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (used <= buf_len) {
4233 memcpy(p, ssl_serialized_session_header,
4234 sizeof(ssl_serialized_session_header));
4235 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004236 }
4237 }
4238
4239 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004240 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004241 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004242 used += 1 /* TLS version */
4243 + 1 /* endpoint */
4244 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (used <= buf_len) {
4246 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004247 *p++ = session->endpoint;
4248 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4249 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004250 }
4251
4252 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004253 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004255#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 case MBEDTLS_SSL_VERSION_TLS1_2:
4257 used += ssl_tls12_session_save(session, p, remaining_len);
4258 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004259#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4260
Jerry Yu251a12e2022-07-13 15:15:48 +08004261#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 case MBEDTLS_SSL_VERSION_TLS1_3:
4263 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4264 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4265 return ret;
4266 }
4267 used += out_len;
4268 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004269#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 default:
4272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004273 }
4274
4275 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (used > buf_len) {
4277 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4278 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004281}
4282
4283/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004284 * Public wrapper for ssl_session_save()
4285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004286int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4287 unsigned char *buf,
4288 size_t buf_len,
4289 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004290{
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004292}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004293
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004294/*
4295 * Deserialize session, see mbedtls_ssl_session_save() for format.
4296 *
4297 * This internal version is wrapped by a public function that cleans up in
4298 * case of error, and has an extra option omit_header.
4299 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004300MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004301static int ssl_session_load(mbedtls_ssl_session *session,
4302 unsigned char omit_header,
4303 const unsigned char *buf,
4304 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004305{
4306 const unsigned char *p = buf;
4307 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004308 size_t remaining_len;
4309
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 if (session == NULL) {
4312 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4313 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004316 /*
4317 * Check Mbed TLS version identifier
4318 */
4319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4321 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004322 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004323
4324 if (memcmp(p, ssl_serialized_session_header,
4325 sizeof(ssl_serialized_session_header)) != 0) {
4326 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4327 }
4328 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 }
4330
4331 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004332 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004333 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004334 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4336 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004337 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004338 session->endpoint = *p++;
4339 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4340 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004341
4342 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004343 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004345#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 case MBEDTLS_SSL_VERSION_TLS1_2:
4347 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004348#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4349
Jerry Yu438ddd82022-07-07 06:55:50 +00004350#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 case MBEDTLS_SSL_VERSION_TLS1_3:
4352 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 default:
4356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004357 }
4358}
4359
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004360/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004361 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004363int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4364 const unsigned char *buf,
4365 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004366{
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (ret != 0) {
4370 mbedtls_ssl_session_free(session);
4371 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004374}
4375
4376/*
Paul Bakker1961b702013-01-25 14:49:24 +01004377 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004378 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004379MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004380static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004381{
4382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4383
Ronald Cron66dbf912022-02-02 15:33:46 +01004384 /*
4385 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004386 * that were written into the output buffer by the previous handshake step,
4387 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004388 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4389 * We proceed to the next handshake step only when all data from the
4390 * previous one have been sent to the peer, thus we make sure that this is
4391 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4392 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4393 * we have to wait before to go ahead.
4394 * In the case of TLS 1.3, handshake step handlers do not send data to the
4395 * peer. Data are only sent here and through
4396 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004397 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004398 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4400 return ret;
4401 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004402
4403#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4405 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4406 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4407 return ret;
4408 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004409 }
4410#endif /* MBEDTLS_SSL_PROTO_DTLS */
4411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004413}
4414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004416{
Hanno Becker41934dd2021-08-07 19:13:43 +01004417 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004420 ssl->conf == NULL ||
4421 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004424 }
4425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 ret = ssl_prepare_handshake_step(ssl);
4427 if (ret != 0) {
4428 return ret;
4429 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 ret = mbedtls_ssl_handle_pending_alert(ssl);
4432 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004433 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 }
Jerry Yue7047812021-09-13 19:26:39 +08004435
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004436 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4437 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4438 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004440#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4442 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004443 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004446 case MBEDTLS_SSL_HELLO_REQUEST:
4447 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004448 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004449 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004450
Ronald Cron9f0fba32022-02-10 16:45:15 +01004451 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004453 break;
4454
4455 default:
4456#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4458 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4459 } else {
4460 ret = mbedtls_ssl_handshake_client_step(ssl);
4461 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004462#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004464#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004466#endif
4467 }
Jerry Yub9930e72021-08-06 17:11:51 +08004468 }
Ronald Cron6291b232023-03-08 15:51:25 +01004469#endif /* MBEDTLS_SSL_CLI_C */
4470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004471#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004473#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4474 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004476 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 ret = mbedtls_ssl_handshake_server_step(ssl);
4478 }
Ronald Cron6291b232023-03-08 15:51:25 +01004479#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4480 ret = mbedtls_ssl_handshake_server_step(ssl);
4481#else
4482 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004483#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004484 }
4485#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004486
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004488 /* handshake_step return error. And it is same
4489 * with alert_reason.
4490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (ssl->send_alert) {
4492 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004493 goto cleanup;
4494 }
4495 }
4496
4497cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004499}
4500
4501/*
4502 * Perform the SSL handshake
4503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004504int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004505{
4506 int ret = 0;
4507
Hanno Beckera817ea42020-10-20 15:20:23 +01004508 /* Sanity checks */
4509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl == NULL || ssl->conf == NULL) {
4511 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4512 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004513
Hanno Beckera817ea42020-10-20 15:20:23 +01004514#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4516 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4517 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4518 "mbedtls_ssl_set_timer_cb() for DTLS"));
4519 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004520 }
4521#endif /* MBEDTLS_SSL_PROTO_DTLS */
4522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004524
Hanno Beckera817ea42020-10-20 15:20:23 +01004525 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4527 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004530 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 }
Paul Bakker1961b702013-01-25 14:49:24 +01004532 }
4533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004537}
4538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004539#if defined(MBEDTLS_SSL_RENEGOTIATION)
4540#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004541/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004542 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004543 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004544MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004545static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004546{
Janos Follath865b3eb2019-12-16 11:46:15 +00004547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004550
4551 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004552 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4553 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4556 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4557 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004558 }
4559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004563}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004565
4566/*
4567 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568 * - any side: calling mbedtls_ssl_renegotiate(),
4569 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4570 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004571 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004572 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004573 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004576{
Janos Follath865b3eb2019-12-16 11:46:15 +00004577 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if ((ret = ssl_handshake_init(ssl)) != 0) {
4582 return ret;
4583 }
Paul Bakker48916f92012-09-16 19:57:18 +00004584
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004585 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4586 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004587#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4589 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4590 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004591 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004593 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004595 }
4596#endif
4597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4599 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4602 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4603 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004604 }
4605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004607
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004609}
4610
4611/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004612 * Renegotiate current connection on client,
4613 * or request renegotiation on server
4614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004615int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004616{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004617 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (ssl == NULL || ssl->conf == NULL) {
4620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4621 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004624 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4626 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4628 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004630 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004631
4632 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (ssl->out_left != 0) {
4634 return mbedtls_ssl_flush_output(ssl);
4635 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004638 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004641#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004642 /*
4643 * On client, either start the renegotiation process or,
4644 * if already in progress, continue the handshake
4645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4647 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4648 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004649 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004650
4651 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4652 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4653 return ret;
4654 }
4655 } else {
4656 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4657 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4658 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004659 }
4660 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004664}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004668{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004669 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4670
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004672 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004674
Valerio Setti6f0441d2023-07-03 12:11:36 +02004675#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004676#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if (ssl->handshake->group_list_heap_allocated) {
4678 mbedtls_free((void *) handshake->group_list);
4679 }
Brett Warrene0edc842021-08-17 09:53:13 +01004680 handshake->group_list = NULL;
4681#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004682#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004683
Ronald Crone68ab4f2022-10-05 12:46:29 +02004684#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004685#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ssl->handshake->sig_algs_heap_allocated) {
4687 mbedtls_free((void *) handshake->sig_algs);
4688 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004689 handshake->sig_algs = NULL;
4690#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004691#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if (ssl->handshake->certificate_request_context) {
4693 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004694 }
4695#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004696#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004697
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004698#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4700 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004701 handshake->async_in_progress = 0;
4702 }
4703#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4704
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004705#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004706#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004708#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004709 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004710#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004711#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004712#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004713#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004715#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004716 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004717#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004718#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004720#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004722#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004723#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004724 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004726#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004727
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004728#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004729#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004731 /*
4732 * Opaque keys are not stored in the handshake's data and it's the user
4733 * responsibility to destroy them. Clear ones, instead, are created by
4734 * the TLS library and should be destroyed at the same level
4735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4737 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004738 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004739 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4740#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004742#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004743#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004745 handshake->ecjpake_cache = NULL;
4746 handshake->ecjpake_cache_len = 0;
4747#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004748#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004749
Valerio Setti7aeec542023-07-05 18:57:21 +02004750#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004751 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004752 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004753 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004755#endif
4756
Ronald Cron73fe8df2022-10-05 14:31:43 +02004757#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004758#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004760 /* The maintenance of the external PSK key slot is the
4761 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (ssl->handshake->psk_opaque_is_internal) {
4763 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004764 ssl->handshake->psk_opaque_is_internal = 0;
4765 }
4766 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4767 }
Neil Armstronge952a302022-05-03 10:22:14 +02004768#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004770 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004771 }
Neil Armstronge952a302022-05-03 10:22:14 +02004772#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004773#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4776 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004777 /*
4778 * Free only the linked list wrapper, not the keys themselves
4779 * since the belong to the SNI callback
4780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004783
Gilles Peskineeccd8882020-03-10 12:19:08 +01004784#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4786 if (handshake->ecrs_peer_cert != NULL) {
4787 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4788 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004789 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004790#endif
4791
Hanno Becker75173122019-02-06 16:18:31 +00004792#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4793 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004795#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4796
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004797#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4799 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004800#endif /* MBEDTLS_SSL_CLI_C &&
4801 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004802
4803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 mbedtls_ssl_flight_free(handshake->flight);
4805 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004806#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004807
Valerio Settiea59c432023-07-25 11:14:03 +02004808#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004809 if (handshake->xxdh_psa_privkey_is_external == 0) {
4810 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 }
Valerio Settiea59c432023-07-25 11:14:03 +02004812#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004813
Ronald Cron6f135e12021-12-08 16:57:54 +01004814#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 mbedtls_ssl_transform_free(handshake->transform_handshake);
4816 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004817#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4819 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004820#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004821#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004822
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004823
4824#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4825 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4826 * processes datagrams and the fact that a datagram is allowed to have
4827 * several records in it, it is possible that the I/O buffers are not
4828 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4830 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004831#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004832
Jerry Yuba9c7272021-10-30 11:54:10 +08004833 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 mbedtls_platform_zeroize(handshake,
4835 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004836}
4837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004839{
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004841 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004846#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004847
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004848#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004849#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4850 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004852#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004854#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004857}
4858
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004859#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004860
4861#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4862#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4863#else
4864#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4865#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4866
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004867#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004868
4869#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4870#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4871#else
4872#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4873#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4874
4875#if defined(MBEDTLS_SSL_ALPN)
4876#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4877#else
4878#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4879#endif /* MBEDTLS_SSL_ALPN */
4880
4881#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4882#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4883#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4884#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4885
4886#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 ((uint32_t) ( \
4888 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4889 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4890 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4891 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4892 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4893 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4894 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4895 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004896
Chien Wong4e9683e2023-12-28 17:07:43 +08004897static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004898 MBEDTLS_VERSION_MAJOR,
4899 MBEDTLS_VERSION_MINOR,
4900 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4902 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4903 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4904 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4905 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004906};
4907
Paul Bakker5121ce52009-01-03 21:22:43 +00004908/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004909 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004910 *
4911 * The format of the serialized data is:
4912 * (in the presentation language of TLS, RFC 8446 section 3)
4913 *
4914 * // header
4915 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004916 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004917 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004918 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004919 * Note: When updating the format, remember to keep these
4920 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004921 *
4922 * // session sub-structure
4923 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4924 * // transform sub-structure
4925 * uint8 random[64]; // ServerHello.random+ClientHello.random
4926 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4927 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4928 * // fields from ssl_context
4929 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4930 * uint64 in_window_top; // DTLS: last validated record seq_num
4931 * uint64 in_window; // DTLS: bitmask for replay protection
4932 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4933 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4934 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4935 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4936 *
4937 * Note that many fields of the ssl_context or sub-structures are not
4938 * serialized, as they fall in one of the following categories:
4939 *
4940 * 1. forced value (eg in_left must be 0)
4941 * 2. pointer to dynamically-allocated memory (eg session, transform)
4942 * 3. value can be re-derived from other data (eg session keys from MS)
4943 * 4. value was temporary (eg content of input buffer)
4944 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004945 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004946int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4947 unsigned char *buf,
4948 size_t buf_len,
4949 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004950{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004951 unsigned char *p = buf;
4952 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953 size_t session_len;
4954 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004955
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004956 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004957 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4958 * this function's documentation.
4959 *
4960 * These are due to assumptions/limitations in the implementation. Some of
4961 * them are likely to stay (no handshake in progress) some might go away
4962 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004963 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004964 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4966 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4967 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004968 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (ssl->handshake != NULL) {
4970 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004972 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004973 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if (ssl->transform == NULL || ssl->session == NULL) {
4975 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4976 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004977 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004978 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (mbedtls_ssl_check_pending(ssl) != 0) {
4980 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004982 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (ssl->out_left != 0) {
4984 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4985 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004986 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004987 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4989 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004991 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004992 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4994 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4995 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004996 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004997 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4999 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005001 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005002 /* Renegotiation must not be enabled */
5003#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5005 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005007 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005008#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005009
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005010 /*
5011 * Version and format identifier
5012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 if (used <= buf_len) {
5016 memcpy(p, ssl_serialized_context_header,
5017 sizeof(ssl_serialized_context_header));
5018 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005019 }
5020
5021 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005022 * Session (length + data)
5023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5025 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5026 return ret;
5027 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005028
5029 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if (used <= buf_len) {
5031 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005032 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 ret = ssl_session_save(ssl->session, 1,
5035 p, session_len, &session_len);
5036 if (ret != 0) {
5037 return ret;
5038 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005039
5040 p += session_len;
5041 }
5042
5043 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005044 * Transform
5045 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 used += sizeof(ssl->transform->randbytes);
5047 if (used <= buf_len) {
5048 memcpy(p, ssl->transform->randbytes,
5049 sizeof(ssl->transform->randbytes));
5050 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005051 }
5052
5053#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005054 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005056 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005058 p += ssl->transform->in_cid_len;
5059
5060 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005062 p += ssl->transform->out_cid_len;
5063 }
5064#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5065
5066 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005067 * Saved fields from top-level ssl_context structure
5068 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005069 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if (used <= buf_len) {
5071 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005072 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005074
5075#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5076 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (used <= buf_len) {
5078 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005079 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005082 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005083 }
5084#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5085
5086#if defined(MBEDTLS_SSL_PROTO_DTLS)
5087 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005089 *p++ = ssl->disable_datagram_packing;
5090 }
5091#endif /* MBEDTLS_SSL_PROTO_DTLS */
5092
Jerry Yuae0b2e22021-10-08 15:21:19 +08005093 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (used <= buf_len) {
5095 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005096 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005097 }
5098
5099#if defined(MBEDTLS_SSL_PROTO_DTLS)
5100 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 if (used <= buf_len) {
5102 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005103 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005104 }
5105#endif /* MBEDTLS_SSL_PROTO_DTLS */
5106
5107#if defined(MBEDTLS_SSL_ALPN)
5108 {
5109 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111 : 0;
5112
5113 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005115 *p++ = alpn_len;
5116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (ssl->alpn_chosen != NULL) {
5118 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005119 p += alpn_len;
5120 }
5121 }
5122 }
5123#endif /* MBEDTLS_SSL_ALPN */
5124
5125 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005126 * Done
5127 */
5128 *olen = used;
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (used > buf_len) {
5131 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5132 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005137}
5138
5139/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005140 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005141 *
5142 * This internal version is wrapped by a public function that cleans up in
5143 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005144 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005146static int ssl_context_load(mbedtls_ssl_context *ssl,
5147 const unsigned char *buf,
5148 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005149{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005150 const unsigned char *p = buf;
5151 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005152 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005154#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005155 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005156#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005157
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005158 /*
5159 * The context should have been freshly setup or reset.
5160 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005161 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005162 * renegotiating, or if the user mistakenly loaded a session first.)
5163 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5165 ssl->session != NULL) {
5166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005167 }
5168
5169 /*
5170 * We can't check that the config matches the initial one, but we can at
5171 * least check it matches the requirements for serializing.
5172 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005173 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005174#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005175 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005176#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005177 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5178 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5179 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5180 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005182 }
5183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005185
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005186 /*
5187 * Check version identifier
5188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005192
5193 if (memcmp(p, ssl_serialized_context_header,
5194 sizeof(ssl_serialized_context_header)) != 0) {
5195 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5196 }
5197 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005198
5199 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005200 * Session
5201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if ((size_t) (end - p) < 4) {
5203 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5204 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005205
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005206 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005207 p += 4;
5208
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005209 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005210 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005211 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005212 ssl->session_in = ssl->session;
5213 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005214 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005215
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if ((size_t) (end - p) < session_len) {
5217 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5218 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 ret = ssl_session_load(ssl->session, 1, p, session_len);
5221 if (ret != 0) {
5222 mbedtls_ssl_session_free(ssl->session);
5223 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005224 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005225
5226 p += session_len;
5227
5228 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005229 * Transform
5230 */
5231
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005232 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005233 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005235 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005236 ssl->transform_in = ssl->transform;
5237 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005238 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005239#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005240
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005241#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5243 if (prf_func == NULL) {
5244 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5245 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005246
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005247 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5249 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5250 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 ret = ssl_tls12_populate_transform(ssl->transform,
5253 ssl->session->ciphersuite,
5254 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005255#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005257#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 prf_func,
5259 p, /* currently pointing to randbytes */
5260 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5261 ssl->conf->endpoint,
5262 ssl);
5263 if (ret != 0) {
5264 return ret;
5265 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005266#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005268
5269#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5270 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if ((size_t) (end - p) < 1) {
5272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5273 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005274
5275 ssl->transform->in_cid_len = *p++;
5276
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5278 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5279 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005280
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005282 p += ssl->transform->in_cid_len;
5283
5284 ssl->transform->out_cid_len = *p++;
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5288 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005291 p += ssl->transform->out_cid_len;
5292#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5293
5294 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005295 * Saved fields from top-level ssl_context structure
5296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if ((size_t) (end - p) < 4) {
5298 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5299 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005300
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005301 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005302 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005303
5304#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if ((size_t) (end - p) < 16) {
5306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5307 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005308
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005309 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005310 p += 8;
5311
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005312 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005313 p += 8;
5314#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5315
5316#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 if ((size_t) (end - p) < 1) {
5318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5319 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005320
5321 ssl->disable_datagram_packing = *p++;
5322#endif /* MBEDTLS_SSL_PROTO_DTLS */
5323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5326 }
5327 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5328 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005329
5330#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 if ((size_t) (end - p) < 2) {
5332 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5333 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005334
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005335 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005336 p += 2;
5337#endif /* MBEDTLS_SSL_PROTO_DTLS */
5338
5339#if defined(MBEDTLS_SSL_ALPN)
5340 {
5341 uint8_t alpn_len;
5342 const char **cur;
5343
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if ((size_t) (end - p) < 1) {
5345 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5346 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005347
5348 alpn_len = *p++;
5349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005351 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5353 if (strlen(*cur) == alpn_len &&
5354 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005355 ssl->alpn_chosen = *cur;
5356 break;
5357 }
5358 }
5359 }
5360
5361 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5363 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5364 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005365
5366 p += alpn_len;
5367 }
5368#endif /* MBEDTLS_SSL_ALPN */
5369
5370 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005371 * Forced fields from top-level ssl_context structure
5372 *
5373 * Most of them already set to the correct value by mbedtls_ssl_init() and
5374 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5375 */
5376 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005377 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005378
Hanno Becker361b10d2019-08-30 10:42:49 +01005379 /* Adjust pointers for header fields of outgoing records to
5380 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005382
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005383#if defined(MBEDTLS_SSL_PROTO_DTLS)
5384 ssl->in_epoch = 1;
5385#endif
5386
5387 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5388 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005389 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5390 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if (ssl->handshake != NULL) {
5392 mbedtls_ssl_handshake_free(ssl);
5393 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005394 ssl->handshake = NULL;
5395 }
5396
5397 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005398 * Done - should have consumed entire buffer
5399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if (p != end) {
5401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5402 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005405}
5406
5407/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005408 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005409 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005410int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5411 const unsigned char *buf,
5412 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005413{
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005415
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (ret != 0) {
5417 mbedtls_ssl_free(context);
5418 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005421}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005422#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005423
5424/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005425 * Free an SSL context
5426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005427void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005428{
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005430 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005432
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005436#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5437 size_t out_buf_len = ssl->out_buf_len;
5438#else
5439 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5440#endif
5441
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005442 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005443 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005444 }
5445
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005447#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5448 size_t in_buf_len = ssl->in_buf_len;
5449#else
5450 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5451#endif
5452
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005453 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005454 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005455 }
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 if (ssl->transform) {
5458 mbedtls_ssl_transform_free(ssl->transform);
5459 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005460 }
5461
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 if (ssl->handshake) {
5463 mbedtls_ssl_handshake_free(ssl);
5464 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005465
5466#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5468 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005469#endif
5470
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 mbedtls_ssl_session_free(ssl->session_negotiate);
5472 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005473 }
5474
Ronald Cron6f135e12021-12-08 16:57:54 +01005475#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 mbedtls_ssl_transform_free(ssl->transform_application);
5477 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005478#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005479
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if (ssl->session) {
5481 mbedtls_ssl_session_free(ssl->session);
5482 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005483 }
5484
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005485#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005487 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005488 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005489#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005490
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005491#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005493#endif
5494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005496
Paul Bakker86f04f42013-02-14 11:20:09 +01005497 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005499}
5500
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005501/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005502 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005507}
5508
Gilles Peskineae270bf2021-06-02 00:05:29 +02005509/* The selection should be the same as mbedtls_x509_crt_profile_default in
5510 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005511 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005512 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005513 * about this list.
5514 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005515static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005516#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005517 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005518#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005519#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005520 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005521#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005522#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005523 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005524#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005525#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005526 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005527#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005528#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005529 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005530#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005531#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005532 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005533#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005534#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005535 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005536#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005537#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005538 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005539#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005540#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005541 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5542 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5543 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5544 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5545 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5546#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005547 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005548};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005549
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005550static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005551 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5552 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5553 0
5554};
5555
Ronald Crone68ab4f2022-10-05 12:46:29 +02005556#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005557
Jerry Yu909df7b2022-01-22 11:56:27 +08005558/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005559 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005560 * rules SHOULD be upheld.
5561 * - No duplicate entries.
5562 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005563 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005564 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005565 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005566static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005567
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005568#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005569 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005570 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005571 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005572 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5573#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005574
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005575#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005576 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005577 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005578 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005579 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5580#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005581
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005582#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005583 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005584 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005585 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005586 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5587#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005588
Yanray Wang1136fad2023-11-22 16:54:31 +08005589#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005590 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005591#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005592
Yanray Wang1136fad2023-11-22 16:54:31 +08005593#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005594 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005595#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005596
Yanray Wang1136fad2023-11-22 16:54:31 +08005597#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005598 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005599#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005600
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005601#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005602 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005603#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005604
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005605#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005606 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005607#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005608
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005609#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005610 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005611#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005612
Gabor Mezei15b95a62022-05-09 16:37:58 +02005613 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005614};
5615
5616/* NOTICE: see above */
5617#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5618static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005619
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005620#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005621#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005623#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005624#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5625 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005626#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005627#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005629#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005630#endif /* MBEDTLS_MD_CAN_SHA512 */
5631
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005632#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005633#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005635#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005636#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5637 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005638#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005639#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005641#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005642#endif /* MBEDTLS_MD_CAN_SHA384 */
5643
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005644#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005645#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005647#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005648#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5649 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005650#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005651#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005653#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005654#endif /* MBEDTLS_MD_CAN_SHA256 */
5655
Gabor Mezei15b95a62022-05-09 16:37:58 +02005656 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005657};
5658#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005659
Jerry Yu909df7b2022-01-22 11:56:27 +08005660/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005661static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005662
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005663#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005664 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005665 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005666 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005667 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5668#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005669
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005670#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005671 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005672 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005673 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005674 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5675#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005676
Gabor Mezei15b95a62022-05-09 16:37:58 +02005677 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005678};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005679
Jerry Yu909df7b2022-01-22 11:56:27 +08005680/* NOTICE: see above */
5681#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5682static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005683
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005684#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005685#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005687#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005688#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005689
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005690#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005691#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005693#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005694#endif /* MBEDTLS_MD_CAN_SHA384 */
5695
Gabor Mezei15b95a62022-05-09 16:37:58 +02005696 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005697};
Jerry Yu909df7b2022-01-22 11:56:27 +08005698#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5699
Ronald Crone68ab4f2022-10-05 12:46:29 +02005700#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005701
Chien Wong4e9683e2023-12-28 17:07:43 +08005702static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005703#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005704 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005705#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005706#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005707 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005708#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005709 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005710};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005711
Ronald Crone68ab4f2022-10-05 12:46:29 +02005712#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005713/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005714 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005715MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005716static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005717{
5718 size_t i, j;
5719 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005720
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5722 for (j = 0; j < i; j++) {
5723 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005724 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 }
5726 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5727 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5728 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005729 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005730 }
5731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005733}
5734
Ronald Crone68ab4f2022-10-05 12:46:29 +02005735#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005736
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005737/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005738 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005740int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5741 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005742{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005743#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005745#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005746
Ronald Crone68ab4f2022-10-05 12:46:29 +02005747#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5749 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5750 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005751 }
5752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5754 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5755 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005756 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005757
5758#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5760 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5761 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005762 }
5763
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5765 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5766 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005767 }
5768#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005769#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005770
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005771 /* Use the functions here so that they are covered in tests,
5772 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 mbedtls_ssl_conf_endpoint(conf, endpoint);
5774 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005775
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005776 /*
5777 * Things that are common to all presets
5778 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005779#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005781 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5782#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5783 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5784#endif
5785 }
5786#endif
5787
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005788#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5789 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5790#endif
5791
5792#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5793 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5794#endif
5795
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005796#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005797 conf->f_cookie_write = ssl_cookie_write_dummy;
5798 conf->f_cookie_check = ssl_cookie_check_dummy;
5799#endif
5800
5801#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5802 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5803#endif
5804
Janos Follath088ce432017-04-10 12:42:31 +01005805#if defined(MBEDTLS_SSL_SRV_C)
5806 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005807 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005808#endif
5809
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005810#if defined(MBEDTLS_SSL_PROTO_DTLS)
5811 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5812 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5813#endif
5814
5815#if defined(MBEDTLS_SSL_RENEGOTIATION)
5816 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 memset(conf->renego_period, 0x00, 2);
5818 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005819#endif
5820
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005821#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005823 const unsigned char dhm_p[] =
5824 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5825 const unsigned char dhm_g[] =
5826 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5829 dhm_p, sizeof(dhm_p),
5830 dhm_g, sizeof(dhm_g))) != 0) {
5831 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005832 }
5833 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005834#endif
5835
Ronald Cron6f135e12021-12-08 16:57:54 +01005836#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005837
5838#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005839 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005840#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005841 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005842#endif
5843#endif /* MBEDTLS_SSL_EARLY_DATA */
5844
Jerry Yud0766ec2022-09-22 10:46:57 +08005845#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005846 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005848#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005849 /*
5850 * Allow all TLS 1.3 key exchange modes by default.
5851 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005852 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005853#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005856#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005857 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005858 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005859#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005861#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005863#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005864 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5865 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005866#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5867 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5868 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5869#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5870 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5871 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5872#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005874#endif
5875 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005876
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005877 /*
5878 * Preset-specific defaults
5879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005881 /*
5882 * NSA Suite B
5883 */
5884 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005885
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005886 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005887
5888#if defined(MBEDTLS_X509_CRT_PARSE_C)
5889 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005890#endif
5891
Ronald Crone68ab4f2022-10-05 12:46:29 +02005892#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005893#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005895 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005897#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005899#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005900
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005901#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005902 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005903#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005904 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005905 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005906
5907 /*
5908 * Default
5909 */
5910 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005911
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005912 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005913
5914#if defined(MBEDTLS_X509_CRT_PARSE_C)
5915 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5916#endif
5917
Ronald Crone68ab4f2022-10-05 12:46:29 +02005918#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005919#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005921 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005923#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005925#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005926
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005927#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005928 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005929#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005930 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005931
5932#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5933 conf->dhm_min_bitlen = 1024;
5934#endif
5935 }
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005938}
5939
5940/*
5941 * Free mbedtls_ssl_config
5942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005943void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005944{
5945#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 mbedtls_mpi_free(&conf->dhm_P);
5947 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005948#endif
5949
Ronald Cron73fe8df2022-10-05 14:31:43 +02005950#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005951#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005953 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5954 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005955#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005957 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005958 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005959 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005960 }
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005963 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005964 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005965 conf->psk_identity_len = 0;
5966 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005967#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005968
5969#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005971#endif
5972
Gilles Peskine449bd832023-01-11 14:50:10 +01005973 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005974}
5975
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005976#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005977 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005978/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005979 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005981unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005982{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005983#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005984 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5985 return MBEDTLS_SSL_SIG_RSA;
5986 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005987#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005988#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5990 return MBEDTLS_SSL_SIG_ECDSA;
5991 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005992#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005994}
5995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005997{
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005999 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006001 case MBEDTLS_PK_ECDSA:
6002 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006004 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006006 }
6007}
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006010{
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006012#if defined(MBEDTLS_RSA_C)
6013 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006015#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006016#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006017 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006019#endif
6020 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006022 }
6023}
Valerio Settie9646ec2023-08-02 20:02:28 +02006024#endif /* MBEDTLS_PK_C &&
6025 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006026
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006027/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006028 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006031{
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006033#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006034 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006036#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006037#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006038 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006040#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006041#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006042 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006044#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006045#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006046 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006048#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006049#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006050 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006052#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006053#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006054 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006056#endif
6057 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006059 }
6060}
6061
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006062/*
6063 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006065unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006066{
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006068#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006069 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006072#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006073 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006075#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006076#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006077 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006079#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006080#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006081 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006083#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006084#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006085 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006087#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006088#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006089 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006091#endif
6092 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006094 }
6095}
6096
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006097/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006098 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006099 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006101int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006102{
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (group_list == NULL) {
6106 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006107 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006108
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 for (; *group_list != 0; group_list++) {
6110 if (*group_list == tls_id) {
6111 return 0;
6112 }
6113 }
6114
6115 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006116}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006117
Valerio Setti49e69072023-06-27 17:27:51 +02006118#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006119/*
6120 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006122int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006123{
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006127 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006129
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006131}
Valerio Setti49e69072023-06-27 17:27:51 +02006132#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006133
Valerio Setti18c9fed2022-12-30 17:44:24 +01006134static const struct {
6135 uint16_t tls_id;
6136 mbedtls_ecp_group_id ecp_group_id;
6137 psa_ecc_family_t psa_family;
6138 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006139} tls_id_match_table[] =
6140{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006141#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006142 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006143#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006144#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006145 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006146#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006147#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006148 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006149#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006150#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006151 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006152#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006153#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006154 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006155#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006156#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006157 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006158#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006159#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006160 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006161#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006162#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006163 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006164#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006165#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006166 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006167#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006168#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006169 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006170#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006171#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006172 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006173#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006174#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006175 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006176#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006177#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006178 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006179#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006180 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006181};
6182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006184 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006186{
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6188 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006189 if (type != NULL) {
6190 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 }
6192 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006193 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006195 return PSA_SUCCESS;
6196 }
6197 }
6198
6199 return PSA_ERROR_NOT_SUPPORTED;
6200}
6201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006203{
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6205 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006206 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006208 }
6209
6210 return MBEDTLS_ECP_DP_NONE;
6211}
6212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006214{
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6216 i++) {
6217 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006218 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006220 }
6221
6222 return 0;
6223}
6224
Valerio Setti67419f02023-01-04 16:12:42 +01006225#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006226static const struct {
6227 uint16_t tls_id;
6228 const char *name;
6229} tls_id_curve_name_table[] =
6230{
Valerio Setti54e23792023-07-07 10:49:27 +02006231 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6232 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6233 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6234 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6235 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6236 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6237 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6238 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6239 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6240 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6241 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6242 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6243 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 0, NULL },
6245};
6246
Gilles Peskine449bd832023-01-11 14:50:10 +01006247const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248{
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6250 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6251 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006253 }
6254
6255 return NULL;
6256}
Valerio Setti67419f02023-01-04 16:12:42 +01006257#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006259#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006260int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6261 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6262 int cert_endpoint,
6263 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006264{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006265 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006266 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006267 const char *ext_oid;
6268 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006271 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006273 case MBEDTLS_KEY_EXCHANGE_RSA:
6274 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006275 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006276 break;
6277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006278 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6279 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6280 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6281 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006282 break;
6283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006284 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6285 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006286 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006287 break;
6288
6289 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006290 case MBEDTLS_KEY_EXCHANGE_NONE:
6291 case MBEDTLS_KEY_EXCHANGE_PSK:
6292 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6293 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006294 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006295 usage = 0;
6296 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006298 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6299 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006300 }
6301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006303 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006304 ret = -1;
6305 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006308 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6310 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006311 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006313 }
6314
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006316 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006317 ret = -1;
6318 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006319
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006321}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006322#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006323
Jerry Yu148165c2021-09-24 23:20:59 +08006324#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006325int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6326 const mbedtls_md_type_t md,
6327 unsigned char *dst,
6328 size_t dst_len,
6329 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006330{
Ronald Cronf6893e12022-01-07 22:09:01 +01006331 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6332 psa_hash_operation_t *hash_operation_to_clone;
6333 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6334
Jerry Yu148165c2021-09-24 23:20:59 +08006335 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006336
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006338#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 case MBEDTLS_MD_SHA384:
6340 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6341 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006342#endif
6343
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006344#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 case MBEDTLS_MD_SHA256:
6346 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6347 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006348#endif
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 default:
6351 goto exit;
6352 }
6353
6354 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6355 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006356 goto exit;
6357 }
6358
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6360 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006361 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006363
6364exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006365#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6366 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006367 (void) ssl;
6368#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006369 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006370}
6371#else /* MBEDTLS_USE_PSA_CRYPTO */
6372
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006373#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006374MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006375static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6376 unsigned char *dst,
6377 size_t dst_len,
6378 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006379{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006380 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006381 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 if (dst_len < 48) {
6384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6385 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006386
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006387 mbedtls_md_init(&sha384);
6388 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006389 if (ret != 0) {
6390 goto exit;
6391 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006392 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006393 if (ret != 0) {
6394 goto exit;
6395 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006396
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006397 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006398 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006399 goto exit;
6400 }
6401
6402 *olen = 48;
6403
6404exit:
6405
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006406 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006408}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006409#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006410
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006411#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006413static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6414 unsigned char *dst,
6415 size_t dst_len,
6416 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006417{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006418 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006419 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (dst_len < 32) {
6422 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6423 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006424
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006425 mbedtls_md_init(&sha256);
6426 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6427 if (ret != 0) {
6428 goto exit;
6429 }
6430 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6431 if (ret != 0) {
6432 goto exit;
6433 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006434
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006435 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6436 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006437 goto exit;
6438 }
6439
6440 *olen = 32;
6441
6442exit:
6443
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006444 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006446}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006447#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6450 const mbedtls_md_type_t md,
6451 unsigned char *dst,
6452 size_t dst_len,
6453 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006454{
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006456
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006457#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 case MBEDTLS_MD_SHA384:
6459 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006460#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006462#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 case MBEDTLS_MD_SHA256:
6464 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006465#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006468#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6469 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 (void) ssl;
6471 (void) dst;
6472 (void) dst_len;
6473 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006474#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006476 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006478}
XiaokangQian647719a2021-12-07 09:16:29 +00006479
Jerry Yu148165c2021-09-24 23:20:59 +08006480#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006481
Ronald Crone68ab4f2022-10-05 12:46:29 +02006482#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006483/* mbedtls_ssl_parse_sig_alg_ext()
6484 *
6485 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6486 * value (TLS 1.3 RFC8446):
6487 * enum {
6488 * ....
6489 * ecdsa_secp256r1_sha256( 0x0403 ),
6490 * ecdsa_secp384r1_sha384( 0x0503 ),
6491 * ecdsa_secp521r1_sha512( 0x0603 ),
6492 * ....
6493 * } SignatureScheme;
6494 *
6495 * struct {
6496 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6497 * } SignatureSchemeList;
6498 *
6499 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6500 * value (TLS 1.2 RFC5246):
6501 * enum {
6502 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6503 * sha512(6), (255)
6504 * } HashAlgorithm;
6505 *
6506 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6507 * SignatureAlgorithm;
6508 *
6509 * struct {
6510 * HashAlgorithm hash;
6511 * SignatureAlgorithm signature;
6512 * } SignatureAndHashAlgorithm;
6513 *
6514 * SignatureAndHashAlgorithm
6515 * supported_signature_algorithms<2..2^16-2>;
6516 *
6517 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6518 * generalization of the TLS 1.2 signature algorithm extension.
6519 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6520 * `SignatureScheme` field of TLS 1.3
6521 *
6522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006523int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6524 const unsigned char *buf,
6525 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006526{
6527 const unsigned char *p = buf;
6528 size_t supported_sig_algs_len = 0;
6529 const unsigned char *supported_sig_algs_end;
6530 uint16_t sig_alg;
6531 uint32_t common_idx = 0;
6532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6534 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006535 p += 2;
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 memset(ssl->handshake->received_sig_algs, 0,
6538 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006541 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 while (p < supported_sig_algs_end) {
6543 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6544 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006545 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6547 sig_alg,
6548 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006549#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6551 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6552 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006553 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006554 }
6555#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006556
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6558 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006559
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006561 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6562 common_idx += 1;
6563 }
6564 }
6565 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (p != end) {
6567 MBEDTLS_SSL_DEBUG_MSG(1,
6568 ("Signature algorithms extension length misaligned"));
6569 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6570 MBEDTLS_ERR_SSL_DECODE_ERROR);
6571 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006572 }
6573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 if (common_idx == 0) {
6575 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6576 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6577 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6578 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006579 }
6580
Gabor Mezei15b95a62022-05-09 16:37:58 +02006581 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006583}
6584
Ronald Crone68ab4f2022-10-05 12:46:29 +02006585#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006586
Jerry Yudc7bd172022-02-17 13:44:15 +08006587#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6588
6589#if defined(MBEDTLS_USE_PSA_CRYPTO)
6590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6592 mbedtls_svc_key_id_t key,
6593 psa_algorithm_t alg,
6594 const unsigned char *raw_psk, size_t raw_psk_length,
6595 const unsigned char *seed, size_t seed_length,
6596 const unsigned char *label, size_t label_length,
6597 const unsigned char *other_secret,
6598 size_t other_secret_length,
6599 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006600{
6601 psa_status_t status;
6602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 status = psa_key_derivation_setup(derivation, alg);
6604 if (status != PSA_SUCCESS) {
6605 return status;
6606 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6609 status = psa_key_derivation_input_bytes(derivation,
6610 PSA_KEY_DERIVATION_INPUT_SEED,
6611 seed, seed_length);
6612 if (status != PSA_SUCCESS) {
6613 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006614 }
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 if (other_secret != NULL) {
6617 status = psa_key_derivation_input_bytes(derivation,
6618 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6619 other_secret, other_secret_length);
6620 if (status != PSA_SUCCESS) {
6621 return status;
6622 }
6623 }
6624
6625 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006626 status = psa_key_derivation_input_bytes(
6627 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 raw_psk, raw_psk_length);
6629 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006630 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006632 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 if (status != PSA_SUCCESS) {
6634 return status;
6635 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 status = psa_key_derivation_input_bytes(derivation,
6638 PSA_KEY_DERIVATION_INPUT_LABEL,
6639 label, label_length);
6640 if (status != PSA_SUCCESS) {
6641 return status;
6642 }
6643 } else {
6644 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006645 }
6646
Gilles Peskine449bd832023-01-11 14:50:10 +01006647 status = psa_key_derivation_set_capacity(derivation, capacity);
6648 if (status != PSA_SUCCESS) {
6649 return status;
6650 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006653}
6654
Andrzej Kurek57d10632022-10-24 10:32:01 -04006655#if defined(PSA_WANT_ALG_SHA_384) || \
6656 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006657MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006658static int tls_prf_generic(mbedtls_md_type_t md_type,
6659 const unsigned char *secret, size_t slen,
6660 const char *label,
6661 const unsigned char *random, size_t rlen,
6662 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006663{
6664 psa_status_t status;
6665 psa_algorithm_t alg;
6666 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6667 psa_key_derivation_operation_t derivation =
6668 PSA_KEY_DERIVATION_OPERATION_INIT;
6669
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006671 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006673 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006675
6676 /* Normally a "secret" should be long enough to be impossible to
6677 * find by brute force, and in particular should not be empty. But
6678 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6679 * and for this use case it makes sense to have a 0-length "secret".
6680 * Since the key API doesn't allow importing a key of length 0,
6681 * keep master_key=0, which setup_psa_key_derivation() understands
6682 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006684 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6686 psa_set_key_algorithm(&key_attributes, alg);
6687 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006688
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6690 if (status != PSA_SUCCESS) {
6691 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6692 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006693 }
6694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 status = setup_psa_key_derivation(&derivation,
6696 master_key, alg,
6697 NULL, 0,
6698 random, rlen,
6699 (unsigned char const *) label,
6700 (size_t) strlen(label),
6701 NULL, 0,
6702 dlen);
6703 if (status != PSA_SUCCESS) {
6704 psa_key_derivation_abort(&derivation);
6705 psa_destroy_key(master_key);
6706 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006707 }
6708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6710 if (status != PSA_SUCCESS) {
6711 psa_key_derivation_abort(&derivation);
6712 psa_destroy_key(master_key);
6713 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006714 }
6715
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 status = psa_key_derivation_abort(&derivation);
6717 if (status != PSA_SUCCESS) {
6718 psa_destroy_key(master_key);
6719 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006720 }
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 if (!mbedtls_svc_key_id_is_null(master_key)) {
6723 status = psa_destroy_key(master_key);
6724 }
6725 if (status != PSA_SUCCESS) {
6726 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6727 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006730}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006731#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006732#else /* MBEDTLS_USE_PSA_CRYPTO */
6733
Andrzej Kurek57d10632022-10-24 10:32:01 -04006734#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006735 (defined(MBEDTLS_MD_CAN_SHA256) || \
6736 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006738static int tls_prf_generic(mbedtls_md_type_t md_type,
6739 const unsigned char *secret, size_t slen,
6740 const char *label,
6741 const unsigned char *random, size_t rlen,
6742 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006743{
6744 size_t nb;
6745 size_t i, j, k, md_len;
6746 unsigned char *tmp;
6747 size_t tmp_len = 0;
6748 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6749 const mbedtls_md_info_t *md_info;
6750 mbedtls_md_context_t md_ctx;
6751 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6752
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006754
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6756 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6757 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006758
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006760
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 tmp_len = md_len + strlen(label) + rlen;
6762 tmp = mbedtls_calloc(1, tmp_len);
6763 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006764 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6765 goto exit;
6766 }
6767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 nb = strlen(label);
6769 memcpy(tmp + md_len, label, nb);
6770 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006771 nb += rlen;
6772
6773 /*
6774 * Compute P_<hash>(secret, label + random)[0..dlen]
6775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006777 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006779
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6781 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006782 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 }
6784 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6785 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006786 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 }
6788 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6789 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006790 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 for (i = 0; i < dlen; i += md_len) {
6794 ret = mbedtls_md_hmac_reset(&md_ctx);
6795 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006796 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 }
6798 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6799 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006800 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 }
6802 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6803 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006804 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 ret = mbedtls_md_hmac_reset(&md_ctx);
6808 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 }
6811 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6812 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006813 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 }
6815 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6816 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006817 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006823 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006825 }
6826
6827exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (tmp != NULL) {
6831 mbedtls_platform_zeroize(tmp, tmp_len);
6832 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006839}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006840#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006841#endif /* MBEDTLS_USE_PSA_CRYPTO */
6842
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006843#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006844MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006845static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6846 const char *label,
6847 const unsigned char *random, size_t rlen,
6848 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006849{
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6851 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006852}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006853#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006854
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006855#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006857static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6858 const char *label,
6859 const unsigned char *random, size_t rlen,
6860 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006861{
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6863 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006864}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006865#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006866
Jerry Yuf009d862022-02-17 14:01:37 +08006867/*
6868 * Set appropriate PRF function and other SSL / TLS1.2 functions
6869 *
6870 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006871 * - hash associated with the ciphersuite (only used by TLS 1.2)
6872 *
6873 * Outputs:
6874 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6875 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006876MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006877static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6878 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006879{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006880#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006882 handshake->tls_prf = tls_prf_sha384;
6883 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6884 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006886#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006887#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006888 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006889 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006890 handshake->tls_prf = tls_prf_sha256;
6891 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6892 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6893 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006894#else
Jerry Yuf009d862022-02-17 14:01:37 +08006895 {
Jerry Yuf009d862022-02-17 14:01:37 +08006896 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006897 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006899 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006900#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006903}
Jerry Yud6ab2352022-02-17 14:03:43 +08006904
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006905/*
6906 * Compute master secret if needed
6907 *
6908 * Parameters:
6909 * [in/out] handshake
6910 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6911 * (PSA-PSK) ciphersuite_info, psk_opaque
6912 * [out] premaster (cleared)
6913 * [out] master
6914 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6915 * debug: conf->f_dbg, conf->p_dbg
6916 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006917 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006918 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006919MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006920static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6921 unsigned char *master,
6922 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006923{
6924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6925
6926 /* cf. RFC 5246, Section 8.1:
6927 * "The master secret is always exactly 48 bytes in length." */
6928 size_t const master_secret_len = 48;
6929
6930#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6931 unsigned char session_hash[48];
6932#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6933
6934 /* The label for the KDF used for key expansion.
6935 * This is either "master secret" or "extended master secret"
6936 * depending on whether the Extended Master Secret extension
6937 * is used. */
6938 char const *lbl = "master secret";
6939
Przemek Stekielae4ed302022-04-05 17:15:55 +02006940 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006941 * - If the Extended Master Secret extension is not used,
6942 * this is ClientHello.Random + ServerHello.Random
6943 * (see Sect. 8.1 in RFC 5246).
6944 * - If the Extended Master Secret extension is used,
6945 * this is the transcript of the handshake so far.
6946 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006947 unsigned char const *seed = handshake->randbytes;
6948 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006949
6950#if !defined(MBEDTLS_DEBUG_C) && \
6951 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6952 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006954 ssl = NULL; /* make sure we don't use it except for those cases */
6955 (void) ssl;
6956#endif
6957
Gilles Peskine449bd832023-01-11 14:50:10 +01006958 if (handshake->resume != 0) {
6959 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6960 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006961 }
6962
6963#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006965 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006966 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006967 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6968 if (ret != 0) {
6969 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6970 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6973 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006974 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006975#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006976
Przemek Stekiel99114f32022-04-22 11:20:09 +02006977#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006978 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006980 /* Perform PSK-to-MS expansion in a single step. */
6981 psa_status_t status;
6982 psa_algorithm_t alg;
6983 mbedtls_svc_key_id_t psk;
6984 psa_key_derivation_operation_t derivation =
6985 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006986 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006987
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006989
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006993 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006995 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006997
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006998 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007002 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007003 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007004 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007005 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007006 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007007 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007008 other_secret_len = 48;
7009 other_secret = handshake->premaster + 2;
7010 break;
7011 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007012 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007013 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7014 other_secret = handshake->premaster + 2;
7015 break;
7016 default:
7017 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007018 }
7019
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 status = setup_psa_key_derivation(&derivation, psk, alg,
7021 ssl->conf->psk, ssl->conf->psk_len,
7022 seed, seed_len,
7023 (unsigned char const *) lbl,
7024 (size_t) strlen(lbl),
7025 other_secret, other_secret_len,
7026 master_secret_len);
7027 if (status != PSA_SUCCESS) {
7028 psa_key_derivation_abort(&derivation);
7029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007030 }
7031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 status = psa_key_derivation_output_bytes(&derivation,
7033 master,
7034 master_secret_len);
7035 if (status != PSA_SUCCESS) {
7036 psa_key_derivation_abort(&derivation);
7037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007038 }
7039
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 status = psa_key_derivation_abort(&derivation);
7041 if (status != PSA_SUCCESS) {
7042 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7043 }
7044 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007045#endif
7046 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007047#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7049 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007050 psa_status_t status;
7051 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7052 psa_key_derivation_operation_t derivation =
7053 PSA_KEY_DERIVATION_OPERATION_INIT;
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007056
7057 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 status = psa_key_derivation_setup(&derivation, alg);
7060 if (status != PSA_SUCCESS) {
7061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007062 }
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 status = psa_key_derivation_set_capacity(&derivation,
7065 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7066 if (status != PSA_SUCCESS) {
7067 psa_key_derivation_abort(&derivation);
7068 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007069 }
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7072 &derivation);
7073 if (status != PSA_SUCCESS) {
7074 psa_key_derivation_abort(&derivation);
7075 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007076 }
7077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 status = psa_key_derivation_output_bytes(&derivation,
7079 handshake->premaster,
7080 handshake->pmslen);
7081 if (status != PSA_SUCCESS) {
7082 psa_key_derivation_abort(&derivation);
7083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7084 }
7085
7086 status = psa_key_derivation_abort(&derivation);
7087 if (status != PSA_SUCCESS) {
7088 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007089 }
7090 }
7091#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7093 lbl, seed, seed_len,
7094 master,
7095 master_secret_len);
7096 if (ret != 0) {
7097 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7098 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7102 handshake->premaster,
7103 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 mbedtls_platform_zeroize(handshake->premaster,
7106 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007110}
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007113{
7114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7115 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7116 ssl->handshake->ciphersuite_info;
7117
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007119
7120 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007122 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 if (ret != 0) {
7124 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7125 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007126 }
7127
7128 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 ret = ssl_compute_master(ssl->handshake,
7130 ssl->session_negotiate->master,
7131 ssl);
7132 if (ret != 0) {
7133 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7134 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007135 }
7136
7137 /* Swap the client and server random values:
7138 * - MS derivation wanted client+server (RFC 5246 8.1)
7139 * - key derivation wants server+client (RFC 5246 6.3) */
7140 {
7141 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 memcpy(tmp, ssl->handshake->randbytes, 64);
7143 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7144 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7145 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007146 }
7147
7148 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7150 ssl->session_negotiate->ciphersuite,
7151 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007152#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007154#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 ssl->handshake->tls_prf,
7156 ssl->handshake->randbytes,
7157 ssl->tls_version,
7158 ssl->conf->endpoint,
7159 ssl);
7160 if (ret != 0) {
7161 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7162 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007163 }
7164
7165 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7167 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007170
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007172}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007175{
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007177#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007178 case MBEDTLS_SSL_HASH_SHA384:
7179 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7180 break;
7181#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007182#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007183 case MBEDTLS_SSL_HASH_SHA256:
7184 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7185 break;
7186#endif
7187 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007189 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007190#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7191 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007192 (void) ssl;
7193#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007195}
7196
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007197#if defined(MBEDTLS_USE_PSA_CRYPTO)
7198static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7199 const psa_hash_operation_t *hs_op,
7200 size_t buffer_size,
7201 unsigned char *hash,
7202 size_t *hlen)
7203{
7204 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007205 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007206
7207#if !defined(MBEDTLS_DEBUG_C)
7208 (void) ssl;
7209#endif
7210 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007211 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007212 if (status != PSA_SUCCESS) {
7213 goto exit;
7214 }
7215
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007216 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007217 if (status != PSA_SUCCESS) {
7218 goto exit;
7219 }
7220
7221 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7222 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7223
7224exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007225 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007226 return mbedtls_md_error_from_psa(status);
7227}
7228#else
7229static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7230 const mbedtls_md_context_t *hs_ctx,
7231 unsigned char *hash,
7232 size_t *hlen)
7233{
7234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007235 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007236
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007237 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007238
7239#if !defined(MBEDTLS_DEBUG_C)
7240 (void) ssl;
7241#endif
7242 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7243
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007244 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007245 if (ret != 0) {
7246 goto exit;
7247 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007248 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007249 if (ret != 0) {
7250 goto exit;
7251 }
7252
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007253 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007254 if (ret != 0) {
7255 goto exit;
7256 }
7257
7258 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7259
7260 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7262
7263exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007264 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007265 return ret;
7266}
7267#endif /* MBEDTLS_USE_PSA_CRYPTO */
7268
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007269#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007270int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7271 unsigned char *hash,
7272 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007273{
7274#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007275 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7276 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007277#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007278 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7279 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007280#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007281}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007282#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007283
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007284#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007285int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7286 unsigned char *hash,
7287 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007288{
7289#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007290 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7291 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007292#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007293 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7294 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007295#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007296}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007297#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007298
Neil Armstrong80f6f322022-05-03 17:56:38 +02007299#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7300 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007301int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007302{
7303 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007305 const unsigned char *psk = NULL;
7306 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007310 /*
7311 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007312 * checked before calling this function.
7313 *
7314 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007315 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007316 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7318 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7319 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007320 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007321 }
7322
7323 /*
7324 * PMS = struct {
7325 * opaque other_secret<0..2^16-1>;
7326 * opaque psk<0..2^16-1>;
7327 * };
7328 * with "other_secret" depending on the particular key exchange
7329 */
7330#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7332 if (end - p < 2) {
7333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7334 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007337 p += 2;
7338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if (end < p || (size_t) (end - p) < psk_len) {
7340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7341 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007344 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007346#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7347#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007349 /*
7350 * other_secret already set by the ClientKeyExchange message,
7351 * and is 48 bytes long
7352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (end - p < 2) {
7354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7355 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007356
7357 *p++ = 0;
7358 *p++ = 48;
7359 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007361#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7362#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007364 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7365 size_t len;
7366
7367 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007369 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7371 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7372 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007373 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007375 p += 2 + len;
7376
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7378 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007379#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007380#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007382 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7383 size_t zlen;
7384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007386 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7388 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7389 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007390 }
7391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007393 p += 2 + zlen;
7394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7396 MBEDTLS_DEBUG_ECDH_Z);
7397 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007398#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007399 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7401 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007402 }
7403
7404 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (end - p < 2) {
7406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7407 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007410 p += 2;
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (end < p || (size_t) (end - p) < psk_len) {
7413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7414 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007415
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007417 p += psk_len;
7418
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007419 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007422}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007423#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007424
7425#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007427static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007428
7429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007430int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007431{
7432 /* If renegotiation is not enforced, retransmit until we would reach max
7433 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007435 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7436 unsigned char doublings = 1;
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007439 ++doublings;
7440 ratio >>= 1;
7441 }
7442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 if (++ssl->renego_records_seen > doublings) {
7444 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7445 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007446 }
7447 }
7448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007450}
7451#endif
7452#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007453
Jerry Yud9526692022-02-17 14:23:47 +08007454/*
7455 * Handshake functions
7456 */
7457#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7458/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007459int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007460{
7461 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7462 ssl->handshake->ciphersuite_info;
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7467 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007468 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007470 }
7471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7473 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007474}
7475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007477{
7478 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7479 ssl->handshake->ciphersuite_info;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7484 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007485 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7490 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007491}
7492
7493#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7494/* Some certificate support -> implement write and parse */
7495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007497{
7498 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7499 size_t i, n;
7500 const mbedtls_x509_crt *crt;
7501 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7502 ssl->handshake->ciphersuite_info;
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7507 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007508 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007510 }
7511
7512#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7514 if (ssl->handshake->client_auth == 0) {
7515 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007516 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007518 }
7519 }
7520#endif /* MBEDTLS_SSL_CLI_C */
7521#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7523 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007524 /* Should never happen because we shouldn't have picked the
7525 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007527 }
7528 }
7529#endif
7530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007532
7533 /*
7534 * 0 . 0 handshake type
7535 * 1 . 3 handshake length
7536 * 4 . 6 length of all certs
7537 * 7 . 9 length of cert. 1
7538 * 10 . n-1 peer certificate
7539 * n . n+2 length of cert. 2
7540 * n+3 . ... upper level cert, etc.
7541 */
7542 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007546 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7548 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7549 " > %" MBEDTLS_PRINTF_SIZET,
7550 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7551 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007552 }
7553
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7555 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7556 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007559 i += n; crt = crt->next;
7560 }
7561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7563 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7564 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007565
7566 ssl->out_msglen = i;
7567 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7568 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7569
7570 ssl->state++;
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7573 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7574 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007575 }
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007580}
7581
7582#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7583
7584#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007585MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007586static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7587 unsigned char *crt_buf,
7588 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007589{
7590 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (peer_crt == NULL) {
7593 return -1;
7594 }
Jerry Yud9526692022-02-17 14:23:47 +08007595
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (peer_crt->raw.len != crt_buf_len) {
7597 return -1;
7598 }
Jerry Yud9526692022-02-17 14:23:47 +08007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007601}
7602#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007603MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007604static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7605 unsigned char *crt_buf,
7606 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007607{
7608 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7609 unsigned char const * const peer_cert_digest =
7610 ssl->session->peer_cert_digest;
7611 mbedtls_md_type_t const peer_cert_digest_type =
7612 ssl->session->peer_cert_digest_type;
7613 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007615 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7616 size_t digest_len;
7617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (peer_cert_digest == NULL || digest_info == NULL) {
7619 return -1;
7620 }
Jerry Yud9526692022-02-17 14:23:47 +08007621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 digest_len = mbedtls_md_get_size(digest_info);
7623 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7624 return -1;
7625 }
Jerry Yud9526692022-02-17 14:23:47 +08007626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7628 if (ret != 0) {
7629 return -1;
7630 }
Jerry Yud9526692022-02-17 14:23:47 +08007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007633}
7634#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7635#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7636
7637/*
7638 * Once the certificate message is read, parse it into a cert chain and
7639 * perform basic checks, but leave actual verification to the caller
7640 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007641MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007642static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7643 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007644{
7645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7646#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007648#endif
7649 size_t i, n;
7650 uint8_t alert;
7651
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7653 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7654 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7655 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7656 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007657 }
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7660 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7661 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7662 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007663 }
7664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7666 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7667 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7668 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7669 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007670 }
7671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007673
7674 /*
7675 * Same message structure as in mbedtls_ssl_write_certificate()
7676 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007677 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (ssl->in_msg[i] != 0 ||
7680 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7681 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7682 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7683 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7684 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007685 }
7686
7687 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7688 i += 3;
7689
7690 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007692 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 if (i + 3 > ssl->in_hslen) {
7694 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7695 mbedtls_ssl_send_alert_message(ssl,
7696 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7697 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7698 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007699 }
7700 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7701 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (ssl->in_msg[i] != 0) {
7703 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7704 mbedtls_ssl_send_alert_message(ssl,
7705 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7706 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7707 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007708 }
7709
7710 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007711 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007712 i += 3;
7713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 if (n < 128 || i + n > ssl->in_hslen) {
7715 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7716 mbedtls_ssl_send_alert_message(ssl,
7717 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7718 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7719 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007720 }
7721
7722 /* Check if we're handling the first CRT in the chain. */
7723#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007725 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007727 /* During client-side renegotiation, check that the server's
7728 * end-CRTs hasn't changed compared to the initial handshake,
7729 * mitigating the triple handshake attack. On success, reuse
7730 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7732 if (ssl_check_peer_crt_unchanged(ssl,
7733 &ssl->in_msg[i],
7734 n) != 0) {
7735 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7736 mbedtls_ssl_send_alert_message(ssl,
7737 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7738 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7739 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007740 }
7741
7742 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007744 }
7745#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7746
7747 /* Parse the next certificate in the chain. */
7748#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007750#else
7751 /* If we don't need to store the CRT chain permanently, parse
7752 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007754#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007756 case 0: /*ok*/
7757 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7758 /* Ignore certificate with an unknown algorithm: maybe a
7759 prior certificate was already trusted. */
7760 break;
7761
7762 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7763 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7764 goto crt_parse_der_failed;
7765
7766 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7767 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7768 goto crt_parse_der_failed;
7769
7770 default:
7771 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007772crt_parse_der_failed:
7773 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7774 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7775 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007776 }
7777
7778 i += n;
7779 }
7780
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7782 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007783}
7784
7785#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007786MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007787static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007788{
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7790 return -1;
7791 }
Jerry Yud9526692022-02-17 14:23:47 +08007792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007794 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7795 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7797 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7798 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007801}
7802#endif /* MBEDTLS_SSL_SRV_C */
7803
7804/* Check if a certificate message is expected.
7805 * Return either
7806 * - SSL_CERTIFICATE_EXPECTED, or
7807 * - SSL_CERTIFICATE_SKIP
7808 * indicating whether a Certificate message is expected or not.
7809 */
7810#define SSL_CERTIFICATE_EXPECTED 0
7811#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007812MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007813static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7814 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007815{
7816 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7817 ssl->handshake->ciphersuite_info;
7818
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7820 return SSL_CERTIFICATE_SKIP;
7821 }
Jerry Yud9526692022-02-17 14:23:47 +08007822
7823#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7825 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7826 return SSL_CERTIFICATE_SKIP;
7827 }
Jerry Yud9526692022-02-17 14:23:47 +08007828
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007830 ssl->session_negotiate->verify_result =
7831 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007833 }
7834 }
7835#else
7836 ((void) authmode);
7837#endif /* MBEDTLS_SSL_SRV_C */
7838
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007840}
7841
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007842MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007843static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7844 int authmode,
7845 mbedtls_x509_crt *chain,
7846 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007847{
7848 int ret = 0;
7849 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7850 ssl->handshake->ciphersuite_info;
7851 int have_ca_chain = 0;
7852
7853 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7854 void *p_vrfy;
7855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7857 return 0;
7858 }
Jerry Yud9526692022-02-17 14:23:47 +08007859
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 if (ssl->f_vrfy != NULL) {
7861 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007862 f_vrfy = ssl->f_vrfy;
7863 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 } else {
7865 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007866 f_vrfy = ssl->conf->f_vrfy;
7867 p_vrfy = ssl->conf->p_vrfy;
7868 }
7869
7870 /*
7871 * Main check: verify certificate
7872 */
7873#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007875 ((void) rs_ctx);
7876 have_ca_chain = 1;
7877
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007879 ret = mbedtls_x509_crt_verify_with_ca_cb(
7880 chain,
7881 ssl->conf->f_ca_cb,
7882 ssl->conf->p_ca_cb,
7883 ssl->conf->cert_profile,
7884 ssl->hostname,
7885 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 f_vrfy, p_vrfy);
7887 } else
Jerry Yud9526692022-02-17 14:23:47 +08007888#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7889 {
7890 mbedtls_x509_crt *ca_chain;
7891 mbedtls_x509_crl *ca_crl;
7892
7893#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007895 ca_chain = ssl->handshake->sni_ca_chain;
7896 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 } else
Jerry Yud9526692022-02-17 14:23:47 +08007898#endif
7899 {
7900 ca_chain = ssl->conf->ca_chain;
7901 ca_crl = ssl->conf->ca_crl;
7902 }
7903
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007905 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 }
Jerry Yud9526692022-02-17 14:23:47 +08007907
7908 ret = mbedtls_x509_crt_verify_restartable(
7909 chain,
7910 ca_chain, ca_crl,
7911 ssl->conf->cert_profile,
7912 ssl->hostname,
7913 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007915 }
7916
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 if (ret != 0) {
7918 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007919 }
7920
7921#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7923 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7924 }
Jerry Yud9526692022-02-17 14:23:47 +08007925#endif
7926
7927 /*
7928 * Secondary checks: always done, but change 'ret' only if it was 0
7929 */
7930
Valerio Settiacd32c02023-06-29 18:06:29 +02007931#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007932 {
7933 const mbedtls_pk_context *pk = &chain->pk;
7934
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007935 /* If certificate uses an EC key, make sure the curve is OK.
7936 * This is a public key, so it can't be opaque, so can_do() is a good
7937 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007939 /* and in the unlikely case the above assumption no longer holds
7940 * we are making sure that pk_ec() here does not return a NULL
7941 */
Valerio Settif9362b72023-11-29 08:42:27 +01007942 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007943 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7944 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007946 }
Valerio Setti97207782023-05-18 18:59:06 +02007947 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007948 ssl->session_negotiate->verify_result |=
7949 MBEDTLS_X509_BADCERT_BAD_KEY;
7950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7952 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007953 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007955 }
Jerry Yud9526692022-02-17 14:23:47 +08007956 }
7957 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007958#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 if (mbedtls_ssl_check_cert_usage(chain,
7961 ciphersuite_info,
7962 !ssl->conf->endpoint,
7963 &ssl->session_negotiate->verify_result) != 0) {
7964 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7965 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007966 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 }
Jerry Yud9526692022-02-17 14:23:47 +08007968 }
7969
7970 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7971 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7972 * with details encoded in the verification flags. All other kinds
7973 * of error codes, including those from the user provided f_vrfy
7974 * functions, are treated as fatal and lead to a failure of
7975 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7977 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7978 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007979 ret = 0;
7980 }
7981
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7983 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007984 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7985 }
7986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007988 uint8_t alert;
7989
7990 /* The certificate may have been rejected for several reasons.
7991 Pick one and send the corresponding alert. Which alert to send
7992 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007994 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007996 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007998 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008000 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008002 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008004 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008006 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008008 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008010 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008012 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008014 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 }
8016 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8017 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008018 }
8019
8020#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 if (ssl->session_negotiate->verify_result != 0) {
8022 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8023 (unsigned int) ssl->session_negotiate->verify_result));
8024 } else {
8025 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008026 }
8027#endif /* MBEDTLS_DEBUG_C */
8028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008030}
8031
8032#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008033MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008034static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8035 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008036{
8037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8038 /* Remember digest of the peer's end-CRT. */
8039 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8041 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8042 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8043 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8044 mbedtls_ssl_send_alert_message(ssl,
8045 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8046 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008049 }
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 ret = mbedtls_md(mbedtls_md_info_from_type(
8052 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8053 start, len,
8054 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008055
8056 ssl->session_negotiate->peer_cert_digest_type =
8057 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8058 ssl->session_negotiate->peer_cert_digest_len =
8059 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8060
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008062}
8063
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008064MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008065static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8066 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008067{
8068 unsigned char *end = start + len;
8069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8070
8071 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8073 ret = mbedtls_pk_parse_subpubkey(&start, end,
8074 &ssl->handshake->peer_pubkey);
8075 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008076 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008078 }
8079
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008081}
8082#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008085{
8086 int ret = 0;
8087 int crt_expected;
8088#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8089 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8090 ? ssl->handshake->sni_authmode
8091 : ssl->conf->authmode;
8092#else
8093 const int authmode = ssl->conf->authmode;
8094#endif
8095 void *rs_ctx = NULL;
8096 mbedtls_x509_crt *chain = NULL;
8097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8101 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8102 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008103 goto exit;
8104 }
8105
8106#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 if (ssl->handshake->ecrs_enabled &&
8108 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008109 chain = ssl->handshake->ecrs_peer_cert;
8110 ssl->handshake->ecrs_peer_cert = NULL;
8111 goto crt_verify;
8112 }
8113#endif
8114
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008116 /* mbedtls_ssl_read_record may have sent an alert already. We
8117 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008119 goto exit;
8120 }
8121
8122#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008124 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008127 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 }
Jerry Yud9526692022-02-17 14:23:47 +08008129
8130 goto exit;
8131 }
8132#endif /* MBEDTLS_SSL_SRV_C */
8133
8134 /* Clear existing peer CRT structure in case we tried to
8135 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8139 if (chain == NULL) {
8140 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8141 sizeof(mbedtls_x509_crt)));
8142 mbedtls_ssl_send_alert_message(ssl,
8143 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8144 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008145
8146 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8147 goto exit;
8148 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008150
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 ret = ssl_parse_certificate_chain(ssl, chain);
8152 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008153 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 }
Jerry Yud9526692022-02-17 14:23:47 +08008155
8156#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008158 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 }
Jerry Yud9526692022-02-17 14:23:47 +08008160
8161crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008163 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 }
Jerry Yud9526692022-02-17 14:23:47 +08008165#endif
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 ret = ssl_parse_certificate_verify(ssl, authmode,
8168 chain, rs_ctx);
8169 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008170 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 }
Jerry Yud9526692022-02-17 14:23:47 +08008172
8173#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8174 {
8175 unsigned char *crt_start, *pk_start;
8176 size_t crt_len, pk_len;
8177
8178 /* We parse the CRT chain without copying, so
8179 * these pointers point into the input buffer,
8180 * and are hence still valid after freeing the
8181 * CRT chain. */
8182
8183 crt_start = chain->raw.p;
8184 crt_len = chain->raw.len;
8185
8186 pk_start = chain->pk_raw.p;
8187 pk_len = chain->pk_raw.len;
8188
8189 /* Free the CRT structures before computing
8190 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 mbedtls_x509_crt_free(chain);
8192 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008193 chain = NULL;
8194
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8196 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 }
Jerry Yud9526692022-02-17 14:23:47 +08008199
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8201 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 }
Jerry Yud9526692022-02-17 14:23:47 +08008204 }
8205#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8206 /* Pass ownership to session structure. */
8207 ssl->session_negotiate->peer_cert = chain;
8208 chain = NULL;
8209#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8210
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008212
8213exit:
8214
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008216 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 }
Jerry Yud9526692022-02-17 14:23:47 +08008218
8219#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008221 ssl->handshake->ecrs_peer_cert = chain;
8222 chain = NULL;
8223 }
8224#endif
8225
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 if (chain != NULL) {
8227 mbedtls_x509_crt_free(chain);
8228 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008229 }
8230
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008232}
8233#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8234
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008235static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8236 unsigned char *padbuf, size_t hlen,
8237 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008238{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008239 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008240 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008241#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008242 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008243 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008244 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008245 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008246#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008247 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008248 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008249 mbedtls_md_context_t cloned_ctx;
8250 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008251#endif
8252
8253 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008255 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008257
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008259 ? "client finished"
8260 : "server finished";
8261
8262#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008263 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008264
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008265 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008267 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008268 }
8269
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008270 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008272 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008273 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008274 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008275#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008276 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008277
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008278 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008279 if (ret != 0) {
8280 goto exit;
8281 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008282 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008283 if (ret != 0) {
8284 goto exit;
8285 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008286
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008287 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008288 if (ret != 0) {
8289 goto exit;
8290 }
8291#endif /* MBEDTLS_USE_PSA_CRYPTO */
8292
8293 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8294
Jerry Yu615bd6f2022-02-17 14:25:15 +08008295 /*
8296 * TLSv1.2:
8297 * hash = PRF( master, finished_label,
8298 * Hash( handshake ) )[0.11]
8299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008301 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008302
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008304
Paul Elliottecb95be2023-08-11 16:41:04 +01008305 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008306
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008307 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008308
8309exit:
8310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008311 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008312 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008313#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008314 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008315 return ret;
8316#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008317}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008318
8319#if defined(MBEDTLS_MD_CAN_SHA256)
8320static int ssl_calc_finished_tls_sha256(
8321 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8322{
8323 unsigned char padbuf[32];
8324 return ssl_calc_finished_tls_generic(ssl,
8325#if defined(MBEDTLS_USE_PSA_CRYPTO)
8326 &ssl->handshake->fin_sha256_psa,
8327#else
8328 &ssl->handshake->fin_sha256,
8329#endif
8330 padbuf, sizeof(padbuf),
8331 buf, from);
8332}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008333#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008334
Jerry Yub7ba49e2022-02-17 14:25:53 +08008335
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008336#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008337static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008339{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008340 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008341 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008342#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008343 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008344#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008345 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008346#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008347 padbuf, sizeof(padbuf),
8348 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008349}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008350#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008351
Gilles Peskine449bd832023-01-11 14:50:10 +01008352void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008353{
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008355
8356 /*
8357 * Free our handshake params
8358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 mbedtls_ssl_handshake_free(ssl);
8360 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008361 ssl->handshake = NULL;
8362
8363 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008364 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 if (ssl->transform) {
8367 mbedtls_ssl_transform_free(ssl->transform);
8368 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008369 }
8370 ssl->transform = ssl->transform_negotiate;
8371 ssl->transform_negotiate = NULL;
8372
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008374}
8375
Gilles Peskine449bd832023-01-11 14:50:10 +01008376void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008377{
8378 int resume = ssl->handshake->resume;
8379
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008381
8382#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008384 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8385 ssl->renego_records_seen = 0;
8386 }
8387#endif
8388
8389 /*
8390 * Free the previous session and switch in the current one
8391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008393#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8394 /* RFC 7366 3.1: keep the EtM state */
8395 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008397#endif
8398
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 mbedtls_ssl_session_free(ssl->session);
8400 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008401 }
8402 ssl->session = ssl->session_negotiate;
8403 ssl->session_negotiate = NULL;
8404
8405 /*
8406 * Add cache entry
8407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008408 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008409 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 resume == 0) {
8411 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8412 ssl->session->id,
8413 ssl->session->id_len,
8414 ssl->session) != 0) {
8415 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8416 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008417 }
8418
8419#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8421 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008422 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008423 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008424
8425 /* Keep last flight around in case we need to resend it:
8426 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008427 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8428 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008429#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008431
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008432 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008433
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008435}
8436
Gilles Peskine449bd832023-01-11 14:50:10 +01008437int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008438{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008439 int ret;
8440 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008445
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008446 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8447 if (ret != 0) {
8448 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8449 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008450
8451 /*
8452 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8453 * may define some other value. Currently (early 2016), no defined
8454 * ciphersuite does this (and this is unlikely to change as activity has
8455 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8456 */
8457 hash_len = 12;
8458
8459#if defined(MBEDTLS_SSL_RENEGOTIATION)
8460 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008462#endif
8463
8464 ssl->out_msglen = 4 + hash_len;
8465 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8466 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8467
8468 /*
8469 * In case of session resuming, invert the client and server
8470 * ChangeCipherSpec messages order.
8471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008473#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008475 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008477#endif
8478#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008480 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008482#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008484 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008486
8487 /*
8488 * Switch to our negotiated transform and session parameters for outbound
8489 * data.
8490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008492
8493#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008495 unsigned char i;
8496
8497 /* Remember current epoch settings for resending */
8498 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8500 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008501
8502 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008504
8505
8506 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 for (i = 2; i > 0; i--) {
8508 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008509 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 }
8511 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008512
8513 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 if (i == 0) {
8515 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8516 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008517 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008519#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008521
8522 ssl->transform_out = ssl->transform_negotiate;
8523 ssl->session_out = ssl->session_negotiate;
8524
8525#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8527 mbedtls_ssl_send_flight_completed(ssl);
8528 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008529#endif
8530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8532 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8533 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008534 }
8535
8536#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8538 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8539 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8540 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008541 }
8542#endif
8543
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008547}
8548
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008549#define SSL_MAX_HASH_LEN 12
8550
Gilles Peskine449bd832023-01-11 14:50:10 +01008551int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008552{
8553 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8554 unsigned int hash_len = 12;
8555 unsigned char buf[SSL_MAX_HASH_LEN];
8556
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008558
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008559 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8560 if (ret != 0) {
8561 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8562 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008563
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8565 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008566 goto exit;
8567 }
8568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8570 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8571 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8572 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008573 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8574 goto exit;
8575 }
8576
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8578 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8579 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008580 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8581 goto exit;
8582 }
8583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8585 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8586 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8587 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008588 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8589 goto exit;
8590 }
8591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8593 buf, hash_len) != 0) {
8594 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8595 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8596 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008597 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8598 goto exit;
8599 }
8600
8601#if defined(MBEDTLS_SSL_RENEGOTIATION)
8602 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008604#endif
8605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008607#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008609 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008611#endif
8612#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008614 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008616#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008618 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008620
8621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8623 mbedtls_ssl_recv_flight_completed(ssl);
8624 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008625#endif
8626
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008628
8629exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 mbedtls_platform_zeroize(buf, hash_len);
8631 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008632}
8633
Jerry Yu392112c2022-02-17 14:34:10 +08008634#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8635/*
8636 * Helper to get TLS 1.2 PRF from ciphersuite
8637 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8638 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008639static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008640{
Jerry Yu392112c2022-02-17 14:34:10 +08008641 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008643#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8645 return tls_prf_sha384;
8646 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008647#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008648#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008649 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8651 return tls_prf_sha256;
8652 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008653 }
8654#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008655#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8656 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008657 (void) ciphersuite_info;
8658#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008659
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008661}
8662#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008665{
8666 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008667#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 if (tls_prf == tls_prf_sha384) {
8669 return MBEDTLS_SSL_TLS_PRF_SHA384;
8670 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008671#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008672#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 if (tls_prf == tls_prf_sha256) {
8674 return MBEDTLS_SSL_TLS_PRF_SHA256;
8675 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008676#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008678}
8679
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008680/*
8681 * Populate a transform structure with session keys and all the other
8682 * necessary information.
8683 *
8684 * Parameters:
8685 * - [in/out]: transform: structure to populate
8686 * [in] must be just initialised with mbedtls_ssl_transform_init()
8687 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8688 * - [in] ciphersuite
8689 * - [in] master
8690 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008691 * - [in] tls_prf: pointer to PRF to use for key derivation
8692 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008693 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008694 * - [in] endpoint: client or server
8695 * - [in] ssl: used for:
8696 * - ssl->conf->{f,p}_export_keys
8697 * [in] optionally used for:
8698 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8699 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008701static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8702 int ciphersuite,
8703 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008704#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008706#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 ssl_tls_prf_t tls_prf,
8708 const unsigned char randbytes[64],
8709 mbedtls_ssl_protocol_version tls_version,
8710 unsigned endpoint,
8711 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008712{
8713 int ret = 0;
8714 unsigned char keyblk[256];
8715 unsigned char *key1;
8716 unsigned char *key2;
8717 unsigned char *mac_enc;
8718 unsigned char *mac_dec;
8719 size_t mac_key_len = 0;
8720 size_t iv_copy_len;
8721 size_t keylen;
8722 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008723 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008724#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008725 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008726 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008727#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008728
8729#if defined(MBEDTLS_USE_PSA_CRYPTO)
8730 psa_key_type_t key_type;
8731 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8732 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008733 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008734 size_t key_bits;
8735 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8736#endif
8737
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008738 /*
8739 * Some data just needs copying into the structure
8740 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008741#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008742 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008743#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008744 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008745
8746#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008748#endif
8749
8750#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008752 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8753 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008755 }
8756#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8757
8758 /*
8759 * Get various info structures
8760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8762 if (ciphersuite_info == NULL) {
8763 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8764 ciphersuite));
8765 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008766 }
8767
Neil Armstrongab555e02022-04-04 11:07:59 +02008768 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008769#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008771#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008772 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008773
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008775 transform->taglen =
8776 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008778
8779#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008780 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 transform->taglen,
8782 &alg,
8783 &key_type,
8784 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008785 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008786 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008787 goto end;
8788 }
8789#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008790 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008791 if (cipher_info == NULL) {
8792 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8793 ciphersuite_info->cipher));
8794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008795 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008796#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008797
Neil Armstronge4512952022-03-08 09:08:22 +01008798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008799 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008801 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 (unsigned) ciphersuite_info->mac));
8803 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008804 }
8805#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008806 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 if (md_info == NULL) {
8808 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8809 (unsigned) ciphersuite_info->mac));
8810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811 }
Neil Armstronge4512952022-03-08 09:08:22 +01008812#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008813
8814#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8815 /* Copy own and peer's CID if the use of the CID
8816 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8818 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819
8820 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8822 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8823 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008824
8825 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008826 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8827 ssl->handshake->peer_cid_len);
8828 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8829 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008830 }
8831#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8832
8833 /*
8834 * Compute key block using the PRF
8835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8837 if (ret != 0) {
8838 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8839 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840 }
8841
Gilles Peskine449bd832023-01-11 14:50:10 +01008842 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8843 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8844 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8845 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8846 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008847
8848 /*
8849 * Determine the appropriate key, IV and MAC length.
8850 */
8851
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008852#if defined(MBEDTLS_USE_PSA_CRYPTO)
8853 keylen = PSA_BITS_TO_BYTES(key_bits);
8854#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008856#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008857
Valerio Settie5707042023-10-11 11:54:42 +02008858#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008860 size_t explicit_ivlen;
8861
8862 transform->maclen = 0;
8863 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008864
8865 /* All modes haves 96-bit IVs, but the length of the static parts vary
8866 * with mode and version:
8867 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8868 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8869 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8870 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8871 * sequence number).
8872 */
8873 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008874
8875 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008876#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008878#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8880 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008881#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008882
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008884 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008886 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008888
8889 /* Minimum length of encrypted record */
8890 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8891 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 } else
Valerio Settie5707042023-10-11 11:54:42 +02008893#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008894#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008896 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008898#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008900#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008901 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008902#endif /* MBEDTLS_USE_PSA_CRYPTO */
8903
8904#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008905 /* Get MAC length */
8906 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8907#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008908 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8910 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8911 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008912 goto end;
8913 }
8914
8915 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008917#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008918 transform->maclen = mac_key_len;
8919
8920 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008921#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008923#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008924 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008925#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008926
8927 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008929 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008931 /*
8932 * GenericBlockCipher:
8933 * 1. if EtM is in use: one block plus MAC
8934 * otherwise: * first multiple of blocklen greater than maclen
8935 * 2. IV
8936 */
8937#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008939 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 + block_size;
8941 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008942#endif
8943 {
8944 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008945 + block_size
8946 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008947 }
8948
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008950 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008951 } else {
8952 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008953 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8954 goto end;
8955 }
8956 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008958#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8959 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8961 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008962 }
8963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8965 (unsigned) keylen,
8966 (unsigned) transform->minlen,
8967 (unsigned) transform->ivlen,
8968 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008969
8970 /*
8971 * Finally setup the cipher contexts, IVs and MAC secrets.
8972 */
8973#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008974 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008975 key1 = keyblk + mac_key_len * 2;
8976 key2 = keyblk + mac_key_len * 2 + keylen;
8977
8978 mac_enc = keyblk;
8979 mac_dec = keyblk + mac_key_len;
8980
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 iv_copy_len = (transform->fixed_ivlen) ?
8982 transform->fixed_ivlen : transform->ivlen;
8983 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8984 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8985 iv_copy_len);
8986 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008987#endif /* MBEDTLS_SSL_CLI_C */
8988#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008990 key1 = keyblk + mac_key_len * 2 + keylen;
8991 key2 = keyblk + mac_key_len * 2;
8992
8993 mac_enc = keyblk + mac_key_len;
8994 mac_dec = keyblk;
8995
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 iv_copy_len = (transform->fixed_ivlen) ?
8997 transform->fixed_ivlen : transform->ivlen;
8998 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8999 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9000 iv_copy_len);
9001 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009002#endif /* MBEDTLS_SSL_SRV_C */
9003 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009005 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9006 goto end;
9007 }
9008
Paul Elliott4fb19552023-10-18 12:15:30 +01009009 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 ssl->f_export_keys(ssl->p_export_keys,
9011 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9012 master, 48,
9013 randbytes + 32,
9014 randbytes,
9015 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009016 }
9017
9018#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009019 transform->psa_alg = alg;
9020
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9023 psa_set_key_algorithm(&attributes, alg);
9024 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009025
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 if ((status = psa_import_key(&attributes,
9027 key1,
9028 PSA_BITS_TO_BYTES(key_bits),
9029 &transform->psa_key_enc)) != PSA_SUCCESS) {
9030 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009031 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009033 goto end;
9034 }
9035
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009037
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 if ((status = psa_import_key(&attributes,
9039 key2,
9040 PSA_BITS_TO_BYTES(key_bits),
9041 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009042 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009044 goto end;
9045 }
9046 }
9047#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9049 cipher_info)) != 0) {
9050 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009051 goto end;
9052 }
9053
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9055 cipher_info)) != 0) {
9056 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009057 goto end;
9058 }
9059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9061 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9062 MBEDTLS_ENCRYPT)) != 0) {
9063 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009064 goto end;
9065 }
9066
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9068 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9069 MBEDTLS_DECRYPT)) != 0) {
9070 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071 goto end;
9072 }
9073
9074#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9076 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9077 MBEDTLS_PADDING_NONE)) != 0) {
9078 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009079 goto end;
9080 }
9081
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9083 MBEDTLS_PADDING_NONE)) != 0) {
9084 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009085 goto end;
9086 }
9087 }
9088#endif /* MBEDTLS_CIPHER_MODE_CBC */
9089#endif /* MBEDTLS_USE_PSA_CRYPTO */
9090
Neil Armstrong29c0c042022-03-17 17:47:28 +01009091#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9092 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9093 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009095#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9099 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9100 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009101
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 if ((status = psa_import_key(&attributes,
9103 mac_enc, mac_key_len,
9104 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009105 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009107 goto end;
9108 }
9109
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9111 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009112#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009113 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009114#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009116 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9118 PSA_KEY_USAGE_VERIFY_HASH);
9119 } else {
9120 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9121 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if ((status = psa_import_key(&attributes,
9124 mac_dec, mac_key_len,
9125 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009126 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009128 goto end;
9129 }
9130#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9132 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009133 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 }
9135 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9136 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009137 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009139#endif /* MBEDTLS_USE_PSA_CRYPTO */
9140 }
9141#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9142
9143 ((void) mac_dec);
9144 ((void) mac_enc);
9145
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009146end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9148 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009149}
9150
Valerio Settia08b1a42022-11-17 15:10:02 +01009151#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9152 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009153int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 psa_pake_operation_t *pake_ctx,
9155 const unsigned char *buf,
9156 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009157{
9158 psa_status_t status;
9159 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009160 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009161 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9162 * At round two perform a single cycle
9163 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 for (; remaining_steps > 0; remaining_steps--) {
9167 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009168 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009170 /* Length is stored at the first byte */
9171 size_t length = buf[input_offset];
9172 input_offset += 1;
9173
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009175 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9176 }
9177
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 status = psa_pake_input(pake_ctx, step,
9179 buf + input_offset, length);
9180 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009181 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009182 }
9183
9184 input_offset += length;
9185 }
9186 }
9187
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009189 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009193}
9194
Valerio Setti6b3dab02022-11-17 17:14:54 +01009195int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 psa_pake_operation_t *pake_ctx,
9197 unsigned char *buf,
9198 size_t len, size_t *olen,
9199 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009200{
9201 psa_status_t status;
9202 size_t output_offset = 0;
9203 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009204 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009205 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9206 * At round two perform a single cycle
9207 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 for (; remaining_steps > 0; remaining_steps--) {
9211 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9212 step <= PSA_PAKE_STEP_ZK_PROOF;
9213 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009214 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009215 * For each step, prepend 1 byte with the length of the data as
9216 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 status = psa_pake_output(pake_ctx, step,
9219 buf + output_offset + 1,
9220 len - output_offset - 1,
9221 &output_len);
9222 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009223 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009224 }
9225
Valerio Setti99d88c12022-11-22 16:03:43 +01009226 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009227
9228 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009229 }
9230 }
9231
9232 *olen = output_offset;
9233
Gilles Peskine449bd832023-01-11 14:50:10 +01009234 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009235}
Valerio Settia08b1a42022-11-17 15:10:02 +01009236#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9237
Jerry Yuee40f9d2022-02-17 14:55:16 +08009238#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009239int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9240 unsigned char *hash, size_t *hashlen,
9241 unsigned char *data, size_t data_len,
9242 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009243{
9244 psa_status_t status;
9245 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009246 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009249
Gilles Peskine449bd832023-01-11 14:50:10 +01009250 if ((status = psa_hash_setup(&hash_operation,
9251 hash_alg)) != PSA_SUCCESS) {
9252 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009253 goto exit;
9254 }
9255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9257 64)) != PSA_SUCCESS) {
9258 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009259 goto exit;
9260 }
9261
Gilles Peskine449bd832023-01-11 14:50:10 +01009262 if ((status = psa_hash_update(&hash_operation,
9263 data, data_len)) != PSA_SUCCESS) {
9264 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009265 goto exit;
9266 }
9267
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9269 hashlen)) != PSA_SUCCESS) {
9270 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9271 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009272 }
9273
9274exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (status != PSA_SUCCESS) {
9276 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9277 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9278 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009279 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009280 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009281 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9282 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009284 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009285 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009286 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009288 }
9289 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009291}
9292
9293#else
9294
Gilles Peskine449bd832023-01-11 14:50:10 +01009295int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9296 unsigned char *hash, size_t *hashlen,
9297 unsigned char *data, size_t data_len,
9298 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009299{
9300 int ret = 0;
9301 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009302 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9303 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009304
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009306
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009308
9309 /*
9310 * digitally-signed struct {
9311 * opaque client_random[32];
9312 * opaque server_random[32];
9313 * ServerDHParams params;
9314 * };
9315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009316 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9317 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009318 goto exit;
9319 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9321 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009322 goto exit;
9323 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9325 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009326 goto exit;
9327 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9329 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009330 goto exit;
9331 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9333 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009334 goto exit;
9335 }
9336
9337exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009338 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009339
Gilles Peskine449bd832023-01-11 14:50:10 +01009340 if (ret != 0) {
9341 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9342 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9343 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009344
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009346}
9347#endif /* MBEDTLS_USE_PSA_CRYPTO */
9348
Jerry Yud9d91da2022-02-17 14:57:06 +08009349#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9350
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009351/* Find the preferred hash for a given signature algorithm. */
9352unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 mbedtls_ssl_context *ssl,
9354 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009355{
Gabor Mezei078e8032022-04-27 21:17:56 +02009356 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009357 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009358
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9360 return MBEDTLS_SSL_HASH_NONE;
9361 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009362
Gilles Peskine449bd832023-01-11 14:50:10 +01009363 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009364 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009365 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9366 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009367 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9369 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009370
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009371 mbedtls_md_type_t md_alg =
9372 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9373 if (md_alg == MBEDTLS_MD_NONE) {
9374 continue;
9375 }
9376
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009378#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009380 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009381 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009382
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9384 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9385 PSA_ALG_ECDSA(psa_hash_alg),
9386 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009387 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009389
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9391 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9392 PSA_ALG_RSA_PKCS1V15_SIGN(
9393 psa_hash_alg),
9394 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009395 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009397 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009398#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009399
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009401 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009402 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009403
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009405}
9406
9407#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9408
Jerry Yudc7bd172022-02-17 13:44:15 +08009409#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9410
XiaokangQian75d40ef2022-04-20 11:05:24 +00009411int mbedtls_ssl_validate_ciphersuite(
9412 const mbedtls_ssl_context *ssl,
9413 const mbedtls_ssl_ciphersuite_t *suite_info,
9414 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009415 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009416{
9417 (void) ssl;
9418
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 if (suite_info == NULL) {
9420 return -1;
9421 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009422
Gilles Peskine449bd832023-01-11 14:50:10 +01009423 if ((suite_info->min_tls_version > max_tls_version) ||
9424 (suite_info->max_tls_version < min_tls_version)) {
9425 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009426 }
9427
XiaokangQian060d8672022-04-21 09:24:56 +00009428#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009429#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009430#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9432 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009433#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9435 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009436#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009437 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009439 }
9440#endif
9441
9442 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9443#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9445 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9446 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009447 }
9448#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9449#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9450
Gilles Peskine449bd832023-01-11 14:50:10 +01009451 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009452}
9453
Ronald Crone68ab4f2022-10-05 12:46:29 +02009454#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009455/*
9456 * Function for writing a signature algorithm extension.
9457 *
9458 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9459 * value (TLS 1.3 RFC8446):
9460 * enum {
9461 * ....
9462 * ecdsa_secp256r1_sha256( 0x0403 ),
9463 * ecdsa_secp384r1_sha384( 0x0503 ),
9464 * ecdsa_secp521r1_sha512( 0x0603 ),
9465 * ....
9466 * } SignatureScheme;
9467 *
9468 * struct {
9469 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9470 * } SignatureSchemeList;
9471 *
9472 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9473 * value (TLS 1.2 RFC5246):
9474 * enum {
9475 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9476 * sha512(6), (255)
9477 * } HashAlgorithm;
9478 *
9479 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9480 * SignatureAlgorithm;
9481 *
9482 * struct {
9483 * HashAlgorithm hash;
9484 * SignatureAlgorithm signature;
9485 * } SignatureAndHashAlgorithm;
9486 *
9487 * SignatureAndHashAlgorithm
9488 * supported_signature_algorithms<2..2^16-2>;
9489 *
9490 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9491 * generalization of the TLS 1.2 signature algorithm extension.
9492 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9493 * `SignatureScheme` field of TLS 1.3
9494 *
9495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009496int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9497 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009498{
9499 unsigned char *p = buf;
9500 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9501 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9502
9503 *out_len = 0;
9504
Gilles Peskine449bd832023-01-11 14:50:10 +01009505 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009506
9507 /* Check if we have space for header and length field:
9508 * - extension_type (2 bytes)
9509 * - extension_data_length (2 bytes)
9510 * - supported_signature_algorithms_length (2 bytes)
9511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009513 p += 6;
9514
9515 /*
9516 * Write supported_signature_algorithms
9517 */
9518 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9520 if (sig_alg == NULL) {
9521 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9522 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009523
Gilles Peskine449bd832023-01-11 14:50:10 +01009524 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9525 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9526 *sig_alg,
9527 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9528 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009529 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 }
9531 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9532 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009533 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009534 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9535 *sig_alg,
9536 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009537 }
9538
9539 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009540 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 if (supported_sig_alg_len == 0) {
9542 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9543 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009544 }
9545
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9547 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9548 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009549
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009550 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009551
9552#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009554#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009555
Gilles Peskine449bd832023-01-11 14:50:10 +01009556 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009557}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009558#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009559
XiaokangQian40a35232022-05-07 09:02:40 +00009560#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009561/*
9562 * mbedtls_ssl_parse_server_name_ext
9563 *
9564 * Structure of server_name extension:
9565 *
9566 * enum {
9567 * host_name(0), (255)
9568 * } NameType;
9569 * opaque HostName<1..2^16-1>;
9570 *
9571 * struct {
9572 * NameType name_type;
9573 * select (name_type) {
9574 * case host_name: HostName;
9575 * } name;
9576 * } ServerName;
9577 * struct {
9578 * ServerName server_name_list<1..2^16-1>
9579 * } ServerNameList;
9580 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009581MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009582int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9583 const unsigned char *buf,
9584 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009585{
9586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9587 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009588 size_t server_name_list_len, hostname_len;
9589 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009592
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9594 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009595 p += 2;
9596
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009598 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009599 while (p < server_name_list_end) {
9600 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9601 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9602 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9603 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009604
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009606 /* sni_name is intended to be used only during the parsing of the
9607 * ClientHello message (it is reset to NULL before the end of
9608 * the message parsing). Thus it is ok to just point to the
9609 * reception buffer and not make a copy of it.
9610 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009611 ssl->handshake->sni_name = p + 3;
9612 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009613 if (ssl->conf->f_sni == NULL) {
9614 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009615 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009616 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9617 ssl, p + 3, hostname_len);
9618 if (ret != 0) {
9619 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9620 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9621 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9622 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9623 }
9624 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009625 }
9626
9627 p += hostname_len + 3;
9628 }
9629
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009631}
9632#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9633
XiaokangQianacb39922022-06-17 10:18:48 +00009634#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009636int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9637 const unsigned char *buf,
9638 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009639{
9640 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009641 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009642 const unsigned char *protocol_name_list;
9643 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009644 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009645
9646 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009647 if (ssl->conf->alpn_list == NULL) {
9648 return 0;
9649 }
XiaokangQianacb39922022-06-17 10:18:48 +00009650
9651 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009652 * RFC7301, section 3.1
9653 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009654 *
XiaokangQianc7403452022-06-23 03:24:12 +00009655 * struct {
9656 * ProtocolName protocol_name_list<2..2^16-1>
9657 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009658 */
9659
XiaokangQianc7403452022-06-23 03:24:12 +00009660 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009661 * protocol_name_list_len 2 bytes
9662 * protocol_name_len 1 bytes
9663 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009665 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009666
Gilles Peskine449bd832023-01-11 14:50:10 +01009667 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009668 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009669 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009670 protocol_name_list = p;
9671 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009672
9673 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009674 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009675 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009676 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9677 protocol_name_len);
9678 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009679 MBEDTLS_SSL_PEND_FATAL_ALERT(
9680 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9682 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009683 }
9684
9685 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009686 }
9687
9688 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9690 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009691 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009692 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009693 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009694 if (protocol_name_len == alpn_len &&
9695 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009696 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009698 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009699
9700 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009701 }
9702 }
9703
XiaokangQian95d5f542022-06-24 02:29:26 +00009704 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009705 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009706 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9707 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9708 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009709}
9710
Gilles Peskine449bd832023-01-11 14:50:10 +01009711int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9712 unsigned char *buf,
9713 unsigned char *end,
9714 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009715{
9716 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009717 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009718 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009719
Gilles Peskine449bd832023-01-11 14:50:10 +01009720 if (ssl->alpn_chosen == NULL) {
9721 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009722 }
9723
Gilles Peskine449bd832023-01-11 14:50:10 +01009724 protocol_name_len = strlen(ssl->alpn_chosen);
9725 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009726
Gilles Peskine449bd832023-01-11 14:50:10 +01009727 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009728 /*
9729 * 0 . 1 ext identifier
9730 * 2 . 3 ext length
9731 * 4 . 5 protocol list length
9732 * 6 . 6 protocol name length
9733 * 7 . 7+n protocol name
9734 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009735 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009736
XiaokangQian95d5f542022-06-24 02:29:26 +00009737 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009738
Gilles Peskine449bd832023-01-11 14:50:10 +01009739 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9740 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009741 /* Note: the length of the chosen protocol has been checked to be less
9742 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9743 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009744 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009745
Gilles Peskine449bd832023-01-11 14:50:10 +01009746 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009747
9748#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009749 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009750#endif
9751
Gilles Peskine449bd832023-01-11 14:50:10 +01009752 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009753}
9754#endif /* MBEDTLS_SSL_ALPN */
9755
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009756#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009757 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009758 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009759 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009760int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9761 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009762{
9763 /* Initialize to suppress unnecessary compiler warning */
9764 size_t hostname_len = 0;
9765
9766 /* Check if new hostname is valid before
9767 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009768 if (hostname != NULL) {
9769 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009770
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9773 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009774 }
9775
9776 /* Now it's clear that we will overwrite the old hostname,
9777 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009779 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009780 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009781 }
9782
9783 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009784 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009785 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009786 } else {
9787 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9788 if (session->hostname == NULL) {
9789 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9790 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009791
Gilles Peskine449bd832023-01-11 14:50:10 +01009792 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009793 }
9794
Gilles Peskine449bd832023-01-11 14:50:10 +01009795 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009796}
Xiaokang Qian03409292022-10-12 02:49:52 +00009797#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9798 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009799 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009800 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009802#endif /* MBEDTLS_SSL_TLS_C */