blob: 7a8c759fa3e756ca813acc2f0b3bdf28dfad03d2 [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
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#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)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800309 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Jerry Yu60835a82021-08-04 10:13:52 +08001358 /* Space for further checks */
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001361}
1362
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001363/*
1364 * Setup an SSL context
1365 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1368 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001369{
Janos Follath865b3eb2019-12-16 11:46:15 +00001370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001371 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1372 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001374 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if ((ret = ssl_conf_check(ssl)) != 0) {
1377 return ret;
1378 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001379 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001380
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001382 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001383 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001384
1385 /* Set to NULL in case of an error condition */
1386 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001387
Darryl Greenb33cc762019-11-28 14:29:44 +00001388#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1389 ssl->in_buf_len = in_buf_len;
1390#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1392 if (ssl->in_buf == NULL) {
1393 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001394 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001395 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001396 }
1397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->out_buf_len = out_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1402 if (ssl->out_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001409
Johan Pascalb62bb512015-12-03 21:56:45 +01001410#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001412#endif
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419
1420error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_free(ssl->in_buf);
1422 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424 ssl->conf = NULL;
1425
Darryl Greenb33cc762019-11-28 14:29:44 +00001426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1427 ssl->in_buf_len = 0;
1428 ssl->out_buf_len = 0;
1429#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001430 ssl->in_buf = NULL;
1431 ssl->out_buf = NULL;
1432
1433 ssl->in_hdr = NULL;
1434 ssl->in_ctr = NULL;
1435 ssl->in_len = NULL;
1436 ssl->in_iv = NULL;
1437 ssl->in_msg = NULL;
1438
1439 ssl->out_hdr = NULL;
1440 ssl->out_ctr = NULL;
1441 ssl->out_len = NULL;
1442 ssl->out_iv = NULL;
1443 ssl->out_msg = NULL;
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
1448/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001449 * Reset an initialized and used SSL context for re-use while retaining
1450 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001451 *
1452 * If partial is non-zero, keep data in the input buffer and client ID.
1453 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1456 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457{
Darryl Greenb33cc762019-11-28 14:29:44 +00001458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1459 size_t in_buf_len = ssl->in_buf_len;
1460 size_t out_buf_len = ssl->out_buf_len;
1461#else
1462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1463 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1464#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001465
Hanno Beckerb0302c42021-08-03 09:39:42 +01001466#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1467 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001468#endif
1469
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001470 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474
1475 /* Reset incoming message parsing */
1476 ssl->in_offt = NULL;
1477 ssl->nb_zero = 0;
1478 ssl->in_msgtype = 0;
1479 ssl->in_msglen = 0;
1480 ssl->in_hslen = 0;
1481 ssl->keep_current_message = 0;
1482 ssl->transform_in = NULL;
1483
1484#if defined(MBEDTLS_SSL_PROTO_DTLS)
1485 ssl->next_record_offset = 0;
1486 ssl->in_epoch = 0;
1487#endif
1488
1489 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001491 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493 }
1494
Ronald Cronad8c17b2022-06-10 17:18:09 +02001495 ssl->send_alert = 0;
1496
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 /* Reset outgoing message writing */
1498 ssl->out_msgtype = 0;
1499 ssl->out_msglen = 0;
1500 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 memset(ssl->out_buf, 0, out_buf_len);
1502 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->transform_out = NULL;
1504
1505#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507#endif
1508
XiaokangQian2b01dc32022-01-21 02:53:13 +00001509#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (ssl->transform) {
1511 mbedtls_ssl_transform_free(ssl->transform);
1512 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform = NULL;
1514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1516
XiaokangQian2b01dc32022-01-21 02:53:13 +00001517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_transform_free(ssl->transform_application);
1519 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 ssl->transform_application = NULL;
1521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001523#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1525 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1530 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_handshake = NULL;
1532 }
1533
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538{
1539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1540
1541 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
1545 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_RENEGOTIATION)
1547 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001549
1550 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1552 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001557 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session) {
1559 mbedtls_ssl_session_free(ssl->session);
1560 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001561 ssl->session = NULL;
1562 }
1563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001565 ssl->alpn_chosen = NULL;
1566#endif
1567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001569 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (free_cli_id) {
1574 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001575 ssl->cli_id = NULL;
1576 ssl->cli_id_len = 0;
1577 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001578#endif
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if ((ret = ssl_handshake_init(ssl)) != 0) {
1581 return ret;
1582 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001585}
1586
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001587/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 * Reset an initialized and used SSL context for re-use while retaining
1589 * all application-set variables, function pointers and data.
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592{
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594}
1595
1596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 * SSL set accessors
1598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001601 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001602}
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607}
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613}
1614#endif
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1624 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001625{
1626 ssl->disable_datagram_packing = !allow_packing;
1627}
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1630 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->hs_timeout_min = min;
1633 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1644 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1645 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001647 conf->f_vrfy = f_vrfy;
1648 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1653 int (*f_rng)(void *, unsigned char *, size_t),
1654 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001656 conf->f_rng = f_rng;
1657 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1661 void (*f_dbg)(void *, int, const char *, int, const char *),
1662 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_dbg = f_dbg;
1665 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001666}
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1669 void *p_bio,
1670 mbedtls_ssl_send_t *f_send,
1671 mbedtls_ssl_recv_t *f_recv,
1672 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001673{
1674 ssl->p_bio = p_bio;
1675 ssl->f_send = f_send;
1676 ssl->f_recv = f_recv;
1677 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001678}
1679
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682{
1683 ssl->mtu = mtu;
1684}
1685#endif
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688{
1689 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690}
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1693 void *p_timer,
1694 mbedtls_ssl_set_timer_t *f_set_timer,
1695 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696{
1697 ssl->p_timer = p_timer;
1698 ssl->f_set_timer = f_set_timer;
1699 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001700
1701 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703}
1704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001706void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1707 void *p_cache,
1708 mbedtls_ssl_cache_get_t *f_get_cache,
1709 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001710{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001711 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723 session == NULL ||
1724 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (ssl->handshake->resume == 1) {
1730 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1731 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001732
Jerry Yu21092062022-10-10 21:21:31 +08001733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001735 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001739 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1741 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1742 session->ciphersuite));
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001744 }
Jerry Yu40afab62022-10-08 10:42:13 +08001745 }
Jerry Yu21092062022-10-10 21:21:31 +08001746#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1749 session)) != 0) {
1750 return ret;
1751 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001752
Paul Bakker0a597072012-09-25 21:55:46 +00001753 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1760 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001761{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001762 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001763}
1764
Ronald Cron6f135e12021-12-08 16:57:54 +01001765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1767 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001768{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001769 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001771
1772#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001773void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1774 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001775{
1776 conf->early_data_enabled = early_data_enabled;
1777}
Jerry Yucc4e0072022-11-22 17:22:22 +08001778
1779#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001780void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001782{
Jerry Yu39da9852022-12-06 16:58:36 +08001783 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001784}
1785#endif /* MBEDTLS_SSL_SRV_C */
1786
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1792 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001793{
1794 conf->cert_profile = profile;
1795}
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001798{
1799 mbedtls_ssl_key_cert *cur = key_cert, *next;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001802 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 cur = next;
1805 }
1806}
1807
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001808/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1811 mbedtls_x509_crt *cert,
1812 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001813{
niisato8ee24222018-06-25 19:05:48 +09001814 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1824 if (new_cert == NULL) {
1825 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1826 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
niisato8ee24222018-06-25 19:05:48 +09001828 new_cert->cert = cert;
1829 new_cert->key = key;
1830 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001834 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001836 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 }
niisato8ee24222018-06-25 19:05:48 +09001840 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844}
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849{
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851}
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001854 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001856{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 conf->ca_chain = ca_chain;
1858 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001859
1860#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1861 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1862 * cannot be used together. */
1863 conf->f_ca_cb = NULL;
1864 conf->p_ca_cb = NULL;
1865#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
Hanno Becker5adaad92019-03-27 16:54:37 +00001867
1868#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1871 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001872{
1873 conf->f_ca_cb = f_ca_cb;
1874 conf->p_ca_cb = p_ca_cb;
1875
1876 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1877 * cannot be used together. */
1878 conf->ca_chain = NULL;
1879 conf->ca_crl = NULL;
1880}
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001883
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001884#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1886 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001887{
1888 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001890}
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1893 mbedtls_x509_crt *own_cert,
1894 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895{
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1897 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1901 mbedtls_x509_crt *ca_chain,
1902 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001903{
1904 ssl->handshake->sni_ca_chain = ca_chain;
1905 ssl->handshake->sni_ca_crl = ca_crl;
1906}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001907
Glenn Strauss999ef702022-03-11 01:37:23 -05001908#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1910 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001911{
1912 ssl->handshake->dn_hints = crt;
1913}
1914#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1917 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918{
1919 ssl->handshake->sni_authmode = authmode;
1920}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1922
Hanno Becker8927c832019-04-03 12:52:50 +01001923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001924void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1926 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001927{
1928 ssl->f_vrfy = f_vrfy;
1929 ssl->p_vrfy = p_vrfy;
1930}
1931#endif
1932
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Valerio Setti016f6822022-12-09 14:17:50 +01001935#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001936static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1937static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1938
Valerio Setti016f6822022-12-09 14:17:50 +01001939static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 mbedtls_ssl_context *ssl,
1941 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001942{
1943 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001944 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001945 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001946 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1950 psa_pake_cs_set_primitive(&cipher_suite,
1951 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1952 PSA_ECC_FAMILY_SECP_R1,
1953 256));
1954 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1957 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001962 user = jpake_server_id;
1963 user_len = sizeof(jpake_server_id);
1964 peer = jpake_client_id;
1965 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_client_id;
1968 user_len = sizeof(jpake_client_id);
1969 peer = jpake_server_id;
1970 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001972
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1974 if (status != PSA_SUCCESS) {
1975 return status;
1976 }
1977
1978 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001980 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
1988 ssl->handshake->psa_pake_ctx_is_ok = 1;
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1994 const unsigned char *pw,
1995 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001996{
1997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1998 psa_status_t status;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (ssl->handshake == NULL || ssl->conf == NULL) {
2001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 /* Empty password is not valid */
2005 if ((pw == NULL) || (pw_len == 0)) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2007 }
2008
2009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2010 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2011 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2012
2013 status = psa_import_key(&attributes, pw, pw_len,
2014 &ssl->handshake->psa_pake_password);
2015 if (status != PSA_SUCCESS) {
2016 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2017 }
2018
2019 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2020 ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 psa_destroy_key(ssl->handshake->psa_pake_password);
2023 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2024 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2025 }
2026
2027 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002028}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2031 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033 psa_status_t status;
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (ssl->handshake == NULL || ssl->conf == NULL) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (mbedtls_svc_key_id_is_null(pwd)) {
2040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2041 }
2042
2043 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2044 if (status != PSA_SUCCESS) {
2045 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2046 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2047 }
2048
2049 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002050}
2051#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2053 const unsigned char *pw,
2054 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002055{
2056 mbedtls_ecjpake_role role;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ssl->handshake == NULL || ssl->conf == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061
Valerio Settic689ed82022-12-07 14:40:38 +01002062 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if ((pw == NULL) || (pw_len == 0)) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Valerio Settic689ed82022-12-07 14:40:38 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2074 role,
2075 MBEDTLS_MD_SHA256,
2076 MBEDTLS_ECP_DP_SECP256R1,
2077 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078}
Valerio Setti02c25b52022-11-15 14:08:42 +01002079#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002080#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002084{
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (conf->psk_identity == NULL ||
2086 conf->psk_identity_len == 0) {
2087 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002088 }
2089
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2092 return 1;
2093 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk != NULL && conf->psk_len != 0) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
2105 /* Remove reference to existing PSK, if any. */
2106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108 /* The maintenance of the PSK key slot is the
2109 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002114 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115 conf->psk = NULL;
2116 conf->psk_len = 0;
2117 }
2118
2119 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (conf->psk_identity != NULL) {
2121 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk_identity = NULL;
2123 conf->psk_identity_len = 0;
2124 }
2125}
2126
Hanno Becker7390c712018-11-15 13:33:04 +00002127/* This function assumes that PSK identity in the SSL config is unset.
2128 * It checks that the provided identity is well-formed and attempts
2129 * to make a copy of it in the SSL config.
2130 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002132static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2133 unsigned char const *psk_identity,
2134 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002135{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002136 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002138 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 (psk_identity_len >> 16) != 0 ||
2140 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2145 if (conf->psk_identity == NULL) {
2146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2147 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002148
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002149 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002153}
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2156 const unsigned char *psk, size_t psk_len,
2157 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002160
2161 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2163 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2164 }
Hanno Becker7390c712018-11-15 13:33:04 +00002165
2166 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (psk == NULL) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2169 }
2170 if (psk_len == 0) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2178 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002182
2183 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2185 if (ret != 0) {
2186 ssl_conf_remove_psk(conf);
2187 }
Hanno Becker7390c712018-11-15 13:33:04 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002193{
2194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002196 /* The maintenance of the external PSK key slot is the
2197 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->psk_opaque_is_internal) {
2199 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002200 ssl->handshake->psk_opaque_is_internal = 0;
2201 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002202 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203 }
Neil Armstronge952a302022-05-03 10:22:14 +02002204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002206 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 ssl->handshake->psk_len = 0;
2209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211}
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2214 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002215{
Neil Armstrong501c9322022-05-03 09:35:09 +02002216#if defined(MBEDTLS_USE_PSA_CRYPTO)
2217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002219 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (psk == NULL || ssl->handshake == NULL) {
2224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2225 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2229 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2236 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2237 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2238 } else {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2240 }
2241 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002242 }
2243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002244
Jerry Yu568ec252022-07-22 21:27:34 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2247 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2248 psa_set_key_usage_flags(&key_attributes,
2249 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 psa_set_key_algorithm(&key_attributes, alg);
2254 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2257 if (status != PSA_SUCCESS) {
2258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2259 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
2261 /* Allow calling psa_destroy_key() on psk remove */
2262 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002264#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
2269 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274}
2275
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002276#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002277int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2278 mbedtls_svc_key_id_t psk,
2279 const unsigned char *psk_identity,
2280 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281{
Janos Follath865b3eb2019-12-16 11:46:15 +00002282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002283
2284 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2287 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288
Hanno Becker7390c712018-11-15 13:33:04 +00002289 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_svc_key_id_is_null(psk)) {
2291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2292 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002293 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002294
2295 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2297 psk_identity_len);
2298 if (ret != 0) {
2299 ssl_conf_remove_psk(conf);
2300 }
Hanno Becker7390c712018-11-15 13:33:04 +00002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2306 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002307{
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((mbedtls_svc_key_id_is_null(psk)) ||
2309 (ssl->handshake == NULL)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316}
2317#endif /* MBEDTLS_USE_PSA_CRYPTO */
2318
Jerry Yu8897c072022-08-12 13:56:53 +08002319#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2321 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2322 size_t),
2323 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324{
2325 conf->f_psk = f_psk;
2326 conf->p_psk = p_psk;
2327}
Jerry Yu8897c072022-08-12 13:56:53 +08002328#endif /* MBEDTLS_SSL_SRV_C */
2329
Ronald Cron73fe8df2022-10-05 14:31:43 +02002330#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
2332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002333static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (alg == PSA_ALG_CBC_NO_PADDING) {
2338 return MBEDTLS_SSL_MODE_CBC;
2339 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (PSA_ALG_IS_AEAD(alg)) {
2342 return MBEDTLS_SSL_MODE_AEAD;
2343 }
2344 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002345}
2346
2347#else /* MBEDTLS_USE_PSA_CRYPTO */
2348
2349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002351{
2352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (mode == MBEDTLS_MODE_CBC) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2357
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358#if defined(MBEDTLS_GCM_C) || \
2359 defined(MBEDTLS_CCM_C) || \
2360 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mode == MBEDTLS_MODE_CHACHAPOLY) {
2364 return MBEDTLS_SSL_MODE_AEAD;
2365 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369}
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371
Gilles Peskinee108d982022-04-26 16:50:40 +02002372static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2373 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002375{
2376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2378 base_mode == MBEDTLS_SSL_MODE_CBC) {
2379 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002380 }
2381#else
2382 (void) encrypt_then_mac;
2383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385}
2386
Neil Armstrongab555e02022-04-04 11:07:59 +02002387mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002389{
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002395#endif
2396 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 encrypt_then_mac = transform->encrypt_then_mac;
2401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403}
2404
Neil Armstrongab555e02022-04-04 11:07:59 +02002405mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410{
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2412
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413#if defined(MBEDTLS_USE_PSA_CRYPTO)
2414 psa_status_t status;
2415 psa_algorithm_t alg;
2416 psa_key_type_t type;
2417 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002418 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2419 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (status == PSA_SUCCESS) {
2421 base_mode = mbedtls_ssl_get_base_mode(alg);
2422 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#else
2424 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002425 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 base_mode =
2428 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#endif /* MBEDTLS_USE_PSA_CRYPTO */
2432
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2434 int encrypt_then_mac = 0;
2435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437}
2438
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002439#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002440
2441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002442/* Serialization of TLS 1.3 sessions:
2443 *
2444 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002445 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002446 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002447 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002448 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * } ClientOnlyData;
2450 *
2451 * struct {
2452 * uint8 endpoint;
2453 * uint8 ciphersuite[2];
2454 * uint32 ticket_age_add;
2455 * uint8 ticket_flags;
2456 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002457 * uint32 max_early_data_size;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002458 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002459 * select ( endpoint ) {
2460 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002461 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002462 * };
2463 * } serialized_session_tls13;
2464 *
2465 */
2466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002467MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002468static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2469 unsigned char *buf,
2470 size_t buf_len,
2471 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002472{
2473 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002474#if defined(MBEDTLS_SSL_CLI_C) && \
2475 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 size_t hostname_len = (session->hostname == NULL) ?
2477 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002478#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002479 size_t needed = 1 /* endpoint */
2480 + 2 /* ciphersuite */
2481 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002482 + 1 /* ticket_flags */
2483 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002484 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2488 }
Jerry Yu34191072022-08-18 10:32:09 +08002489 needed += session->resumption_key_len; /* resumption_key */
2490
Jerry Yu02e3a072022-12-12 15:13:20 +08002491#if defined(MBEDTLS_SSL_EARLY_DATA)
2492 needed += 4; /* max_early_data_size */
2493#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002494#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2495 needed += 2; /* record_size_limit */
2496#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002497
Jerry Yu438ddd82022-07-07 06:55:50 +00002498#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002499 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002500#endif
2501
2502#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002504#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002505 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002507#endif
2508
Jerry Yu438ddd82022-07-07 06:55:50 +00002509 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002510 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002511
2512 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (session->ticket_len > SIZE_MAX - needed) {
2514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2515 }
Jerry Yu34191072022-08-18 10:32:09 +08002516
Jerry Yue28d9742022-08-18 15:44:03 +08002517 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002518 }
2519#endif /* MBEDTLS_SSL_CLI_C */
2520
Jerry Yue36fdd62022-08-17 21:31:36 +08002521 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 if (needed > buf_len) {
2523 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2524 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002525
2526 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2528 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p[7] = session->ticket_flags;
2530
2531 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002532 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002533 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002535 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002536
Jerry Yu02e3a072022-12-12 15:13:20 +08002537#if defined(MBEDTLS_SSL_EARLY_DATA)
2538 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2539 p += 4;
2540#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002541#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2542 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2543 p += 2;
2544#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002545
Jerry Yu438ddd82022-07-07 06:55:50 +00002546#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002548 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002549 p += 8;
2550 }
2551#endif /* MBEDTLS_HAVE_TIME */
2552
2553#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002557 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += hostname_len;
2562 }
2563#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2564
Jerry Yu438ddd82022-07-07 06:55:50 +00002565#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002566 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 8;
2568#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 4;
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002573 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (session->ticket != NULL && session->ticket_len > 0) {
2576 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += session->ticket_len;
2578 }
2579 }
2580#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002582}
2583
2584MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002585static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2586 const unsigned char *buf,
2587 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002588{
2589 const unsigned char *p = buf;
2590 const unsigned char *end = buf + len;
2591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (end - p < 9) {
2593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2594 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2597 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002598 session->ticket_flags = p[7];
2599
2600 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002601 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 p += 9;
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (end - p < session->resumption_key_len) {
2605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2606 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
2611 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002612 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002613
Jerry Yu02e3a072022-12-12 15:13:20 +08002614#if defined(MBEDTLS_SSL_EARLY_DATA)
2615 if (end - p < 4) {
2616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2617 }
2618 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2619 p += 4;
2620#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002621#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2622 if (end - p < 2) {
2623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2624 }
2625 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
2626 p += 2;
2627#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002628
Jerry Yu438ddd82022-07-07 06:55:50 +00002629#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2631 if (end - p < 8) {
2632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2633 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002634 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002635 p += 8;
2636 }
2637#endif /* MBEDTLS_HAVE_TIME */
2638
2639#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002641#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002642 size_t hostname_len;
2643 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (end - p < 2) {
2645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2646 }
2647 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002648 p += 2;
2649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (end - p < (long int) hostname_len) {
2651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2652 }
2653 if (hostname_len > 0) {
2654 session->hostname = mbedtls_calloc(1, hostname_len);
2655 if (session->hostname == NULL) {
2656 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2657 }
2658 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002659 p += hostname_len;
2660 }
Yanray Wangfd256542023-11-22 10:32:03 +08002661#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002662
Jerry Yu438ddd82022-07-07 06:55:50 +00002663#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (end - p < 8) {
2665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2666 }
Jerry Yu342a5552023-11-10 14:23:39 +08002667 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002668 p += 8;
2669#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (end - p < 4) {
2671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2672 }
2673 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002674 p += 4;
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (end - p < 2) {
2677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2678 }
2679 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002680 p += 2;
2681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 if (end - p < (long int) session->ticket_len) {
2683 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2684 }
2685 if (session->ticket_len > 0) {
2686 session->ticket = mbedtls_calloc(1, session->ticket_len);
2687 if (session->ticket == NULL) {
2688 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2689 }
2690 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002691 p += session->ticket_len;
2692 }
2693 }
2694#endif /* MBEDTLS_SSL_CLI_C */
2695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002697
2698}
2699#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002701static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2702 unsigned char *buf,
2703 size_t buf_len,
2704 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002705{
2706 ((void) session);
2707 ((void) buf);
2708 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002709 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002711}
Jerry Yu438ddd82022-07-07 06:55:50 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2714 unsigned char *buf,
2715 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002716{
2717 ((void) session);
2718 ((void) buf);
2719 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002721}
2722#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002723#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2726 size_t taglen,
2727 psa_algorithm_t *alg,
2728 psa_key_type_t *key_type,
2729 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002731#if !defined(MBEDTLS_SSL_HAVE_CCM)
2732 (void) taglen;
2733#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002735#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002736 case MBEDTLS_CIPHER_AES_128_CBC:
2737 *alg = PSA_ALG_CBC_NO_PADDING;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 128;
2740 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002741#endif
2742#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002743 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 128;
2747 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002748#endif
2749#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002750 case MBEDTLS_CIPHER_AES_128_GCM:
2751 *alg = PSA_ALG_GCM;
2752 *key_type = PSA_KEY_TYPE_AES;
2753 *key_size = 128;
2754 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002755#endif
2756#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002757 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002759 *key_type = PSA_KEY_TYPE_AES;
2760 *key_size = 192;
2761 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002762#endif
2763#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002764 case MBEDTLS_CIPHER_AES_192_GCM:
2765 *alg = PSA_ALG_GCM;
2766 *key_type = PSA_KEY_TYPE_AES;
2767 *key_size = 192;
2768 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002769#endif
2770#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002771 case MBEDTLS_CIPHER_AES_256_CBC:
2772 *alg = PSA_ALG_CBC_NO_PADDING;
2773 *key_type = PSA_KEY_TYPE_AES;
2774 *key_size = 256;
2775 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002776#endif
2777#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002778 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 *key_type = PSA_KEY_TYPE_AES;
2781 *key_size = 256;
2782 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002783#endif
2784#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002785 case MBEDTLS_CIPHER_AES_256_GCM:
2786 *alg = PSA_ALG_GCM;
2787 *key_type = PSA_KEY_TYPE_AES;
2788 *key_size = 256;
2789 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002790#endif
2791#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002792 case MBEDTLS_CIPHER_ARIA_128_CBC:
2793 *alg = PSA_ALG_CBC_NO_PADDING;
2794 *key_type = PSA_KEY_TYPE_ARIA;
2795 *key_size = 128;
2796 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002797#endif
2798#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002799 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002801 *key_type = PSA_KEY_TYPE_ARIA;
2802 *key_size = 128;
2803 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002804#endif
2805#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002806 case MBEDTLS_CIPHER_ARIA_128_GCM:
2807 *alg = PSA_ALG_GCM;
2808 *key_type = PSA_KEY_TYPE_ARIA;
2809 *key_size = 128;
2810 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002811#endif
2812#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002813 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002815 *key_type = PSA_KEY_TYPE_ARIA;
2816 *key_size = 192;
2817 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002818#endif
2819#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002820 case MBEDTLS_CIPHER_ARIA_192_GCM:
2821 *alg = PSA_ALG_GCM;
2822 *key_type = PSA_KEY_TYPE_ARIA;
2823 *key_size = 192;
2824 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002825#endif
2826#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002827 case MBEDTLS_CIPHER_ARIA_256_CBC:
2828 *alg = PSA_ALG_CBC_NO_PADDING;
2829 *key_type = PSA_KEY_TYPE_ARIA;
2830 *key_size = 256;
2831 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002832#endif
2833#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002834 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002836 *key_type = PSA_KEY_TYPE_ARIA;
2837 *key_size = 256;
2838 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002839#endif
2840#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002841 case MBEDTLS_CIPHER_ARIA_256_GCM:
2842 *alg = PSA_ALG_GCM;
2843 *key_type = PSA_KEY_TYPE_ARIA;
2844 *key_size = 256;
2845 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002846#endif
2847#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002848 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2849 *alg = PSA_ALG_CBC_NO_PADDING;
2850 *key_type = PSA_KEY_TYPE_CAMELLIA;
2851 *key_size = 128;
2852 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002853#endif
2854#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002855 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002857 *key_type = PSA_KEY_TYPE_CAMELLIA;
2858 *key_size = 128;
2859 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002860#endif
2861#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002862 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2863 *alg = PSA_ALG_GCM;
2864 *key_type = PSA_KEY_TYPE_CAMELLIA;
2865 *key_size = 128;
2866 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002867#endif
2868#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002869 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002871 *key_type = PSA_KEY_TYPE_CAMELLIA;
2872 *key_size = 192;
2873 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002874#endif
2875#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002876 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2877 *alg = PSA_ALG_GCM;
2878 *key_type = PSA_KEY_TYPE_CAMELLIA;
2879 *key_size = 192;
2880 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002881#endif
2882#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002883 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2884 *alg = PSA_ALG_CBC_NO_PADDING;
2885 *key_type = PSA_KEY_TYPE_CAMELLIA;
2886 *key_size = 256;
2887 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002888#endif
2889#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002890 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002892 *key_type = PSA_KEY_TYPE_CAMELLIA;
2893 *key_size = 256;
2894 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002895#endif
2896#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002897 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2898 *alg = PSA_ALG_GCM;
2899 *key_type = PSA_KEY_TYPE_CAMELLIA;
2900 *key_size = 256;
2901 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002902#endif
2903#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002904 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2905 *alg = PSA_ALG_CHACHA20_POLY1305;
2906 *key_type = PSA_KEY_TYPE_CHACHA20;
2907 *key_size = 256;
2908 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002909#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002910 case MBEDTLS_CIPHER_NULL:
2911 *alg = MBEDTLS_SSL_NULL_CIPHER;
2912 *key_type = 0;
2913 *key_size = 0;
2914 break;
2915 default:
2916 return PSA_ERROR_NOT_SUPPORTED;
2917 }
2918
2919 return PSA_SUCCESS;
2920}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002921#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002922
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002923#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002924int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2925 const unsigned char *dhm_P, size_t P_len,
2926 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002927{
Janos Follath865b3eb2019-12-16 11:46:15 +00002928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 mbedtls_mpi_free(&conf->dhm_P);
2931 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2934 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2935 mbedtls_mpi_free(&conf->dhm_P);
2936 mbedtls_mpi_free(&conf->dhm_G);
2937 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002938 }
2939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002941}
Paul Bakker5121ce52009-01-03 21:22:43 +00002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002944{
Janos Follath865b3eb2019-12-16 11:46:15 +00002945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 mbedtls_mpi_free(&conf->dhm_P);
2948 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2951 &conf->dhm_P)) != 0 ||
2952 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2953 &conf->dhm_G)) != 0) {
2954 mbedtls_mpi_free(&conf->dhm_P);
2955 mbedtls_mpi_free(&conf->dhm_G);
2956 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002957 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002960}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002961#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002962
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002963#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2964/*
2965 * Set the minimum length for Diffie-Hellman parameters
2966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2968 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002969{
2970 conf->dhm_min_bitlen = bitlen;
2971}
2972#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2973
Ronald Crone68ab4f2022-10-05 12:46:29 +02002974#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002975#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002976/*
2977 * Set allowed/preferred hashes for handshake signatures
2978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002979void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2980 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002981{
2982 conf->sig_hashes = hashes;
2983}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002984#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002985
Jerry Yuf017ee42022-01-12 15:49:48 +08002986/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2988 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002989{
Jerry Yuf017ee42022-01-12 15:49:48 +08002990#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2991 conf->sig_hashes = NULL;
2992#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2993 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002994}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002995#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002996
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002997#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002998#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002999/*
3000 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003001 *
3002 * mbedtls_ssl_setup() takes the provided list
3003 * and translates it to a list of IANA TLS group identifiers,
3004 * stored in ssl->handshake->group_list.
3005 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003007void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3008 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003009{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003010 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003011 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003012}
Brett Warrene0edc842021-08-17 09:53:13 +01003013#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003014#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003015
Brett Warrene0edc842021-08-17 09:53:13 +01003016/*
3017 * Set the allowed groups
3018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3020 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003021{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003022#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003023 conf->curve_list = NULL;
3024#endif
3025 conf->group_list = group_list;
3026}
3027
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003028#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003029int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003030{
Hanno Becker947194e2017-04-07 13:25:49 +01003031 /* Initialize to suppress unnecessary compiler warning */
3032 size_t hostname_len = 0;
3033
3034 /* Check if new hostname is valid before
3035 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (hostname != NULL) {
3037 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3041 }
Hanno Becker947194e2017-04-07 13:25:49 +01003042 }
3043
3044 /* Now it's clear that we will overwrite the old hostname,
3045 * so we can free it safely */
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003048 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003049 }
3050
3051 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003054 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 } else {
3056 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3057 if (ssl->hostname == NULL) {
3058 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3059 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003062
Hanno Becker947194e2017-04-07 13:25:49 +01003063 ssl->hostname[hostname_len] = '\0';
3064 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003067}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003068#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003069
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003070#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003071void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3072 int (*f_sni)(void *, mbedtls_ssl_context *,
3073 const unsigned char *, size_t),
3074 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003075{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003076 conf->f_sni = f_sni;
3077 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003078}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003082int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003083{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003084 size_t cur_len, tot_len;
3085 const char **p;
3086
3087 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003088 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3089 * MUST NOT be truncated."
3090 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003091 */
3092 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 for (p = protos; *p != NULL; p++) {
3094 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003095 tot_len += cur_len;
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if ((cur_len == 0) ||
3098 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3099 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3101 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003102 }
3103
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003104 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003107}
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003110{
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003112}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003114
Johan Pascalb62bb512015-12-03 21:56:45 +01003115#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003116void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3117 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003118{
3119 conf->dtls_srtp_mki_support = support_mki_value;
3120}
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3123 unsigned char *mki_value,
3124 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003125{
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003128 }
Ron Eldor591f1622018-01-22 12:30:04 +02003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3131 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003132 }
Ron Eldor591f1622018-01-22 12:30:04 +02003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003135 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003137}
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3140 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003141{
Johan Pascal253d0262020-09-22 13:04:45 +02003142 const mbedtls_ssl_srtp_profile *p;
3143 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003144
Johan Pascal253d0262020-09-22 13:04:45 +02003145 /* check the profiles list: all entry must be valid,
3146 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3148 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3149 p++) {
3150 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003151 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003153 /* unsupported value, stop parsing and set the size to an error value */
3154 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003155 }
3156 }
3157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3159 conf->dtls_srtp_profile_list = NULL;
3160 conf->dtls_srtp_profile_list_len = 0;
3161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003162 }
3163
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003164 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003165 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3171 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003172{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003173 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3174 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003176 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003178 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3180 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003181 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003182}
Johan Pascalb62bb512015-12-03 21:56:45 +01003183#endif /* MBEDTLS_SSL_DTLS_SRTP */
3184
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303185#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003186void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003187{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003188 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003189}
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003192{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003193 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003194}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303195#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003196
Janos Follath088ce432017-04-10 12:42:31 +01003197#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3199 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003200{
3201 conf->cert_req_ca_list = cert_req_ca_list;
3202}
3203#endif
3204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003206void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003207{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003208 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003209}
3210#endif
3211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003215 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003216}
3217#endif
3218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003220int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003221{
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3223 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003225 }
3226
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003227 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003230}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003232
Gilles Peskine449bd832023-01-11 14:50:10 +01003233void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003235 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003236}
3237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003239void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003240{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003241 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003242}
3243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003246 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003247}
3248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3250 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003251{
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003253}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003257#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003258void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003259{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003260 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003261}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003262#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003263
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003264#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003265
Jerry Yud0766ec2022-09-22 10:46:57 +08003266#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003267void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3268 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003269{
Jerry Yud0766ec2022-09-22 10:46:57 +08003270 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003271}
3272#endif
3273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3275 mbedtls_ssl_ticket_write_t *f_ticket_write,
3276 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3277 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003278{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003279 conf->f_ticket_write = f_ticket_write;
3280 conf->f_ticket_parse = f_ticket_parse;
3281 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003282}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003283#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3287 mbedtls_ssl_export_keys_t *f_export_keys,
3288 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003289{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003290 ssl->f_export_keys = f_export_keys;
3291 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003292}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003293
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003294#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003295void mbedtls_ssl_conf_async_private_cb(
3296 mbedtls_ssl_config *conf,
3297 mbedtls_ssl_async_sign_t *f_async_sign,
3298 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3299 mbedtls_ssl_async_resume_t *f_async_resume,
3300 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003302{
3303 conf->f_async_sign_start = f_async_sign;
3304 conf->f_async_decrypt_start = f_async_decrypt;
3305 conf->f_async_resume = f_async_resume;
3306 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003307 conf->p_async_config_data = async_config_data;
3308}
3309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003313}
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003316{
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 if (ssl->handshake == NULL) {
3318 return NULL;
3319 } else {
3320 return ssl->handshake->user_async_ctx;
3321 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003322}
3323
Gilles Peskine449bd832023-01-11 14:50:10 +01003324void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3325 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003326{
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003328 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003330}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003331#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003332
Paul Bakker5121ce52009-01-03 21:22:43 +00003333/*
3334 * SSL get accessors
3335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003336uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003337{
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 if (ssl->session != NULL) {
3339 return ssl->session->verify_result;
3340 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003341
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (ssl->session_negotiate != NULL) {
3343 return ssl->session_negotiate->verify_result;
3344 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003347}
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003350{
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (ssl == NULL || ssl->session == NULL) {
3352 return 0;
3353 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003356}
3357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003359{
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (ssl == NULL || ssl->session == NULL) {
3361 return NULL;
3362 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003363
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003365}
3366
Gilles Peskine449bd832023-01-11 14:50:10 +01003367const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003368{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3371 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003372 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003374 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003376 }
3377 }
3378#endif
3379
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003381 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003383 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003385 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003387 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003388}
3389
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003390#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003391size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003392{
David Horstmann95d516f2021-05-04 18:36:56 +01003393 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003394 size_t read_mfl;
3395
Jerry Yuddda0502022-12-01 19:43:12 +08003396#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003397 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3399 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3400 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003401 }
Jerry Yuddda0502022-12-01 19:43:12 +08003402#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003403
3404 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 if (ssl->session_out != NULL) {
3406 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3407 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003408 max_len = read_mfl;
3409 }
3410 }
3411
Jerry Yuddda0502022-12-01 19:43:12 +08003412 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 if (ssl->session_negotiate != NULL) {
3414 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3415 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003416 max_len = read_mfl;
3417 }
3418 }
3419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003421}
3422
Gilles Peskine449bd832023-01-11 14:50:10 +01003423size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003424{
3425 size_t max_len;
3426
3427 /*
3428 * Assume mfl_code is correct since it was checked when set
3429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003431
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003432 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (ssl->session_out != NULL &&
3434 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3435 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003436 }
3437
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003438 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 if (ssl->session_negotiate != NULL &&
3440 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3441 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003442 }
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003445}
3446#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3447
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003448#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003449size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003450{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003451 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3453 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3454 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3455 return 0;
3456 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003457
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3459 return ssl->mtu;
3460 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 if (ssl->mtu == 0) {
3463 return ssl->handshake->mtu;
3464 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003465
Gilles Peskine449bd832023-01-11 14:50:10 +01003466 return ssl->mtu < ssl->handshake->mtu ?
3467 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003468}
3469#endif /* MBEDTLS_SSL_PROTO_DTLS */
3470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003472{
3473 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3474
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003475#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003476 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003477 !defined(MBEDTLS_SSL_PROTO_DTLS)
3478 (void) ssl;
3479#endif
3480
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003481#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Waleed Elmelegy05d670b2023-12-14 16:00:57 +00003482 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003483
Waleed Elmelegy05d670b2023-12-14 16:00:57 +00003484 if (max_len > mfl) {
3485 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003487#endif
3488
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003489#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3490 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3491
3492 if (max_len > record_size_limit) {
3493 max_len = record_size_limit;
3494 }
3495#endif
3496
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003497#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003498 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3499 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3500 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003501 const size_t overhead = (size_t) ret;
3502
Gilles Peskine449bd832023-01-11 14:50:10 +01003503 if (ret < 0) {
3504 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003505 }
3506
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 if (mtu <= overhead) {
3508 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3509 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3510 }
3511
3512 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003513 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003515 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003516#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003517
Hanno Becker0defedb2018-08-10 12:35:02 +01003518#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3519 !defined(MBEDTLS_SSL_PROTO_DTLS)
3520 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003521#endif
3522
Gilles Peskine449bd832023-01-11 14:50:10 +01003523 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003524}
3525
Gilles Peskine449bd832023-01-11 14:50:10 +01003526int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003527{
3528 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3529
3530#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3531 (void) ssl;
3532#endif
3533
3534#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003535 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003536
Gilles Peskine449bd832023-01-11 14:50:10 +01003537 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003538 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003539 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003540#endif
3541
Gilles Peskine449bd832023-01-11 14:50:10 +01003542 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003543}
3544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003546const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003547{
Gilles Peskine449bd832023-01-11 14:50:10 +01003548 if (ssl == NULL || ssl->session == NULL) {
3549 return NULL;
3550 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003551
Hanno Beckere6824572019-02-07 13:18:46 +00003552#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003553 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003554#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003555 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003556#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003557}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003561int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3562 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003563{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003564 int ret;
3565
Gilles Peskine449bd832023-01-11 14:50:10 +01003566 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003567 dst == NULL ||
3568 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003569 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3570 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003571 }
3572
Hanno Beckere810bbc2021-05-14 16:01:05 +01003573 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3574 * idempotent: Each session can only be exported once.
3575 *
3576 * (This is in preparation for TLS 1.3 support where we will
3577 * need the ability to export multiple sessions (aka tickets),
3578 * which will be achieved by calling mbedtls_ssl_get_session()
3579 * multiple times until it fails.)
3580 *
3581 * Check whether we have already exported the current session,
3582 * and fail if so.
3583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 if (ssl->session->exported == 1) {
3585 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3586 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003587
Gilles Peskine449bd832023-01-11 14:50:10 +01003588 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3589 if (ret != 0) {
3590 return ret;
3591 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003592
3593 /* Remember that we've exported the session. */
3594 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003595 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003596}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003598
Paul Bakker5121ce52009-01-03 21:22:43 +00003599/*
Hanno Beckera835da52019-05-16 12:39:07 +01003600 * Define ticket header determining Mbed TLS version
3601 * and structure of the ticket.
3602 */
3603
Hanno Becker94ef3b32019-05-16 12:50:45 +01003604/*
Hanno Becker50b59662019-05-28 14:30:45 +01003605 * Define bitflag determining compile-time settings influencing
3606 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003607 */
3608
Hanno Becker50b59662019-05-28 14:30:45 +01003609#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003610#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003611#else
Hanno Becker3e088662019-05-29 11:10:18 +01003612#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003613#endif /* MBEDTLS_HAVE_TIME */
3614
3615#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003616#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003617#else
Hanno Becker3e088662019-05-29 11:10:18 +01003618#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003619#endif /* MBEDTLS_X509_CRT_PARSE_C */
3620
3621#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003622#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003623#else
Hanno Becker3e088662019-05-29 11:10:18 +01003624#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003625#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3626
3627#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003628#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003629#else
Hanno Becker3e088662019-05-29 11:10:18 +01003630#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003631#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3632
Hanno Becker94ef3b32019-05-16 12:50:45 +01003633#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003634#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003635#else
Hanno Becker3e088662019-05-29 11:10:18 +01003636#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003637#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3638
Hanno Becker94ef3b32019-05-16 12:50:45 +01003639#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3640#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3641#else
3642#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3643#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3644
Hanno Becker3e088662019-05-29 11:10:18 +01003645#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3646#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3647#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3648#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003649#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3650#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003651
Hanno Becker50b59662019-05-28 14:30:45 +01003652#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 ((uint16_t) ( \
3654 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3655 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3656 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3657 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3658 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3659 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3660 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003661
Hanno Beckerf8787072019-05-16 12:41:07 +01003662static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003663 MBEDTLS_VERSION_MAJOR,
3664 MBEDTLS_VERSION_MINOR,
3665 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3667 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003668};
Hanno Beckera835da52019-05-16 12:39:07 +01003669
3670/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003671 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003672 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003673 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003674 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003675 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003676 * opaque mbedtls_version[3]; // library version: major, minor, patch
3677 * opaque session_format[2]; // library-version specific 16-bit field
3678 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003679 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003680 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003681 * Note: When updating the format, remember to keep
3682 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003683 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003684 * // In this version, `session_format` determines
3685 * // the setting of those compile-time
3686 * // configuration options which influence
3687 * // the structure of mbedtls_ssl_session.
3688 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003689 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003690 * // - TLS 1.2 (0x0303)
3691 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003692 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003693 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003694 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003695 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003696 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003697 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003698 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003699 *
3700 * };
3701 *
3702 * } serialized_session;
3703 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003704 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003705
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003706MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003707static int ssl_session_save(const mbedtls_ssl_session *session,
3708 unsigned char omit_header,
3709 unsigned char *buf,
3710 size_t buf_len,
3711 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003712{
3713 unsigned char *p = buf;
3714 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003715 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003716#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3717 size_t out_len;
3718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3719#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003720 if (session == NULL) {
3721 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3722 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003723
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003725 /*
3726 * Add Mbed TLS version identifier
3727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003728 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003729
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 if (used <= buf_len) {
3731 memcpy(p, ssl_serialized_session_header,
3732 sizeof(ssl_serialized_session_header));
3733 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003734 }
3735 }
3736
3737 /*
3738 * TLS version identifier
3739 */
3740 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003741 if (used <= buf_len) {
3742 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003743 }
3744
3745 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003746 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003747 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003748#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003749 case MBEDTLS_SSL_VERSION_TLS1_2:
3750 used += ssl_tls12_session_save(session, p, remaining_len);
3751 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003752#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3753
Jerry Yu251a12e2022-07-13 15:15:48 +08003754#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003755 case MBEDTLS_SSL_VERSION_TLS1_3:
3756 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3757 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3758 return ret;
3759 }
3760 used += out_len;
3761 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003762#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3763
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 default:
3765 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003766 }
3767
3768 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003769 if (used > buf_len) {
3770 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3771 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003772
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003774}
3775
3776/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003777 * Public wrapper for ssl_session_save()
3778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003779int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3780 unsigned char *buf,
3781 size_t buf_len,
3782 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003783{
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003785}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003786
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003787/*
3788 * Deserialize session, see mbedtls_ssl_session_save() for format.
3789 *
3790 * This internal version is wrapped by a public function that cleans up in
3791 * case of error, and has an extra option omit_header.
3792 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003793MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003794static int ssl_session_load(mbedtls_ssl_session *session,
3795 unsigned char omit_header,
3796 const unsigned char *buf,
3797 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003798{
3799 const unsigned char *p = buf;
3800 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003801 size_t remaining_len;
3802
3803
Gilles Peskine449bd832023-01-11 14:50:10 +01003804 if (session == NULL) {
3805 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3806 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003807
Gilles Peskine449bd832023-01-11 14:50:10 +01003808 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003809 /*
3810 * Check Mbed TLS version identifier
3811 */
3812
Gilles Peskine449bd832023-01-11 14:50:10 +01003813 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003816
3817 if (memcmp(p, ssl_serialized_session_header,
3818 sizeof(ssl_serialized_session_header)) != 0) {
3819 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3820 }
3821 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003822 }
3823
3824 /*
3825 * TLS version identifier
3826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 if (1 > (size_t) (end - p)) {
3828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3829 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003830 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003831
3832 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003833 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003834 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003835#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 case MBEDTLS_SSL_VERSION_TLS1_2:
3837 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003838#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3839
Jerry Yu438ddd82022-07-07 06:55:50 +00003840#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 case MBEDTLS_SSL_VERSION_TLS1_3:
3842 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003843#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3844
Gilles Peskine449bd832023-01-11 14:50:10 +01003845 default:
3846 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003847 }
3848}
3849
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003850/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003851 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003853int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3854 const unsigned char *buf,
3855 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003856{
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003858
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 if (ret != 0) {
3860 mbedtls_ssl_session_free(session);
3861 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003862
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003864}
3865
3866/*
Paul Bakker1961b702013-01-25 14:49:24 +01003867 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003868 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003869MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003870static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003871{
3872 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3873
Ronald Cron66dbf912022-02-02 15:33:46 +01003874 /*
3875 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003876 * that were written into the output buffer by the previous handshake step,
3877 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003878 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3879 * We proceed to the next handshake step only when all data from the
3880 * previous one have been sent to the peer, thus we make sure that this is
3881 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3882 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3883 * we have to wait before to go ahead.
3884 * In the case of TLS 1.3, handshake step handlers do not send data to the
3885 * peer. Data are only sent here and through
3886 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003887 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003888 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003889 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3890 return ret;
3891 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003892
3893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3895 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3896 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3897 return ret;
3898 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003899 }
3900#endif /* MBEDTLS_SSL_PROTO_DTLS */
3901
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003903}
3904
Gilles Peskine449bd832023-01-11 14:50:10 +01003905int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003906{
Hanno Becker41934dd2021-08-07 19:13:43 +01003907 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003908
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003910 ssl->conf == NULL ||
3911 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003914 }
3915
Gilles Peskine449bd832023-01-11 14:50:10 +01003916 ret = ssl_prepare_handshake_step(ssl);
3917 if (ret != 0) {
3918 return ret;
3919 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003920
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 ret = mbedtls_ssl_handle_pending_alert(ssl);
3922 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003923 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 }
Jerry Yue7047812021-09-13 19:26:39 +08003925
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003926 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3927 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3928 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003930#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3932 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003933 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003934
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003936 case MBEDTLS_SSL_HELLO_REQUEST:
3937 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003938 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003939 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003940
Ronald Cron9f0fba32022-02-10 16:45:15 +01003941 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003943 break;
3944
3945 default:
3946#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3948 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3949 } else {
3950 ret = mbedtls_ssl_handshake_client_step(ssl);
3951 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003952#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003954#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003956#endif
3957 }
Jerry Yub9930e72021-08-06 17:11:51 +08003958 }
Ronald Cron6291b232023-03-08 15:51:25 +01003959#endif /* MBEDTLS_SSL_CLI_C */
3960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003961#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003963#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3964 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003966 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 ret = mbedtls_ssl_handshake_server_step(ssl);
3968 }
Ronald Cron6291b232023-03-08 15:51:25 +01003969#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3970 ret = mbedtls_ssl_handshake_server_step(ssl);
3971#else
3972 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003973#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003974 }
3975#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003978 /* handshake_step return error. And it is same
3979 * with alert_reason.
3980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 if (ssl->send_alert) {
3982 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003983 goto cleanup;
3984 }
3985 }
3986
3987cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003989}
3990
3991/*
3992 * Perform the SSL handshake
3993 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003994int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003995{
3996 int ret = 0;
3997
Hanno Beckera817ea42020-10-20 15:20:23 +01003998 /* Sanity checks */
3999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (ssl == NULL || ssl->conf == NULL) {
4001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4002 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004003
Hanno Beckera817ea42020-10-20 15:20:23 +01004004#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4006 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4007 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4008 "mbedtls_ssl_set_timer_cb() for DTLS"));
4009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004010 }
4011#endif /* MBEDTLS_SSL_PROTO_DTLS */
4012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004014
Hanno Beckera817ea42020-10-20 15:20:23 +01004015 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4017 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004020 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 }
Paul Bakker1961b702013-01-25 14:49:24 +01004022 }
4023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004027}
4028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004029#if defined(MBEDTLS_SSL_RENEGOTIATION)
4030#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004031/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004032 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004033 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004034MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004035static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004036{
Janos Follath865b3eb2019-12-16 11:46:15 +00004037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004038
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004040
4041 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004042 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4043 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4046 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4047 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004048 }
4049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004053}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004055
4056/*
4057 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004058 * - any side: calling mbedtls_ssl_renegotiate(),
4059 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4060 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004061 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004062 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004063 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004066{
Janos Follath865b3eb2019-12-16 11:46:15 +00004067 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 if ((ret = ssl_handshake_init(ssl)) != 0) {
4072 return ret;
4073 }
Paul Bakker48916f92012-09-16 19:57:18 +00004074
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004075 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4076 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4079 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4080 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004081 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004083 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004085 }
4086#endif
4087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004088 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4089 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4092 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4093 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004094 }
4095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004097
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004099}
4100
4101/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004102 * Renegotiate current connection on client,
4103 * or request renegotiation on server
4104 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004105int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004106{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (ssl == NULL || ssl->conf == NULL) {
4110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4111 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004113#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004114 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4116 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4118 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004120 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004121
4122 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 if (ssl->out_left != 0) {
4124 return mbedtls_ssl_flush_output(ssl);
4125 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004128 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004129#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004132 /*
4133 * On client, either start the renegotiation process or,
4134 * if already in progress, continue the handshake
4135 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4137 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4138 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004139 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004140
4141 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4142 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4143 return ret;
4144 }
4145 } else {
4146 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4147 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4148 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004149 }
4150 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004151#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004154}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004155#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004156
Gilles Peskine449bd832023-01-11 14:50:10 +01004157void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004158{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004159 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004162 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004164
Valerio Setti6f0441d2023-07-03 12:11:36 +02004165#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004166#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (ssl->handshake->group_list_heap_allocated) {
4168 mbedtls_free((void *) handshake->group_list);
4169 }
Brett Warrene0edc842021-08-17 09:53:13 +01004170 handshake->group_list = NULL;
4171#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004172#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004173
Ronald Crone68ab4f2022-10-05 12:46:29 +02004174#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004175#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 if (ssl->handshake->sig_algs_heap_allocated) {
4177 mbedtls_free((void *) handshake->sig_algs);
4178 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004179 handshake->sig_algs = NULL;
4180#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004181#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (ssl->handshake->certificate_request_context) {
4183 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004184 }
4185#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004186#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004187
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004188#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4190 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004191 handshake->async_in_progress = 0;
4192 }
4193#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4194
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004195#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004196#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004198#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004199 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004200#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004201#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004202#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004203#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004205#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004206 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004207#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004208#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004210#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004212#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004213#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004214 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004216#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004217
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004218#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004219#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004221 /*
4222 * Opaque keys are not stored in the handshake's data and it's the user
4223 * responsibility to destroy them. Clear ones, instead, are created by
4224 * the TLS library and should be destroyed at the same level
4225 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4227 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004228 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004229 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4230#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004232#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004233#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004235 handshake->ecjpake_cache = NULL;
4236 handshake->ecjpake_cache_len = 0;
4237#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004238#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004239
Valerio Setti7aeec542023-07-05 18:57:21 +02004240#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004241 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004242 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004243 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004245#endif
4246
Ronald Cron73fe8df2022-10-05 14:31:43 +02004247#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004250 /* The maintenance of the external PSK key slot is the
4251 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (ssl->handshake->psk_opaque_is_internal) {
4253 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004254 ssl->handshake->psk_opaque_is_internal = 0;
4255 }
4256 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4257 }
Neil Armstronge952a302022-05-03 10:22:14 +02004258#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004260 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004261 }
Neil Armstronge952a302022-05-03 10:22:14 +02004262#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004263#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004265#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4266 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004267 /*
4268 * Free only the linked list wrapper, not the keys themselves
4269 * since the belong to the SNI callback
4270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004272#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004273
Gilles Peskineeccd8882020-03-10 12:19:08 +01004274#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4276 if (handshake->ecrs_peer_cert != NULL) {
4277 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4278 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004279 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004280#endif
4281
Hanno Becker75173122019-02-06 16:18:31 +00004282#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4283 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004285#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4286
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004287#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4289 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004290#endif /* MBEDTLS_SSL_CLI_C &&
4291 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004292
4293#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 mbedtls_ssl_flight_free(handshake->flight);
4295 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004296#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004297
Valerio Settiea59c432023-07-25 11:14:03 +02004298#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004299 if (handshake->xxdh_psa_privkey_is_external == 0) {
4300 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 }
Valerio Settiea59c432023-07-25 11:14:03 +02004302#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004303
Ronald Cron6f135e12021-12-08 16:57:54 +01004304#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 mbedtls_ssl_transform_free(handshake->transform_handshake);
4306 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004307#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4309 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004310#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004311#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004312
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004313
4314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4315 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4316 * processes datagrams and the fact that a datagram is allowed to have
4317 * several records in it, it is possible that the I/O buffers are not
4318 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4320 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004321#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004322
Jerry Yuba9c7272021-10-30 11:54:10 +08004323 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 mbedtls_platform_zeroize(handshake,
4325 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004326}
4327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004329{
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004331 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004334#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004336#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004337
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004338#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004339#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4340 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004342#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004344#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004347}
4348
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004349#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004350
4351#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4352#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4353#else
4354#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4355#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4356
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004357#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004358
4359#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4360#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4361#else
4362#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4363#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4364
4365#if defined(MBEDTLS_SSL_ALPN)
4366#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4367#else
4368#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4369#endif /* MBEDTLS_SSL_ALPN */
4370
4371#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4372#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4373#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4374#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4375
4376#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 ((uint32_t) ( \
4378 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4379 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4380 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4381 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4382 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4383 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4384 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4385 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004386
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004387static unsigned char ssl_serialized_context_header[] = {
4388 MBEDTLS_VERSION_MAJOR,
4389 MBEDTLS_VERSION_MINOR,
4390 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4392 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4393 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4394 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4395 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004396};
4397
Paul Bakker5121ce52009-01-03 21:22:43 +00004398/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004399 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004400 *
4401 * The format of the serialized data is:
4402 * (in the presentation language of TLS, RFC 8446 section 3)
4403 *
4404 * // header
4405 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004406 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004407 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004408 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004409 * Note: When updating the format, remember to keep these
4410 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004411 *
4412 * // session sub-structure
4413 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4414 * // transform sub-structure
4415 * uint8 random[64]; // ServerHello.random+ClientHello.random
4416 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4417 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4418 * // fields from ssl_context
4419 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4420 * uint64 in_window_top; // DTLS: last validated record seq_num
4421 * uint64 in_window; // DTLS: bitmask for replay protection
4422 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4423 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4424 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4425 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4426 *
4427 * Note that many fields of the ssl_context or sub-structures are not
4428 * serialized, as they fall in one of the following categories:
4429 *
4430 * 1. forced value (eg in_left must be 0)
4431 * 2. pointer to dynamically-allocated memory (eg session, transform)
4432 * 3. value can be re-derived from other data (eg session keys from MS)
4433 * 4. value was temporary (eg content of input buffer)
4434 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004436int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4437 unsigned char *buf,
4438 size_t buf_len,
4439 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004440{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004441 unsigned char *p = buf;
4442 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004443 size_t session_len;
4444 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004445
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004446 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004447 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4448 * this function's documentation.
4449 *
4450 * These are due to assumptions/limitations in the implementation. Some of
4451 * them are likely to stay (no handshake in progress) some might go away
4452 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004453 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004454 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4456 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4457 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004458 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (ssl->handshake != NULL) {
4460 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004462 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004463 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (ssl->transform == NULL || ssl->session == NULL) {
4465 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004467 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004468 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (mbedtls_ssl_check_pending(ssl) != 0) {
4470 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4471 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004472 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->out_left != 0) {
4474 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004476 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004477 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4479 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4480 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004481 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004482 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4484 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004486 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004487 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4489 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004491 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004492 /* Renegotiation must not be enabled */
4493#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4495 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004497 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004498#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004499
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004500 /*
4501 * Version and format identifier
4502 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (used <= buf_len) {
4506 memcpy(p, ssl_serialized_context_header,
4507 sizeof(ssl_serialized_context_header));
4508 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004509 }
4510
4511 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004512 * Session (length + data)
4513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4515 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4516 return ret;
4517 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004518
4519 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (used <= buf_len) {
4521 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004522 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 ret = ssl_session_save(ssl->session, 1,
4525 p, session_len, &session_len);
4526 if (ret != 0) {
4527 return ret;
4528 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004529
4530 p += session_len;
4531 }
4532
4533 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004534 * Transform
4535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 used += sizeof(ssl->transform->randbytes);
4537 if (used <= buf_len) {
4538 memcpy(p, ssl->transform->randbytes,
4539 sizeof(ssl->transform->randbytes));
4540 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004541 }
4542
4543#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004544 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004546 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004548 p += ssl->transform->in_cid_len;
4549
4550 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004552 p += ssl->transform->out_cid_len;
4553 }
4554#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4555
4556 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004557 * Saved fields from top-level ssl_context structure
4558 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004559 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (used <= buf_len) {
4561 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004562 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004563 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004564
4565#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4566 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (used <= buf_len) {
4568 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004569 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004570
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004572 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004573 }
4574#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4575
4576#if defined(MBEDTLS_SSL_PROTO_DTLS)
4577 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004579 *p++ = ssl->disable_datagram_packing;
4580 }
4581#endif /* MBEDTLS_SSL_PROTO_DTLS */
4582
Jerry Yuae0b2e22021-10-08 15:21:19 +08004583 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (used <= buf_len) {
4585 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004586 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004587 }
4588
4589#if defined(MBEDTLS_SSL_PROTO_DTLS)
4590 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (used <= buf_len) {
4592 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004593 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004594 }
4595#endif /* MBEDTLS_SSL_PROTO_DTLS */
4596
4597#if defined(MBEDTLS_SSL_ALPN)
4598 {
4599 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004601 : 0;
4602
4603 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004605 *p++ = alpn_len;
4606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (ssl->alpn_chosen != NULL) {
4608 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004609 p += alpn_len;
4610 }
4611 }
4612 }
4613#endif /* MBEDTLS_SSL_ALPN */
4614
4615 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004616 * Done
4617 */
4618 *olen = used;
4619
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (used > buf_len) {
4621 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4622 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004627}
4628
4629/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004630 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004631 *
4632 * This internal version is wrapped by a public function that cleans up in
4633 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004634 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004636static int ssl_context_load(mbedtls_ssl_context *ssl,
4637 const unsigned char *buf,
4638 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004639{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004640 const unsigned char *p = buf;
4641 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004642 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004643 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004644#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004645 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004646#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004647
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004648 /*
4649 * The context should have been freshly setup or reset.
4650 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004651 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004652 * renegotiating, or if the user mistakenly loaded a session first.)
4653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4655 ssl->session != NULL) {
4656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004657 }
4658
4659 /*
4660 * We can't check that the config matches the initial one, but we can at
4661 * least check it matches the requirements for serializing.
4662 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004663 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004664#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004665 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004666#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004667 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4668 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4669 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4670 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004672 }
4673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004675
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004676 /*
4677 * Check version identifier
4678 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004681 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004682
4683 if (memcmp(p, ssl_serialized_context_header,
4684 sizeof(ssl_serialized_context_header)) != 0) {
4685 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4686 }
4687 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004688
4689 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004690 * Session
4691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if ((size_t) (end - p) < 4) {
4693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4694 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004695
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004696 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004697 p += 4;
4698
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004699 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004700 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004701 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004702 ssl->session_in = ssl->session;
4703 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004704 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 if ((size_t) (end - p) < session_len) {
4707 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4708 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 ret = ssl_session_load(ssl->session, 1, p, session_len);
4711 if (ret != 0) {
4712 mbedtls_ssl_session_free(ssl->session);
4713 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004714 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004715
4716 p += session_len;
4717
4718 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004719 * Transform
4720 */
4721
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004722 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004723 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004724#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004725 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004726 ssl->transform_in = ssl->transform;
4727 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004728 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004729#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004730
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004731#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4733 if (prf_func == NULL) {
4734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4735 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004736
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004737 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4740 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004741
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 ret = ssl_tls12_populate_transform(ssl->transform,
4743 ssl->session->ciphersuite,
4744 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004745#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004747#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 prf_func,
4749 p, /* currently pointing to randbytes */
4750 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4751 ssl->conf->endpoint,
4752 ssl);
4753 if (ret != 0) {
4754 return ret;
4755 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004758
4759#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4760 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if ((size_t) (end - p) < 1) {
4762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4763 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004764
4765 ssl->transform->in_cid_len = *p++;
4766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4769 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004772 p += ssl->transform->in_cid_len;
4773
4774 ssl->transform->out_cid_len = *p++;
4775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4778 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004781 p += ssl->transform->out_cid_len;
4782#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4783
4784 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004785 * Saved fields from top-level ssl_context structure
4786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if ((size_t) (end - p) < 4) {
4788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4789 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004790
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004791 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004792 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004793
4794#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if ((size_t) (end - p) < 16) {
4796 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4797 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004798
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004799 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004800 p += 8;
4801
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004802 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004803 p += 8;
4804#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4805
4806#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 if ((size_t) (end - p) < 1) {
4808 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4809 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004810
4811 ssl->disable_datagram_packing = *p++;
4812#endif /* MBEDTLS_SSL_PROTO_DTLS */
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4816 }
4817 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4818 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004819
4820#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 if ((size_t) (end - p) < 2) {
4822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4823 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004824
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004825 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004826 p += 2;
4827#endif /* MBEDTLS_SSL_PROTO_DTLS */
4828
4829#if defined(MBEDTLS_SSL_ALPN)
4830 {
4831 uint8_t alpn_len;
4832 const char **cur;
4833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if ((size_t) (end - p) < 1) {
4835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4836 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004837
4838 alpn_len = *p++;
4839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004841 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4843 if (strlen(*cur) == alpn_len &&
4844 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 ssl->alpn_chosen = *cur;
4846 break;
4847 }
4848 }
4849 }
4850
4851 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4854 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004855
4856 p += alpn_len;
4857 }
4858#endif /* MBEDTLS_SSL_ALPN */
4859
4860 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004861 * Forced fields from top-level ssl_context structure
4862 *
4863 * Most of them already set to the correct value by mbedtls_ssl_init() and
4864 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4865 */
4866 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004867 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004868
Hanno Becker361b10d2019-08-30 10:42:49 +01004869 /* Adjust pointers for header fields of outgoing records to
4870 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004872
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004873#if defined(MBEDTLS_SSL_PROTO_DTLS)
4874 ssl->in_epoch = 1;
4875#endif
4876
4877 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4878 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004879 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4880 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 if (ssl->handshake != NULL) {
4882 mbedtls_ssl_handshake_free(ssl);
4883 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004884 ssl->handshake = NULL;
4885 }
4886
4887 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004888 * Done - should have consumed entire buffer
4889 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (p != end) {
4891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4892 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004895}
4896
4897/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004898 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4901 const unsigned char *buf,
4902 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004903{
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (ret != 0) {
4907 mbedtls_ssl_free(context);
4908 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004911}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004912#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004913
4914/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004915 * Free an SSL context
4916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004917void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004918{
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004920 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004926#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4927 size_t out_buf_len = ssl->out_buf_len;
4928#else
4929 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4930#endif
4931
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004932 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004933 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004934 }
4935
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004937#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4938 size_t in_buf_len = ssl->in_buf_len;
4939#else
4940 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4941#endif
4942
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004943 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004944 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004945 }
4946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if (ssl->transform) {
4948 mbedtls_ssl_transform_free(ssl->transform);
4949 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004950 }
4951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (ssl->handshake) {
4953 mbedtls_ssl_handshake_free(ssl);
4954 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004955
4956#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4958 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004959#endif
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 mbedtls_ssl_session_free(ssl->session_negotiate);
4962 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004963 }
4964
Ronald Cron6f135e12021-12-08 16:57:54 +01004965#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 mbedtls_ssl_transform_free(ssl->transform_application);
4967 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004968#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004969
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (ssl->session) {
4971 mbedtls_ssl_session_free(ssl->session);
4972 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004973 }
4974
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004975#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004977 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004979#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004980
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004981#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004983#endif
4984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004986
Paul Bakker86f04f42013-02-14 11:20:09 +01004987 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004989}
4990
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004991/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004992 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004993 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004994void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004995{
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004997}
4998
Gilles Peskineae270bf2021-06-02 00:05:29 +02004999/* The selection should be the same as mbedtls_x509_crt_profile_default in
5000 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005001 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005002 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005003 * about this list.
5004 */
Brett Warrene0edc842021-08-17 09:53:13 +01005005static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005006#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005007 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005008#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005009#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005010 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005011#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005012#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005013 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005014#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005015#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005016 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005017#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005018#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005019 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005020#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005021#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005022 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005023#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005024#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005025 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005026#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005027#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005028 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005029#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005030#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005031 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5032 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5033 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5034 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5035 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5036#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005037 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005038};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005039
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005040static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005041 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5042 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5043 0
5044};
5045
Ronald Crone68ab4f2022-10-05 12:46:29 +02005046#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005047
Jerry Yu909df7b2022-01-22 11:56:27 +08005048/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005049 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005050 * rules SHOULD be upheld.
5051 * - No duplicate entries.
5052 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005053 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005054 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005055 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005056static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005057
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005058#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005059 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005060 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005061 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005062 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5063#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005064
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005065#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005066 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005067 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005068 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005069 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5070#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005071
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005072#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005074 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005075 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005076 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5077#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005080 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005081 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005082#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005084
Gilles Peskine449bd832023-01-11 14:50:10 +01005085#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005087 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005088#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005089 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005092 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005093 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005094#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005095 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005096
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005097#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005098 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005099#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005100
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005101#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005102 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005103#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005104
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005105#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005106 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005108
Gabor Mezei15b95a62022-05-09 16:37:58 +02005109 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005110};
5111
5112/* NOTICE: see above */
5113#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5114static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005115#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005116#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005118#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005119#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5120 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5121#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005122#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005124#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005125#endif /* MBEDTLS_MD_CAN_SHA512*/
5126#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005127#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005129#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005130#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5131 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5132#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005133#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005135#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005136#endif /* MBEDTLS_MD_CAN_SHA384*/
5137#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005138#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005140#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005141#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5142 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5143#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005144#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005146#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005147#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005148 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005149};
5150#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5151/* NOTICE: see above */
5152static uint16_t ssl_preset_suiteb_sig_algs[] = {
5153
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005154#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005155 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005156 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005157 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005158 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5159#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005160
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005161#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005162 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005163 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005164 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005165 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5166#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005169 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005170 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005171#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005172 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005173
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005174#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005175 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005176#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005177
Gabor Mezei15b95a62022-05-09 16:37:58 +02005178 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005179};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005180
Jerry Yu909df7b2022-01-22 11:56:27 +08005181/* NOTICE: see above */
5182#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5183static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005184#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005185#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005187#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005188#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005190#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005191#endif /* MBEDTLS_MD_CAN_SHA256*/
5192#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005193#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005195#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005196#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005198#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005199#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005200 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005201};
Jerry Yu909df7b2022-01-22 11:56:27 +08005202#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5203
Ronald Crone68ab4f2022-10-05 12:46:29 +02005204#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005205
Brett Warrene0edc842021-08-17 09:53:13 +01005206static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005207#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005208 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005209#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005210#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005211 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005212#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005213 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005214};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005215
Ronald Crone68ab4f2022-10-05 12:46:29 +02005216#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005217/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005218 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005220static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005221{
5222 size_t i, j;
5223 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5226 for (j = 0; j < i; j++) {
5227 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005228 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 }
5230 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5231 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5232 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005233 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005234 }
5235 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005237}
5238
Ronald Crone68ab4f2022-10-05 12:46:29 +02005239#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005240
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005241/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005242 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005243 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005244int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5245 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005246{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005247#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005249#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005250
Ronald Crone68ab4f2022-10-05 12:46:29 +02005251#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5253 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5254 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005255 }
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5258 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5259 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005260 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005261
5262#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5264 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5265 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005266 }
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5269 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5270 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005271 }
5272#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005273#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005274
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005275 /* Use the functions here so that they are covered in tests,
5276 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 mbedtls_ssl_conf_endpoint(conf, endpoint);
5278 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005279
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005280 /*
5281 * Things that are common to all presets
5282 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005283#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005285 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5286#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5287 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5288#endif
5289 }
5290#endif
5291
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005292#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5293 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5294#endif
5295
5296#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5297 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5298#endif
5299
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005300#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005301 conf->f_cookie_write = ssl_cookie_write_dummy;
5302 conf->f_cookie_check = ssl_cookie_check_dummy;
5303#endif
5304
5305#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5306 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5307#endif
5308
Janos Follath088ce432017-04-10 12:42:31 +01005309#if defined(MBEDTLS_SSL_SRV_C)
5310 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005311 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005312#endif
5313
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005314#if defined(MBEDTLS_SSL_PROTO_DTLS)
5315 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5316 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5317#endif
5318
5319#if defined(MBEDTLS_SSL_RENEGOTIATION)
5320 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 memset(conf->renego_period, 0x00, 2);
5322 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005323#endif
5324
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005327 const unsigned char dhm_p[] =
5328 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5329 const unsigned char dhm_g[] =
5330 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005331
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5333 dhm_p, sizeof(dhm_p),
5334 dhm_g, sizeof(dhm_g))) != 0) {
5335 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005336 }
5337 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005338#endif
5339
Ronald Cron6f135e12021-12-08 16:57:54 +01005340#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005341
5342#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005343 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005344#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005345 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005346#endif
5347#endif /* MBEDTLS_SSL_EARLY_DATA */
5348
Jerry Yud0766ec2022-09-22 10:46:57 +08005349#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005350 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005352#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005353 /*
5354 * Allow all TLS 1.3 key exchange modes by default.
5355 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005356 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005357#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005358
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005360#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005361 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005362 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005363#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005365#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005367#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005368 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5369 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005370#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5371 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5372 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5373#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5374 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5375 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5376#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005378#endif
5379 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005380
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005381 /*
5382 * Preset-specific defaults
5383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005385 /*
5386 * NSA Suite B
5387 */
5388 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005389
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005390 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005391
5392#if defined(MBEDTLS_X509_CRT_PARSE_C)
5393 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005394#endif
5395
Ronald Crone68ab4f2022-10-05 12:46:29 +02005396#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005397#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005399 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005401#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005403#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005404
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005405#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005406 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005407#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005408 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005409 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005410
5411 /*
5412 * Default
5413 */
5414 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005415
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005416 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005417
5418#if defined(MBEDTLS_X509_CRT_PARSE_C)
5419 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5420#endif
5421
Ronald Crone68ab4f2022-10-05 12:46:29 +02005422#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005423#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005425 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005427#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005429#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005430
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005431#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005432 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005433#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005434 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005435
5436#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5437 conf->dhm_min_bitlen = 1024;
5438#endif
5439 }
5440
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005442}
5443
5444/*
5445 * Free mbedtls_ssl_config
5446 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005447void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005448{
5449#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 mbedtls_mpi_free(&conf->dhm_P);
5451 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005452#endif
5453
Ronald Cron73fe8df2022-10-05 14:31:43 +02005454#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005455#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005457 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5458 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005459#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005461 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005462 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005463 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005464 }
5465
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005467 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005468 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005469 conf->psk_identity_len = 0;
5470 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005471#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005472
5473#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005475#endif
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005478}
5479
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005480#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005481 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005482/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005486{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5489 return MBEDTLS_SSL_SIG_RSA;
5490 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005491#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005492#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5494 return MBEDTLS_SSL_SIG_ECDSA;
5495 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005496#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005498}
5499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005501{
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005503 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005505 case MBEDTLS_PK_ECDSA:
5506 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005508 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005510 }
5511}
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005514{
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516#if defined(MBEDTLS_RSA_C)
5517 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005519#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005520#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005523#endif
5524 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005526 }
5527}
Valerio Settie9646ec2023-08-02 20:02:28 +02005528#endif /* MBEDTLS_PK_C &&
5529 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005530
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005531/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005532 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005533 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005534mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005535{
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005537#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005540#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005541#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005542 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005544#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005545#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005548#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005549#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005552#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005553#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005556#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005557#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005558 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005560#endif
5561 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005563 }
5564}
5565
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005566/*
5567 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005569unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005570{
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005572#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005573 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005575#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005576#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005577 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005579#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005580#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005581 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005583#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005584#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005585 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005587#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005588#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005589 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005591#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005592#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005593 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005595#endif
5596 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005598 }
5599}
5600
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005601/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005602 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005603 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005605int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005606{
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005608
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 if (group_list == NULL) {
5610 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005611 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005612
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 for (; *group_list != 0; group_list++) {
5614 if (*group_list == tls_id) {
5615 return 0;
5616 }
5617 }
5618
5619 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005620}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005621
Valerio Setti49e69072023-06-27 17:27:51 +02005622#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005623/*
5624 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005626int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005627{
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005629
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005631 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005635}
Valerio Setti49e69072023-06-27 17:27:51 +02005636#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005637
Valerio Setti18c9fed2022-12-30 17:44:24 +01005638static const struct {
5639 uint16_t tls_id;
5640 mbedtls_ecp_group_id ecp_group_id;
5641 psa_ecc_family_t psa_family;
5642 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643} tls_id_match_table[] =
5644{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005645#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005646 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005648#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005649 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005651#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005652 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005653#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005654#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005655 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005658 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005659#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005660#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005661 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005662#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005663#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005664 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005665#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005666#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005667 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005669#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005670 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005671#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005672#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005673 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005674#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005675#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005676 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005678#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005679 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005680#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005681#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005682 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005684 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005685};
5686
Gilles Peskine449bd832023-01-11 14:50:10 +01005687int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005688 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005690{
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5692 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005693 if (type != NULL) {
5694 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 }
5696 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005697 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005699 return PSA_SUCCESS;
5700 }
5701 }
5702
5703 return PSA_ERROR_NOT_SUPPORTED;
5704}
5705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005707{
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5709 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005710 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005712 }
5713
5714 return MBEDTLS_ECP_DP_NONE;
5715}
5716
Gilles Peskine449bd832023-01-11 14:50:10 +01005717uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005718{
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5720 i++) {
5721 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005722 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005724 }
5725
5726 return 0;
5727}
5728
Valerio Setti67419f02023-01-04 16:12:42 +01005729#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005730static const struct {
5731 uint16_t tls_id;
5732 const char *name;
5733} tls_id_curve_name_table[] =
5734{
Valerio Setti54e23792023-07-07 10:49:27 +02005735 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5736 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5737 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5738 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5739 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5740 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5741 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5742 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5743 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5744 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5745 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5746 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5747 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005748 { 0, NULL },
5749};
5750
Gilles Peskine449bd832023-01-11 14:50:10 +01005751const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005752{
Valerio Settiacd32c02023-06-29 18:06:29 +02005753 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5754 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5755 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005757 }
5758
5759 return NULL;
5760}
Valerio Setti67419f02023-01-04 16:12:42 +01005761#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005764int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5765 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5766 int cert_endpoint,
5767 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005768{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005769 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005770 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005771 const char *ext_oid;
5772 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005775 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005777 case MBEDTLS_KEY_EXCHANGE_RSA:
5778 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005779 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005780 break;
5781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005782 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5783 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5784 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5785 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005786 break;
5787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5789 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005790 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005791 break;
5792
5793 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005794 case MBEDTLS_KEY_EXCHANGE_NONE:
5795 case MBEDTLS_KEY_EXCHANGE_PSK:
5796 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5797 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005798 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005799 usage = 0;
5800 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5803 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005804 }
5805
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005807 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005808 ret = -1;
5809 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005810
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5814 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005815 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005817 }
5818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005820 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005821 ret = -1;
5822 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005825}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005826#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005827
Jerry Yu148165c2021-09-24 23:20:59 +08005828#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005829int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5830 const mbedtls_md_type_t md,
5831 unsigned char *dst,
5832 size_t dst_len,
5833 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005834{
Ronald Cronf6893e12022-01-07 22:09:01 +01005835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5836 psa_hash_operation_t *hash_operation_to_clone;
5837 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5838
Jerry Yu148165c2021-09-24 23:20:59 +08005839 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005842#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 case MBEDTLS_MD_SHA384:
5844 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5845 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005846#endif
5847
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005848#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 case MBEDTLS_MD_SHA256:
5850 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5851 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005852#endif
5853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 default:
5855 goto exit;
5856 }
5857
5858 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5859 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005860 goto exit;
5861 }
5862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5864 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005865 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005867
5868exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005869#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5870 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005871 (void) ssl;
5872#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005873 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005874}
5875#else /* MBEDTLS_USE_PSA_CRYPTO */
5876
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005877#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005878MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005879static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5880 unsigned char *dst,
5881 size_t dst_len,
5882 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005883{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005884 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005885 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005886
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (dst_len < 48) {
5888 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5889 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005891 mbedtls_md_init(&sha384);
5892 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005893 if (ret != 0) {
5894 goto exit;
5895 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005896 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005897 if (ret != 0) {
5898 goto exit;
5899 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005900
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005901 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005902 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005903 goto exit;
5904 }
5905
5906 *olen = 48;
5907
5908exit:
5909
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005910 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005912}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005913#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005914
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005915#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005917static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5918 unsigned char *dst,
5919 size_t dst_len,
5920 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005921{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005922 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005923 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 if (dst_len < 32) {
5926 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5927 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005928
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005929 mbedtls_md_init(&sha256);
5930 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5931 if (ret != 0) {
5932 goto exit;
5933 }
5934 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5935 if (ret != 0) {
5936 goto exit;
5937 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005938
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005939 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5940 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005941 goto exit;
5942 }
5943
5944 *olen = 32;
5945
5946exit:
5947
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005948 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005950}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005951#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5954 const mbedtls_md_type_t md,
5955 unsigned char *dst,
5956 size_t dst_len,
5957 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005958{
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005960
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005961#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 case MBEDTLS_MD_SHA384:
5963 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005964#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005965
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005966#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 case MBEDTLS_MD_SHA256:
5968 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005969#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005972#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5973 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 (void) ssl;
5975 (void) dst;
5976 (void) dst_len;
5977 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005978#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005980 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005982}
XiaokangQian647719a2021-12-07 09:16:29 +00005983
Jerry Yu148165c2021-09-24 23:20:59 +08005984#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005985
Ronald Crone68ab4f2022-10-05 12:46:29 +02005986#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005987/* mbedtls_ssl_parse_sig_alg_ext()
5988 *
5989 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5990 * value (TLS 1.3 RFC8446):
5991 * enum {
5992 * ....
5993 * ecdsa_secp256r1_sha256( 0x0403 ),
5994 * ecdsa_secp384r1_sha384( 0x0503 ),
5995 * ecdsa_secp521r1_sha512( 0x0603 ),
5996 * ....
5997 * } SignatureScheme;
5998 *
5999 * struct {
6000 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6001 * } SignatureSchemeList;
6002 *
6003 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6004 * value (TLS 1.2 RFC5246):
6005 * enum {
6006 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6007 * sha512(6), (255)
6008 * } HashAlgorithm;
6009 *
6010 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6011 * SignatureAlgorithm;
6012 *
6013 * struct {
6014 * HashAlgorithm hash;
6015 * SignatureAlgorithm signature;
6016 * } SignatureAndHashAlgorithm;
6017 *
6018 * SignatureAndHashAlgorithm
6019 * supported_signature_algorithms<2..2^16-2>;
6020 *
6021 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6022 * generalization of the TLS 1.2 signature algorithm extension.
6023 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6024 * `SignatureScheme` field of TLS 1.3
6025 *
6026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006027int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6028 const unsigned char *buf,
6029 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006030{
6031 const unsigned char *p = buf;
6032 size_t supported_sig_algs_len = 0;
6033 const unsigned char *supported_sig_algs_end;
6034 uint16_t sig_alg;
6035 uint32_t common_idx = 0;
6036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6038 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006039 p += 2;
6040
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 memset(ssl->handshake->received_sig_algs, 0,
6042 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006045 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 while (p < supported_sig_algs_end) {
6047 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6048 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006049 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6051 sig_alg,
6052 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6055 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6056 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006057 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006058 }
6059#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6062 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006065 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6066 common_idx += 1;
6067 }
6068 }
6069 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (p != end) {
6071 MBEDTLS_SSL_DEBUG_MSG(1,
6072 ("Signature algorithms extension length misaligned"));
6073 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6074 MBEDTLS_ERR_SSL_DECODE_ERROR);
6075 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006076 }
6077
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 if (common_idx == 0) {
6079 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6080 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6081 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6082 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006083 }
6084
Gabor Mezei15b95a62022-05-09 16:37:58 +02006085 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006087}
6088
Ronald Crone68ab4f2022-10-05 12:46:29 +02006089#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006090
Jerry Yudc7bd172022-02-17 13:44:15 +08006091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6092
6093#if defined(MBEDTLS_USE_PSA_CRYPTO)
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6096 mbedtls_svc_key_id_t key,
6097 psa_algorithm_t alg,
6098 const unsigned char *raw_psk, size_t raw_psk_length,
6099 const unsigned char *seed, size_t seed_length,
6100 const unsigned char *label, size_t label_length,
6101 const unsigned char *other_secret,
6102 size_t other_secret_length,
6103 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006104{
6105 psa_status_t status;
6106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 status = psa_key_derivation_setup(derivation, alg);
6108 if (status != PSA_SUCCESS) {
6109 return status;
6110 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6113 status = psa_key_derivation_input_bytes(derivation,
6114 PSA_KEY_DERIVATION_INPUT_SEED,
6115 seed, seed_length);
6116 if (status != PSA_SUCCESS) {
6117 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006118 }
6119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (other_secret != NULL) {
6121 status = psa_key_derivation_input_bytes(derivation,
6122 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6123 other_secret, other_secret_length);
6124 if (status != PSA_SUCCESS) {
6125 return status;
6126 }
6127 }
6128
6129 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006130 status = psa_key_derivation_input_bytes(
6131 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 raw_psk, raw_psk_length);
6133 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006134 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006136 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (status != PSA_SUCCESS) {
6138 return status;
6139 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 status = psa_key_derivation_input_bytes(derivation,
6142 PSA_KEY_DERIVATION_INPUT_LABEL,
6143 label, label_length);
6144 if (status != PSA_SUCCESS) {
6145 return status;
6146 }
6147 } else {
6148 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006149 }
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 status = psa_key_derivation_set_capacity(derivation, capacity);
6152 if (status != PSA_SUCCESS) {
6153 return status;
6154 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006157}
6158
Andrzej Kurek57d10632022-10-24 10:32:01 -04006159#if defined(PSA_WANT_ALG_SHA_384) || \
6160 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006161MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006162static int tls_prf_generic(mbedtls_md_type_t md_type,
6163 const unsigned char *secret, size_t slen,
6164 const char *label,
6165 const unsigned char *random, size_t rlen,
6166 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006167{
6168 psa_status_t status;
6169 psa_algorithm_t alg;
6170 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6171 psa_key_derivation_operation_t derivation =
6172 PSA_KEY_DERIVATION_OPERATION_INIT;
6173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006177 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006179
6180 /* Normally a "secret" should be long enough to be impossible to
6181 * find by brute force, and in particular should not be empty. But
6182 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6183 * and for this use case it makes sense to have a 0-length "secret".
6184 * Since the key API doesn't allow importing a key of length 0,
6185 * keep master_key=0, which setup_psa_key_derivation() understands
6186 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6190 psa_set_key_algorithm(&key_attributes, alg);
6191 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6194 if (status != PSA_SUCCESS) {
6195 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6196 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006197 }
6198
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 status = setup_psa_key_derivation(&derivation,
6200 master_key, alg,
6201 NULL, 0,
6202 random, rlen,
6203 (unsigned char const *) label,
6204 (size_t) strlen(label),
6205 NULL, 0,
6206 dlen);
6207 if (status != PSA_SUCCESS) {
6208 psa_key_derivation_abort(&derivation);
6209 psa_destroy_key(master_key);
6210 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006211 }
6212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6214 if (status != PSA_SUCCESS) {
6215 psa_key_derivation_abort(&derivation);
6216 psa_destroy_key(master_key);
6217 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006218 }
6219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 status = psa_key_derivation_abort(&derivation);
6221 if (status != PSA_SUCCESS) {
6222 psa_destroy_key(master_key);
6223 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006224 }
6225
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 if (!mbedtls_svc_key_id_is_null(master_key)) {
6227 status = psa_destroy_key(master_key);
6228 }
6229 if (status != PSA_SUCCESS) {
6230 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6231 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006232
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006234}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006235#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006236#else /* MBEDTLS_USE_PSA_CRYPTO */
6237
Andrzej Kurek57d10632022-10-24 10:32:01 -04006238#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006239 (defined(MBEDTLS_MD_CAN_SHA256) || \
6240 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006241MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006242static int tls_prf_generic(mbedtls_md_type_t md_type,
6243 const unsigned char *secret, size_t slen,
6244 const char *label,
6245 const unsigned char *random, size_t rlen,
6246 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006247{
6248 size_t nb;
6249 size_t i, j, k, md_len;
6250 unsigned char *tmp;
6251 size_t tmp_len = 0;
6252 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6253 const mbedtls_md_info_t *md_info;
6254 mbedtls_md_context_t md_ctx;
6255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6260 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6261 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 tmp_len = md_len + strlen(label) + rlen;
6266 tmp = mbedtls_calloc(1, tmp_len);
6267 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006268 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6269 goto exit;
6270 }
6271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 nb = strlen(label);
6273 memcpy(tmp + md_len, label, nb);
6274 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006275 nb += rlen;
6276
6277 /*
6278 * Compute P_<hash>(secret, label + random)[0..dlen]
6279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006283
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6285 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 }
6288 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6289 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006290 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 }
6292 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6293 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006294 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 for (i = 0; i < dlen; i += md_len) {
6298 ret = mbedtls_md_hmac_reset(&md_ctx);
6299 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
6302 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6303 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 }
6306 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6307 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006308 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006310
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 ret = mbedtls_md_hmac_reset(&md_ctx);
6312 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 }
6315 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6316 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006317 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 }
6319 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6320 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006321 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006325
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006327 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006329 }
6330
6331exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 if (tmp != NULL) {
6335 mbedtls_platform_zeroize(tmp, tmp_len);
6336 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006339
Gilles Peskine449bd832023-01-11 14:50:10 +01006340 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006343}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006344#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006345#endif /* MBEDTLS_USE_PSA_CRYPTO */
6346
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006347#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006348MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006349static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6350 const char *label,
6351 const unsigned char *random, size_t rlen,
6352 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006353{
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6355 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006356}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006357#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006358
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006359#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006360MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006361static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6362 const char *label,
6363 const unsigned char *random, size_t rlen,
6364 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006365{
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6367 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006368}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006369#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006370
Jerry Yuf009d862022-02-17 14:01:37 +08006371/*
6372 * Set appropriate PRF function and other SSL / TLS1.2 functions
6373 *
6374 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006375 * - hash associated with the ciphersuite (only used by TLS 1.2)
6376 *
6377 * Outputs:
6378 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6379 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006381static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6382 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006383{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006384#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006386 handshake->tls_prf = tls_prf_sha384;
6387 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6388 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006390#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006391#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006392 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006393 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006394 handshake->tls_prf = tls_prf_sha256;
6395 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6396 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6397 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006398#else
Jerry Yuf009d862022-02-17 14:01:37 +08006399 {
Jerry Yuf009d862022-02-17 14:01:37 +08006400 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006401 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006403 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006404#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006405
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006407}
Jerry Yud6ab2352022-02-17 14:03:43 +08006408
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409/*
6410 * Compute master secret if needed
6411 *
6412 * Parameters:
6413 * [in/out] handshake
6414 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6415 * (PSA-PSK) ciphersuite_info, psk_opaque
6416 * [out] premaster (cleared)
6417 * [out] master
6418 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6419 * debug: conf->f_dbg, conf->p_dbg
6420 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006421 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006423MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006424static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6425 unsigned char *master,
6426 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427{
6428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6429
6430 /* cf. RFC 5246, Section 8.1:
6431 * "The master secret is always exactly 48 bytes in length." */
6432 size_t const master_secret_len = 48;
6433
6434#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6435 unsigned char session_hash[48];
6436#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6437
6438 /* The label for the KDF used for key expansion.
6439 * This is either "master secret" or "extended master secret"
6440 * depending on whether the Extended Master Secret extension
6441 * is used. */
6442 char const *lbl = "master secret";
6443
Przemek Stekielae4ed302022-04-05 17:15:55 +02006444 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006445 * - If the Extended Master Secret extension is not used,
6446 * this is ClientHello.Random + ServerHello.Random
6447 * (see Sect. 8.1 in RFC 5246).
6448 * - If the Extended Master Secret extension is used,
6449 * this is the transcript of the handshake so far.
6450 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006451 unsigned char const *seed = handshake->randbytes;
6452 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453
6454#if !defined(MBEDTLS_DEBUG_C) && \
6455 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6456 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458 ssl = NULL; /* make sure we don't use it except for those cases */
6459 (void) ssl;
6460#endif
6461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if (handshake->resume != 0) {
6463 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6464 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006465 }
6466
6467#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006470 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006471 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6472 if (ret != 0) {
6473 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6474 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6477 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006479#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006480
Przemek Stekiel99114f32022-04-22 11:20:09 +02006481#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006482 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484 /* Perform PSK-to-MS expansion in a single step. */
6485 psa_status_t status;
6486 psa_algorithm_t alg;
6487 mbedtls_svc_key_id_t psk;
6488 psa_key_derivation_operation_t derivation =
6489 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006490 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006491
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006497 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006499 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006501
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006502 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006506 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006507 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006508 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006509 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006510 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006511 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006512 other_secret_len = 48;
6513 other_secret = handshake->premaster + 2;
6514 break;
6515 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006516 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006517 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6518 other_secret = handshake->premaster + 2;
6519 break;
6520 default:
6521 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006522 }
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 status = setup_psa_key_derivation(&derivation, psk, alg,
6525 ssl->conf->psk, ssl->conf->psk_len,
6526 seed, seed_len,
6527 (unsigned char const *) lbl,
6528 (size_t) strlen(lbl),
6529 other_secret, other_secret_len,
6530 master_secret_len);
6531 if (status != PSA_SUCCESS) {
6532 psa_key_derivation_abort(&derivation);
6533 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534 }
6535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 status = psa_key_derivation_output_bytes(&derivation,
6537 master,
6538 master_secret_len);
6539 if (status != PSA_SUCCESS) {
6540 psa_key_derivation_abort(&derivation);
6541 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006542 }
6543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 status = psa_key_derivation_abort(&derivation);
6545 if (status != PSA_SUCCESS) {
6546 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6547 }
6548 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006549#endif
6550 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006551#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6553 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006554 psa_status_t status;
6555 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6556 psa_key_derivation_operation_t derivation =
6557 PSA_KEY_DERIVATION_OPERATION_INIT;
6558
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006560
6561 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 status = psa_key_derivation_setup(&derivation, alg);
6564 if (status != PSA_SUCCESS) {
6565 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006566 }
6567
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 status = psa_key_derivation_set_capacity(&derivation,
6569 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6570 if (status != PSA_SUCCESS) {
6571 psa_key_derivation_abort(&derivation);
6572 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006573 }
6574
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6576 &derivation);
6577 if (status != PSA_SUCCESS) {
6578 psa_key_derivation_abort(&derivation);
6579 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006580 }
6581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 status = psa_key_derivation_output_bytes(&derivation,
6583 handshake->premaster,
6584 handshake->pmslen);
6585 if (status != PSA_SUCCESS) {
6586 psa_key_derivation_abort(&derivation);
6587 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6588 }
6589
6590 status = psa_key_derivation_abort(&derivation);
6591 if (status != PSA_SUCCESS) {
6592 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006593 }
6594 }
6595#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6597 lbl, seed, seed_len,
6598 master,
6599 master_secret_len);
6600 if (ret != 0) {
6601 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6602 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006603 }
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6606 handshake->premaster,
6607 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 mbedtls_platform_zeroize(handshake->premaster,
6610 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006611 }
6612
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006614}
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006617{
6618 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6619 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6620 ssl->handshake->ciphersuite_info;
6621
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006623
6624 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006625 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006626 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 if (ret != 0) {
6628 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6629 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006630 }
6631
6632 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 ret = ssl_compute_master(ssl->handshake,
6634 ssl->session_negotiate->master,
6635 ssl);
6636 if (ret != 0) {
6637 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6638 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006639 }
6640
6641 /* Swap the client and server random values:
6642 * - MS derivation wanted client+server (RFC 5246 8.1)
6643 * - key derivation wants server+client (RFC 5246 6.3) */
6644 {
6645 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 memcpy(tmp, ssl->handshake->randbytes, 64);
6647 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6648 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6649 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006650 }
6651
6652 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6654 ssl->session_negotiate->ciphersuite,
6655 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006656#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006658#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 ssl->handshake->tls_prf,
6660 ssl->handshake->randbytes,
6661 ssl->tls_version,
6662 ssl->conf->endpoint,
6663 ssl);
6664 if (ret != 0) {
6665 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6666 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006667 }
6668
6669 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6671 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006672
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006674
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006676}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006679{
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006681#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006682 case MBEDTLS_SSL_HASH_SHA384:
6683 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6684 break;
6685#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006686#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006687 case MBEDTLS_SSL_HASH_SHA256:
6688 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6689 break;
6690#endif
6691 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006693 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006694#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6695 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006696 (void) ssl;
6697#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006699}
6700
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006701#if defined(MBEDTLS_USE_PSA_CRYPTO)
6702static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6703 const psa_hash_operation_t *hs_op,
6704 size_t buffer_size,
6705 unsigned char *hash,
6706 size_t *hlen)
6707{
6708 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006709 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006710
6711#if !defined(MBEDTLS_DEBUG_C)
6712 (void) ssl;
6713#endif
6714 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006715 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006716 if (status != PSA_SUCCESS) {
6717 goto exit;
6718 }
6719
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006720 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006721 if (status != PSA_SUCCESS) {
6722 goto exit;
6723 }
6724
6725 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6726 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6727
6728exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006729 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006730 return mbedtls_md_error_from_psa(status);
6731}
6732#else
6733static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6734 const mbedtls_md_context_t *hs_ctx,
6735 unsigned char *hash,
6736 size_t *hlen)
6737{
6738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006739 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006740
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006741 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006742
6743#if !defined(MBEDTLS_DEBUG_C)
6744 (void) ssl;
6745#endif
6746 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6747
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006748 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006749 if (ret != 0) {
6750 goto exit;
6751 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006752 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006753 if (ret != 0) {
6754 goto exit;
6755 }
6756
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006757 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758 if (ret != 0) {
6759 goto exit;
6760 }
6761
6762 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6763
6764 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6765 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6766
6767exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006768 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006769 return ret;
6770}
6771#endif /* MBEDTLS_USE_PSA_CRYPTO */
6772
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006773#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006774int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6775 unsigned char *hash,
6776 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006777{
6778#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006779 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6780 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006781#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006782 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6783 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006784#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006785}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006786#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006787
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006788#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006789int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6790 unsigned char *hash,
6791 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006792{
6793#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006794 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6795 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006796#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006797 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6798 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006799#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006800}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006801#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006802
Neil Armstrong80f6f322022-05-03 17:56:38 +02006803#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6804 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006805int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006806{
6807 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006809 const unsigned char *psk = NULL;
6810 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006814 /*
6815 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006816 * checked before calling this function.
6817 *
6818 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006819 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6822 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6823 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006824 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006825 }
6826
6827 /*
6828 * PMS = struct {
6829 * opaque other_secret<0..2^16-1>;
6830 * opaque psk<0..2^16-1>;
6831 * };
6832 * with "other_secret" depending on the particular key exchange
6833 */
6834#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6836 if (end - p < 2) {
6837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6838 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006841 p += 2;
6842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if (end < p || (size_t) (end - p) < psk_len) {
6844 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6845 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006850#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6851#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006853 /*
6854 * other_secret already set by the ClientKeyExchange message,
6855 * and is 48 bytes long
6856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 if (end - p < 2) {
6858 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6859 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006860
6861 *p++ = 0;
6862 *p++ = 48;
6863 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006865#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6866#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6869 size_t len;
6870
6871 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006873 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6875 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6876 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006877 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006879 p += 2 + len;
6880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6882 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006883#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006884#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6887 size_t zlen;
6888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006890 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6892 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6893 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006894 }
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006897 p += 2 + zlen;
6898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6900 MBEDTLS_DEBUG_ECDH_Z);
6901 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006902#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006903 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6905 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006906 }
6907
6908 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 if (end - p < 2) {
6910 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6911 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006914 p += 2;
6915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 if (end < p || (size_t) (end - p) < psk_len) {
6917 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6918 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006921 p += psk_len;
6922
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006923 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006926}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006927#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006928
6929#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006930MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006931static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006932
6933#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006934int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006935{
6936 /* If renegotiation is not enforced, retransmit until we would reach max
6937 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006939 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6940 unsigned char doublings = 1;
6941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006943 ++doublings;
6944 ratio >>= 1;
6945 }
6946
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 if (++ssl->renego_records_seen > doublings) {
6948 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6949 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006950 }
6951 }
6952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006954}
6955#endif
6956#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006957
Jerry Yud9526692022-02-17 14:23:47 +08006958/*
6959 * Handshake functions
6960 */
6961#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6962/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006963int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006964{
6965 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6966 ssl->handshake->ciphersuite_info;
6967
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6971 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006972 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006974 }
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6977 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006978}
6979
Gilles Peskine449bd832023-01-11 14:50:10 +01006980int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006981{
6982 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6983 ssl->handshake->ciphersuite_info;
6984
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6988 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006989 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006991 }
6992
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6994 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006995}
6996
6997#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6998/* Some certificate support -> implement write and parse */
6999
Gilles Peskine449bd832023-01-11 14:50:10 +01007000int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007001{
7002 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7003 size_t i, n;
7004 const mbedtls_x509_crt *crt;
7005 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7006 ssl->handshake->ciphersuite_info;
7007
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007009
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7011 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007012 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007014 }
7015
7016#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7018 if (ssl->handshake->client_auth == 0) {
7019 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007020 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007022 }
7023 }
7024#endif /* MBEDTLS_SSL_CLI_C */
7025#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7027 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007028 /* Should never happen because we shouldn't have picked the
7029 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007031 }
7032 }
7033#endif
7034
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007036
7037 /*
7038 * 0 . 0 handshake type
7039 * 1 . 3 handshake length
7040 * 4 . 6 length of all certs
7041 * 7 . 9 length of cert. 1
7042 * 10 . n-1 peer certificate
7043 * n . n+2 length of cert. 2
7044 * n+3 . ... upper level cert, etc.
7045 */
7046 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007050 n = crt->raw.len;
Waleed Elmelegy26e36982023-12-14 16:14:05 +00007051 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7053 " > %" MBEDTLS_PRINTF_SIZET,
Waleed Elmelegy26e36982023-12-14 16:14:05 +00007054 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007056 }
7057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7059 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7060 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007063 i += n; crt = crt->next;
7064 }
7065
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7067 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7068 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007069
7070 ssl->out_msglen = i;
7071 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7072 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7073
7074 ssl->state++;
7075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7077 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7078 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007079 }
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007084}
7085
7086#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7087
7088#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007089MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007090static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7091 unsigned char *crt_buf,
7092 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007093{
7094 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 if (peer_crt == NULL) {
7097 return -1;
7098 }
Jerry Yud9526692022-02-17 14:23:47 +08007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 if (peer_crt->raw.len != crt_buf_len) {
7101 return -1;
7102 }
Jerry Yud9526692022-02-17 14:23:47 +08007103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007105}
7106#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007107MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007108static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7109 unsigned char *crt_buf,
7110 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007111{
7112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7113 unsigned char const * const peer_cert_digest =
7114 ssl->session->peer_cert_digest;
7115 mbedtls_md_type_t const peer_cert_digest_type =
7116 ssl->session->peer_cert_digest_type;
7117 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007119 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7120 size_t digest_len;
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if (peer_cert_digest == NULL || digest_info == NULL) {
7123 return -1;
7124 }
Jerry Yud9526692022-02-17 14:23:47 +08007125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 digest_len = mbedtls_md_get_size(digest_info);
7127 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7128 return -1;
7129 }
Jerry Yud9526692022-02-17 14:23:47 +08007130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7132 if (ret != 0) {
7133 return -1;
7134 }
Jerry Yud9526692022-02-17 14:23:47 +08007135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007137}
7138#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7139#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7140
7141/*
7142 * Once the certificate message is read, parse it into a cert chain and
7143 * perform basic checks, but leave actual verification to the caller
7144 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007146static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7147 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007148{
7149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7150#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007152#endif
7153 size_t i, n;
7154 uint8_t alert;
7155
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7157 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7158 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7159 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7160 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007161 }
7162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7164 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7165 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7166 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007167 }
7168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7170 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7171 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7172 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7173 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007174 }
7175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007177
7178 /*
7179 * Same message structure as in mbedtls_ssl_write_certificate()
7180 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007181 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 if (ssl->in_msg[i] != 0 ||
7184 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7185 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7186 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7187 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7188 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007189 }
7190
7191 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7192 i += 3;
7193
7194 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007196 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (i + 3 > ssl->in_hslen) {
7198 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7199 mbedtls_ssl_send_alert_message(ssl,
7200 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7201 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7202 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007203 }
7204 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7205 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 if (ssl->in_msg[i] != 0) {
7207 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7208 mbedtls_ssl_send_alert_message(ssl,
7209 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7210 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7211 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007212 }
7213
7214 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007215 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007216 i += 3;
7217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 if (n < 128 || i + n > ssl->in_hslen) {
7219 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7220 mbedtls_ssl_send_alert_message(ssl,
7221 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7222 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7223 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007224 }
7225
7226 /* Check if we're handling the first CRT in the chain. */
7227#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007229 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007231 /* During client-side renegotiation, check that the server's
7232 * end-CRTs hasn't changed compared to the initial handshake,
7233 * mitigating the triple handshake attack. On success, reuse
7234 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7236 if (ssl_check_peer_crt_unchanged(ssl,
7237 &ssl->in_msg[i],
7238 n) != 0) {
7239 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7240 mbedtls_ssl_send_alert_message(ssl,
7241 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7242 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7243 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007244 }
7245
7246 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007248 }
7249#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7250
7251 /* Parse the next certificate in the chain. */
7252#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007254#else
7255 /* If we don't need to store the CRT chain permanently, parse
7256 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007258#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007260 case 0: /*ok*/
7261 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7262 /* Ignore certificate with an unknown algorithm: maybe a
7263 prior certificate was already trusted. */
7264 break;
7265
7266 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7267 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7268 goto crt_parse_der_failed;
7269
7270 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7271 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7272 goto crt_parse_der_failed;
7273
7274 default:
7275 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007276crt_parse_der_failed:
7277 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7278 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7279 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007280 }
7281
7282 i += n;
7283 }
7284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7286 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007287}
7288
7289#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007290MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007291static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007292{
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7294 return -1;
7295 }
Jerry Yud9526692022-02-17 14:23:47 +08007296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007298 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7299 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7301 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7302 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007303 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007305}
7306#endif /* MBEDTLS_SSL_SRV_C */
7307
7308/* Check if a certificate message is expected.
7309 * Return either
7310 * - SSL_CERTIFICATE_EXPECTED, or
7311 * - SSL_CERTIFICATE_SKIP
7312 * indicating whether a Certificate message is expected or not.
7313 */
7314#define SSL_CERTIFICATE_EXPECTED 0
7315#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007317static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7318 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007319{
7320 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7321 ssl->handshake->ciphersuite_info;
7322
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7324 return SSL_CERTIFICATE_SKIP;
7325 }
Jerry Yud9526692022-02-17 14:23:47 +08007326
7327#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7329 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7330 return SSL_CERTIFICATE_SKIP;
7331 }
Jerry Yud9526692022-02-17 14:23:47 +08007332
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007334 ssl->session_negotiate->verify_result =
7335 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007337 }
7338 }
7339#else
7340 ((void) authmode);
7341#endif /* MBEDTLS_SSL_SRV_C */
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007344}
7345
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007346MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007347static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7348 int authmode,
7349 mbedtls_x509_crt *chain,
7350 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007351{
7352 int ret = 0;
7353 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7354 ssl->handshake->ciphersuite_info;
7355 int have_ca_chain = 0;
7356
7357 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7358 void *p_vrfy;
7359
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7361 return 0;
7362 }
Jerry Yud9526692022-02-17 14:23:47 +08007363
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 if (ssl->f_vrfy != NULL) {
7365 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007366 f_vrfy = ssl->f_vrfy;
7367 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 } else {
7369 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007370 f_vrfy = ssl->conf->f_vrfy;
7371 p_vrfy = ssl->conf->p_vrfy;
7372 }
7373
7374 /*
7375 * Main check: verify certificate
7376 */
7377#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007379 ((void) rs_ctx);
7380 have_ca_chain = 1;
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007383 ret = mbedtls_x509_crt_verify_with_ca_cb(
7384 chain,
7385 ssl->conf->f_ca_cb,
7386 ssl->conf->p_ca_cb,
7387 ssl->conf->cert_profile,
7388 ssl->hostname,
7389 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 f_vrfy, p_vrfy);
7391 } else
Jerry Yud9526692022-02-17 14:23:47 +08007392#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7393 {
7394 mbedtls_x509_crt *ca_chain;
7395 mbedtls_x509_crl *ca_crl;
7396
7397#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007399 ca_chain = ssl->handshake->sni_ca_chain;
7400 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 } else
Jerry Yud9526692022-02-17 14:23:47 +08007402#endif
7403 {
7404 ca_chain = ssl->conf->ca_chain;
7405 ca_crl = ssl->conf->ca_crl;
7406 }
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 }
Jerry Yud9526692022-02-17 14:23:47 +08007411
7412 ret = mbedtls_x509_crt_verify_restartable(
7413 chain,
7414 ca_chain, ca_crl,
7415 ssl->conf->cert_profile,
7416 ssl->hostname,
7417 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007419 }
7420
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 if (ret != 0) {
7422 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007423 }
7424
7425#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7427 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7428 }
Jerry Yud9526692022-02-17 14:23:47 +08007429#endif
7430
7431 /*
7432 * Secondary checks: always done, but change 'ret' only if it was 0
7433 */
7434
Valerio Settiacd32c02023-06-29 18:06:29 +02007435#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007436 {
7437 const mbedtls_pk_context *pk = &chain->pk;
7438
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007439 /* If certificate uses an EC key, make sure the curve is OK.
7440 * This is a public key, so it can't be opaque, so can_do() is a good
7441 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007443 /* and in the unlikely case the above assumption no longer holds
7444 * we are making sure that pk_ec() here does not return a NULL
7445 */
Valerio Settid0405092023-05-24 13:16:40 +02007446 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7447 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7448 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007450 }
Valerio Setti97207782023-05-18 18:59:06 +02007451 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007452 ssl->session_negotiate->verify_result |=
7453 MBEDTLS_X509_BADCERT_BAD_KEY;
7454
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7456 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007457 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007459 }
Jerry Yud9526692022-02-17 14:23:47 +08007460 }
7461 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007462#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 if (mbedtls_ssl_check_cert_usage(chain,
7465 ciphersuite_info,
7466 !ssl->conf->endpoint,
7467 &ssl->session_negotiate->verify_result) != 0) {
7468 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7469 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007470 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 }
Jerry Yud9526692022-02-17 14:23:47 +08007472 }
7473
7474 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7475 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7476 * with details encoded in the verification flags. All other kinds
7477 * of error codes, including those from the user provided f_vrfy
7478 * functions, are treated as fatal and lead to a failure of
7479 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7481 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7482 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007483 ret = 0;
7484 }
7485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7487 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007488 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7489 }
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007492 uint8_t alert;
7493
7494 /* The certificate may have been rejected for several reasons.
7495 Pick one and send the corresponding alert. Which alert to send
7496 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007498 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007500 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007502 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007504 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007506 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007508 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007510 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007512 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007514 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007516 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007518 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 }
7520 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7521 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007522 }
7523
7524#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if (ssl->session_negotiate->verify_result != 0) {
7526 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7527 (unsigned int) ssl->session_negotiate->verify_result));
7528 } else {
7529 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007530 }
7531#endif /* MBEDTLS_DEBUG_C */
7532
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007534}
7535
7536#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007537MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007538static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7539 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007540{
7541 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7542 /* Remember digest of the peer's end-CRT. */
7543 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7545 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7546 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7547 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7548 mbedtls_ssl_send_alert_message(ssl,
7549 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7550 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007551
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007553 }
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 ret = mbedtls_md(mbedtls_md_info_from_type(
7556 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7557 start, len,
7558 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007559
7560 ssl->session_negotiate->peer_cert_digest_type =
7561 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7562 ssl->session_negotiate->peer_cert_digest_len =
7563 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007566}
7567
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007568MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007569static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7570 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007571{
7572 unsigned char *end = start + len;
7573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7574
7575 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7577 ret = mbedtls_pk_parse_subpubkey(&start, end,
7578 &ssl->handshake->peer_pubkey);
7579 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007580 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007582 }
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007585}
7586#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007589{
7590 int ret = 0;
7591 int crt_expected;
7592#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7593 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7594 ? ssl->handshake->sni_authmode
7595 : ssl->conf->authmode;
7596#else
7597 const int authmode = ssl->conf->authmode;
7598#endif
7599 void *rs_ctx = NULL;
7600 mbedtls_x509_crt *chain = NULL;
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7605 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007607 goto exit;
7608 }
7609
7610#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 if (ssl->handshake->ecrs_enabled &&
7612 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007613 chain = ssl->handshake->ecrs_peer_cert;
7614 ssl->handshake->ecrs_peer_cert = NULL;
7615 goto crt_verify;
7616 }
7617#endif
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007620 /* mbedtls_ssl_read_record may have sent an alert already. We
7621 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007623 goto exit;
7624 }
7625
7626#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007628 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007631 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 }
Jerry Yud9526692022-02-17 14:23:47 +08007633
7634 goto exit;
7635 }
7636#endif /* MBEDTLS_SSL_SRV_C */
7637
7638 /* Clear existing peer CRT structure in case we tried to
7639 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7643 if (chain == NULL) {
7644 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7645 sizeof(mbedtls_x509_crt)));
7646 mbedtls_ssl_send_alert_message(ssl,
7647 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7648 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007649
7650 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7651 goto exit;
7652 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007654
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 ret = ssl_parse_certificate_chain(ssl, chain);
7656 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007657 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 }
Jerry Yud9526692022-02-17 14:23:47 +08007659
7660#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007662 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 }
Jerry Yud9526692022-02-17 14:23:47 +08007664
7665crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007667 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 }
Jerry Yud9526692022-02-17 14:23:47 +08007669#endif
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 ret = ssl_parse_certificate_verify(ssl, authmode,
7672 chain, rs_ctx);
7673 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007674 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 }
Jerry Yud9526692022-02-17 14:23:47 +08007676
7677#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7678 {
7679 unsigned char *crt_start, *pk_start;
7680 size_t crt_len, pk_len;
7681
7682 /* We parse the CRT chain without copying, so
7683 * these pointers point into the input buffer,
7684 * and are hence still valid after freeing the
7685 * CRT chain. */
7686
7687 crt_start = chain->raw.p;
7688 crt_len = chain->raw.len;
7689
7690 pk_start = chain->pk_raw.p;
7691 pk_len = chain->pk_raw.len;
7692
7693 /* Free the CRT structures before computing
7694 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 mbedtls_x509_crt_free(chain);
7696 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007697 chain = NULL;
7698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7700 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007701 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 }
Jerry Yud9526692022-02-17 14:23:47 +08007703
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7705 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007706 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 }
Jerry Yud9526692022-02-17 14:23:47 +08007708 }
7709#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7710 /* Pass ownership to session structure. */
7711 ssl->session_negotiate->peer_cert = chain;
7712 chain = NULL;
7713#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007716
7717exit:
7718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007720 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 }
Jerry Yud9526692022-02-17 14:23:47 +08007722
7723#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007725 ssl->handshake->ecrs_peer_cert = chain;
7726 chain = NULL;
7727 }
7728#endif
7729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 if (chain != NULL) {
7731 mbedtls_x509_crt_free(chain);
7732 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007733 }
7734
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007736}
7737#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7738
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007739static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7740 unsigned char *padbuf, size_t hlen,
7741 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007742{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007743 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007744 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007745#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007746 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007747 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007748 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007749 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007750#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007751 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007752 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007753 mbedtls_md_context_t cloned_ctx;
7754 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007755#endif
7756
7757 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007759 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007763 ? "client finished"
7764 : "server finished";
7765
7766#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007767 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007768
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007769 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007771 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007772 }
7773
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007774 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007776 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007777 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007778 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007779#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007780 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007781
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007782 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007783 if (ret != 0) {
7784 goto exit;
7785 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007786 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007787 if (ret != 0) {
7788 goto exit;
7789 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007790
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007791 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007792 if (ret != 0) {
7793 goto exit;
7794 }
7795#endif /* MBEDTLS_USE_PSA_CRYPTO */
7796
7797 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7798
Jerry Yu615bd6f2022-02-17 14:25:15 +08007799 /*
7800 * TLSv1.2:
7801 * hash = PRF( master, finished_label,
7802 * Hash( handshake ) )[0.11]
7803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007805 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007806
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007808
Paul Elliottecb95be2023-08-11 16:41:04 +01007809 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007810
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007811 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007812
7813exit:
7814#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007815 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007816 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007817#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007818 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007819 return ret;
7820#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007821}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007822
7823#if defined(MBEDTLS_MD_CAN_SHA256)
7824static int ssl_calc_finished_tls_sha256(
7825 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7826{
7827 unsigned char padbuf[32];
7828 return ssl_calc_finished_tls_generic(ssl,
7829#if defined(MBEDTLS_USE_PSA_CRYPTO)
7830 &ssl->handshake->fin_sha256_psa,
7831#else
7832 &ssl->handshake->fin_sha256,
7833#endif
7834 padbuf, sizeof(padbuf),
7835 buf, from);
7836}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007837#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007838
Jerry Yub7ba49e2022-02-17 14:25:53 +08007839
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007840#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007841static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007843{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007844 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007845 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007846#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007847 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007848#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007849 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007850#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007851 padbuf, sizeof(padbuf),
7852 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007853}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007854#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007857{
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007859
7860 /*
7861 * Free our handshake params
7862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 mbedtls_ssl_handshake_free(ssl);
7864 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007865 ssl->handshake = NULL;
7866
7867 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007868 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl->transform) {
7871 mbedtls_ssl_transform_free(ssl->transform);
7872 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007873 }
7874 ssl->transform = ssl->transform_negotiate;
7875 ssl->transform_negotiate = NULL;
7876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007878}
7879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007881{
7882 int resume = ssl->handshake->resume;
7883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007885
7886#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007888 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7889 ssl->renego_records_seen = 0;
7890 }
7891#endif
7892
7893 /*
7894 * Free the previous session and switch in the current one
7895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007897#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7898 /* RFC 7366 3.1: keep the EtM state */
7899 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007901#endif
7902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 mbedtls_ssl_session_free(ssl->session);
7904 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007905 }
7906 ssl->session = ssl->session_negotiate;
7907 ssl->session_negotiate = NULL;
7908
7909 /*
7910 * Add cache entry
7911 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007913 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 resume == 0) {
7915 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7916 ssl->session->id,
7917 ssl->session->id_len,
7918 ssl->session) != 0) {
7919 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7920 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007921 }
7922
7923#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7925 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007926 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007928
7929 /* Keep last flight around in case we need to resend it:
7930 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7932 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007933#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007935
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007936 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007937
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007939}
7940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007942{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007943 int ret;
7944 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007947
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007949
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007950 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7951 if (ret != 0) {
7952 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7953 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007954
7955 /*
7956 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7957 * may define some other value. Currently (early 2016), no defined
7958 * ciphersuite does this (and this is unlikely to change as activity has
7959 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7960 */
7961 hash_len = 12;
7962
7963#if defined(MBEDTLS_SSL_RENEGOTIATION)
7964 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007966#endif
7967
7968 ssl->out_msglen = 4 + hash_len;
7969 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7970 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7971
7972 /*
7973 * In case of session resuming, invert the client and server
7974 * ChangeCipherSpec messages order.
7975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007979 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007981#endif
7982#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007988 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007990
7991 /*
7992 * Switch to our negotiated transform and session parameters for outbound
7993 * data.
7994 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007996
7997#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999 unsigned char i;
8000
8001 /* Remember current epoch settings for resending */
8002 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8004 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008005
8006 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008008
8009
8010 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 for (i = 2; i > 0; i--) {
8012 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008013 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 }
8015 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016
8017 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 if (i == 0) {
8019 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8020 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008023#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008025
8026 ssl->transform_out = ssl->transform_negotiate;
8027 ssl->session_out = ssl->session_negotiate;
8028
8029#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8031 mbedtls_ssl_send_flight_completed(ssl);
8032 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008033#endif
8034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8036 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8037 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008038 }
8039
8040#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8042 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8043 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8044 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008045 }
8046#endif
8047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008049
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008051}
8052
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008053#define SSL_MAX_HASH_LEN 12
8054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008056{
8057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8058 unsigned int hash_len = 12;
8059 unsigned char buf[SSL_MAX_HASH_LEN];
8060
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008062
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008063 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8064 if (ret != 0) {
8065 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8066 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008067
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8069 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008070 goto exit;
8071 }
8072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8074 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8075 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8076 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008077 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8078 goto exit;
8079 }
8080
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8082 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8083 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008084 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8085 goto exit;
8086 }
8087
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8089 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8090 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8091 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008092 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8093 goto exit;
8094 }
8095
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8097 buf, hash_len) != 0) {
8098 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8099 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8100 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008101 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8102 goto exit;
8103 }
8104
8105#if defined(MBEDTLS_SSL_RENEGOTIATION)
8106 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008108#endif
8109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008111#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008113 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008115#endif
8116#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008118 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008120#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008122 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008124
8125#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8127 mbedtls_ssl_recv_flight_completed(ssl);
8128 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008129#endif
8130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008132
8133exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 mbedtls_platform_zeroize(buf, hash_len);
8135 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008136}
8137
Jerry Yu392112c2022-02-17 14:34:10 +08008138#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8139/*
8140 * Helper to get TLS 1.2 PRF from ciphersuite
8141 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008143static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008144{
Jerry Yu392112c2022-02-17 14:34:10 +08008145 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008147#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8149 return tls_prf_sha384;
8150 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008151#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008152#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008153 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8155 return tls_prf_sha256;
8156 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008157 }
8158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008159#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8160 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008161 (void) ciphersuite_info;
8162#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008165}
8166#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008169{
8170 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008171#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 if (tls_prf == tls_prf_sha384) {
8173 return MBEDTLS_SSL_TLS_PRF_SHA384;
8174 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008175#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008176#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 if (tls_prf == tls_prf_sha256) {
8178 return MBEDTLS_SSL_TLS_PRF_SHA256;
8179 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008180#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008182}
8183
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008184/*
8185 * Populate a transform structure with session keys and all the other
8186 * necessary information.
8187 *
8188 * Parameters:
8189 * - [in/out]: transform: structure to populate
8190 * [in] must be just initialised with mbedtls_ssl_transform_init()
8191 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8192 * - [in] ciphersuite
8193 * - [in] master
8194 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008195 * - [in] tls_prf: pointer to PRF to use for key derivation
8196 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008197 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008198 * - [in] endpoint: client or server
8199 * - [in] ssl: used for:
8200 * - ssl->conf->{f,p}_export_keys
8201 * [in] optionally used for:
8202 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8203 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008204MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008205static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8206 int ciphersuite,
8207 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008208#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008210#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 ssl_tls_prf_t tls_prf,
8212 const unsigned char randbytes[64],
8213 mbedtls_ssl_protocol_version tls_version,
8214 unsigned endpoint,
8215 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008216{
8217 int ret = 0;
8218 unsigned char keyblk[256];
8219 unsigned char *key1;
8220 unsigned char *key2;
8221 unsigned char *mac_enc;
8222 unsigned char *mac_dec;
8223 size_t mac_key_len = 0;
8224 size_t iv_copy_len;
8225 size_t keylen;
8226 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008227 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008228#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008229 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008230 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008231#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232
8233#if defined(MBEDTLS_USE_PSA_CRYPTO)
8234 psa_key_type_t key_type;
8235 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8236 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008237 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008238 size_t key_bits;
8239 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8240#endif
8241
8242#if !defined(MBEDTLS_DEBUG_C) && \
8243 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245 ssl = NULL; /* make sure we don't use it except for these cases */
8246 (void) ssl;
8247 }
8248#endif
8249
8250 /*
8251 * Some data just needs copying into the structure
8252 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008253#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008254 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008255#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008256 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008257
8258#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008260#endif
8261
8262#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008264 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8265 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 }
8268#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8269
8270 /*
8271 * Get various info structures
8272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8274 if (ciphersuite_info == NULL) {
8275 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8276 ciphersuite));
8277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008278 }
8279
Neil Armstrongab555e02022-04-04 11:07:59 +02008280 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008281#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008283#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008285
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008287 transform->taglen =
8288 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008290
8291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008292 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 transform->taglen,
8294 &alg,
8295 &key_type,
8296 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008297 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008299 goto end;
8300 }
8301#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008302 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (cipher_info == NULL) {
8304 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8305 ciphersuite_info->cipher));
8306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008307 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008308#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008309
Neil Armstronge4512952022-03-08 09:08:22 +01008310#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008311 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008313 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 (unsigned) ciphersuite_info->mac));
8315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008316 }
8317#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008318 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 if (md_info == NULL) {
8320 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8321 (unsigned) ciphersuite_info->mac));
8322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008323 }
Neil Armstronge4512952022-03-08 09:08:22 +01008324#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325
8326#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8327 /* Copy own and peer's CID if the use of the CID
8328 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8330 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008331
8332 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8334 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8335 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336
8337 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8339 ssl->handshake->peer_cid_len);
8340 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8341 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008342 }
8343#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8344
8345 /*
8346 * Compute key block using the PRF
8347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8349 if (ret != 0) {
8350 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8351 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008352 }
8353
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8355 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8356 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8357 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8358 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008359
8360 /*
8361 * Determine the appropriate key, IV and MAC length.
8362 */
8363
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008364#if defined(MBEDTLS_USE_PSA_CRYPTO)
8365 keylen = PSA_BITS_TO_BYTES(key_bits);
8366#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008368#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008369
Valerio Settie5707042023-10-11 11:54:42 +02008370#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008372 size_t explicit_ivlen;
8373
8374 transform->maclen = 0;
8375 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008376
8377 /* All modes haves 96-bit IVs, but the length of the static parts vary
8378 * with mode and version:
8379 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8380 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8381 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8382 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8383 * sequence number).
8384 */
8385 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008386
8387 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008388#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008390#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8392 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008393#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008394
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008396 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008400
8401 /* Minimum length of encrypted record */
8402 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8403 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 } else
Valerio Settie5707042023-10-11 11:54:42 +02008405#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008408 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008410#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008412#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008413 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008414#endif /* MBEDTLS_USE_PSA_CRYPTO */
8415
8416#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008417 /* Get MAC length */
8418 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8419#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8422 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8423 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008424 goto end;
8425 }
8426
8427 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008429#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430 transform->maclen = mac_key_len;
8431
8432 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008433#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008435#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008436 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008437#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438
8439 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008443 /*
8444 * GenericBlockCipher:
8445 * 1. if EtM is in use: one block plus MAC
8446 * otherwise: * first multiple of blocklen greater than maclen
8447 * 2. IV
8448 */
8449#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008451 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 + block_size;
8453 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008454#endif
8455 {
8456 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 + block_size
8458 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459 }
8460
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 } else {
8464 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008465 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8466 goto end;
8467 }
8468 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008470#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8471 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8473 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474 }
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8477 (unsigned) keylen,
8478 (unsigned) transform->minlen,
8479 (unsigned) transform->ivlen,
8480 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481
8482 /*
8483 * Finally setup the cipher contexts, IVs and MAC secrets.
8484 */
8485#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008486 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008487 key1 = keyblk + mac_key_len * 2;
8488 key2 = keyblk + mac_key_len * 2 + keylen;
8489
8490 mac_enc = keyblk;
8491 mac_dec = keyblk + mac_key_len;
8492
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 iv_copy_len = (transform->fixed_ivlen) ?
8494 transform->fixed_ivlen : transform->ivlen;
8495 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8496 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8497 iv_copy_len);
8498 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008499#endif /* MBEDTLS_SSL_CLI_C */
8500#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008502 key1 = keyblk + mac_key_len * 2 + keylen;
8503 key2 = keyblk + mac_key_len * 2;
8504
8505 mac_enc = keyblk + mac_key_len;
8506 mac_dec = keyblk;
8507
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 iv_copy_len = (transform->fixed_ivlen) ?
8509 transform->fixed_ivlen : transform->ivlen;
8510 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8511 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8512 iv_copy_len);
8513 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008514#endif /* MBEDTLS_SSL_SRV_C */
8515 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008517 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8518 goto end;
8519 }
8520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 if (ssl != NULL && ssl->f_export_keys != NULL) {
8522 ssl->f_export_keys(ssl->p_export_keys,
8523 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8524 master, 48,
8525 randbytes + 32,
8526 randbytes,
8527 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008528 }
8529
8530#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008531 transform->psa_alg = alg;
8532
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8534 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8535 psa_set_key_algorithm(&attributes, alg);
8536 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 if ((status = psa_import_key(&attributes,
8539 key1,
8540 PSA_BITS_TO_BYTES(key_bits),
8541 &transform->psa_key_enc)) != PSA_SUCCESS) {
8542 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008543 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008545 goto end;
8546 }
8547
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008549
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 if ((status = psa_import_key(&attributes,
8551 key2,
8552 PSA_BITS_TO_BYTES(key_bits),
8553 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008554 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008556 goto end;
8557 }
8558 }
8559#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8561 cipher_info)) != 0) {
8562 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008563 goto end;
8564 }
8565
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8567 cipher_info)) != 0) {
8568 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008569 goto end;
8570 }
8571
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8573 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8574 MBEDTLS_ENCRYPT)) != 0) {
8575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8580 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8581 MBEDTLS_DECRYPT)) != 0) {
8582 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583 goto end;
8584 }
8585
8586#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8588 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8589 MBEDTLS_PADDING_NONE)) != 0) {
8590 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591 goto end;
8592 }
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8595 MBEDTLS_PADDING_NONE)) != 0) {
8596 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008597 goto end;
8598 }
8599 }
8600#endif /* MBEDTLS_CIPHER_MODE_CBC */
8601#endif /* MBEDTLS_USE_PSA_CRYPTO */
8602
Neil Armstrong29c0c042022-03-17 17:47:28 +01008603#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8604 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8605 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008607#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008609
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8611 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8612 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if ((status = psa_import_key(&attributes,
8615 mac_enc, mac_key_len,
8616 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008617 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008619 goto end;
8620 }
8621
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8623 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008624#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008626#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008628 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8630 PSA_KEY_USAGE_VERIFY_HASH);
8631 } else {
8632 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8633 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008634
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 if ((status = psa_import_key(&attributes,
8636 mac_dec, mac_key_len,
8637 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008638 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008640 goto end;
8641 }
8642#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8644 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008645 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 }
8647 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8648 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008649 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008651#endif /* MBEDTLS_USE_PSA_CRYPTO */
8652 }
8653#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8654
8655 ((void) mac_dec);
8656 ((void) mac_enc);
8657
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008658end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8660 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008661}
8662
Valerio Settia08b1a42022-11-17 15:10:02 +01008663#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8664 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008665int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 psa_pake_operation_t *pake_ctx,
8667 const unsigned char *buf,
8668 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008669{
8670 psa_status_t status;
8671 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008672 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008673 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8674 * At round two perform a single cycle
8675 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008677
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 for (; remaining_steps > 0; remaining_steps--) {
8679 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008680 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008682 /* Length is stored at the first byte */
8683 size_t length = buf[input_offset];
8684 input_offset += 1;
8685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008687 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8688 }
8689
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 status = psa_pake_input(pake_ctx, step,
8691 buf + input_offset, length);
8692 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008693 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008694 }
8695
8696 input_offset += length;
8697 }
8698 }
8699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008701 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008703
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008705}
8706
Valerio Setti6b3dab02022-11-17 17:14:54 +01008707int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 psa_pake_operation_t *pake_ctx,
8709 unsigned char *buf,
8710 size_t len, size_t *olen,
8711 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008712{
8713 psa_status_t status;
8714 size_t output_offset = 0;
8715 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008716 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008717 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8718 * At round two perform a single cycle
8719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008721
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 for (; remaining_steps > 0; remaining_steps--) {
8723 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8724 step <= PSA_PAKE_STEP_ZK_PROOF;
8725 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008726 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008727 * For each step, prepend 1 byte with the length of the data as
8728 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 status = psa_pake_output(pake_ctx, step,
8731 buf + output_offset + 1,
8732 len - output_offset - 1,
8733 &output_len);
8734 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008735 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008736 }
8737
Valerio Setti99d88c12022-11-22 16:03:43 +01008738 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008739
8740 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008741 }
8742 }
8743
8744 *olen = output_offset;
8745
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008747}
Valerio Settia08b1a42022-11-17 15:10:02 +01008748#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8749
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008751int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8752 unsigned char *hash, size_t *hashlen,
8753 unsigned char *data, size_t data_len,
8754 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755{
8756 psa_status_t status;
8757 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008758 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008761
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 if ((status = psa_hash_setup(&hash_operation,
8763 hash_alg)) != PSA_SUCCESS) {
8764 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008765 goto exit;
8766 }
8767
Gilles Peskine449bd832023-01-11 14:50:10 +01008768 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8769 64)) != PSA_SUCCESS) {
8770 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771 goto exit;
8772 }
8773
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 if ((status = psa_hash_update(&hash_operation,
8775 data, data_len)) != PSA_SUCCESS) {
8776 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008777 goto exit;
8778 }
8779
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8781 hashlen)) != PSA_SUCCESS) {
8782 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8783 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008784 }
8785
8786exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 if (status != PSA_SUCCESS) {
8788 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8789 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8790 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008793 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8794 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008800 }
8801 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803}
8804
8805#else
8806
Gilles Peskine449bd832023-01-11 14:50:10 +01008807int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8808 unsigned char *hash, size_t *hashlen,
8809 unsigned char *data, size_t data_len,
8810 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008811{
8812 int ret = 0;
8813 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8815 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008820
8821 /*
8822 * digitally-signed struct {
8823 * opaque client_random[32];
8824 * opaque server_random[32];
8825 * ServerDHParams params;
8826 * };
8827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8829 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008830 goto exit;
8831 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8833 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834 goto exit;
8835 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8837 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838 goto exit;
8839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8841 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008842 goto exit;
8843 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8845 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008846 goto exit;
8847 }
8848
8849exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008851
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 if (ret != 0) {
8853 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8854 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8855 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008856
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008858}
8859#endif /* MBEDTLS_USE_PSA_CRYPTO */
8860
Jerry Yud9d91da2022-02-17 14:57:06 +08008861#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8862
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008863/* Find the preferred hash for a given signature algorithm. */
8864unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 mbedtls_ssl_context *ssl,
8866 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008867{
Gabor Mezei078e8032022-04-27 21:17:56 +02008868 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008869 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008870
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8872 return MBEDTLS_SSL_HASH_NONE;
8873 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008876 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8878 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008879 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8881 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008882
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008883 mbedtls_md_type_t md_alg =
8884 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8885 if (md_alg == MBEDTLS_MD_NONE) {
8886 continue;
8887 }
8888
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008890#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008892 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008893 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008894
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8896 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8897 PSA_ALG_ECDSA(psa_hash_alg),
8898 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008899 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8903 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8904 PSA_ALG_RSA_PKCS1V15_SIGN(
8905 psa_hash_alg),
8906 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008907 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008908 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008909 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008910#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008911
Gilles Peskine449bd832023-01-11 14:50:10 +01008912 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008913 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008914 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008915
Gilles Peskine449bd832023-01-11 14:50:10 +01008916 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008917}
8918
8919#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8920
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921/* Serialization of TLS 1.2 sessions:
8922 *
8923 * struct {
8924 * uint64 start_time;
8925 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008926 * uint8 session_id_len; // at most 32
8927 * opaque session_id[32];
8928 * opaque master[48]; // fixed length in the standard
8929 * uint32 verify_result;
8930 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8931 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8932 * uint32 ticket_lifetime;
8933 * uint8 mfl_code; // up to 255 according to standard
8934 * uint8 encrypt_then_mac; // 0 or 1
8935 * } serialized_session_tls12;
8936 *
8937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008938static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8939 unsigned char *buf,
8940 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008941{
8942 unsigned char *p = buf;
8943 size_t used = 0;
8944
8945#if defined(MBEDTLS_HAVE_TIME)
8946 uint64_t start;
8947#endif
8948#if defined(MBEDTLS_X509_CRT_PARSE_C)
8949#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8950 size_t cert_len;
8951#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8952#endif /* MBEDTLS_X509_CRT_PARSE_C */
8953
8954 /*
8955 * Time
8956 */
8957#if defined(MBEDTLS_HAVE_TIME)
8958 used += 8;
8959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008961 start = (uint64_t) session->start;
8962
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008964 p += 8;
8965 }
8966#endif /* MBEDTLS_HAVE_TIME */
8967
8968 /*
8969 * Basic mandatory fields
8970 */
8971 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 + 1 /* id_len */
8973 + sizeof(session->id)
8974 + sizeof(session->master)
8975 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976
Gilles Peskine449bd832023-01-11 14:50:10 +01008977 if (used <= buf_len) {
8978 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008979 p += 2;
8980
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 *p++ = MBEDTLS_BYTE_0(session->id_len);
8982 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008983 p += 32;
8984
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008986 p += 48;
8987
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008989 p += 4;
8990 }
8991
8992 /*
8993 * Peer's end-entity certificate
8994 */
8995#if defined(MBEDTLS_X509_CRT_PARSE_C)
8996#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002
9003 used += 3 + cert_len;
9004
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 if (used <= buf_len) {
9006 *p++ = MBEDTLS_BYTE_2(cert_len);
9007 *p++ = MBEDTLS_BYTE_1(cert_len);
9008 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (session->peer_cert != NULL) {
9011 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009012 p += cert_len;
9013 }
9014 }
9015#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009016 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009017 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009019 *p++ = (unsigned char) session->peer_cert_digest_type;
9020 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 memcpy(p, session->peer_cert_digest,
9022 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023 p += session->peer_cert_digest_len;
9024 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009026 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009028 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9029 *p++ = 0;
9030 }
9031 }
9032#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9033#endif /* MBEDTLS_X509_CRT_PARSE_C */
9034
9035 /*
9036 * Session ticket if any, plus associated data
9037 */
9038#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9039 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9040
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 if (used <= buf_len) {
9042 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9043 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9044 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009045
Gilles Peskine449bd832023-01-11 14:50:10 +01009046 if (session->ticket != NULL) {
9047 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048 p += session->ticket_len;
9049 }
9050
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009052 p += 4;
9053 }
9054#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9055
9056 /*
9057 * Misc extension-related info
9058 */
9059#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9060 used += 1;
9061
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009063 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009064 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065#endif
9066
9067#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9068 used += 1;
9069
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 if (used <= buf_len) {
9071 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9072 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009073#endif
9074
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009076}
9077
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009078MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009079static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9080 const unsigned char *buf,
9081 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009082{
9083#if defined(MBEDTLS_HAVE_TIME)
9084 uint64_t start;
9085#endif
9086#if defined(MBEDTLS_X509_CRT_PARSE_C)
9087#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9088 size_t cert_len;
9089#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9090#endif /* MBEDTLS_X509_CRT_PARSE_C */
9091
9092 const unsigned char *p = buf;
9093 const unsigned char * const end = buf + len;
9094
9095 /*
9096 * Time
9097 */
9098#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 if (8 > (size_t) (end - p)) {
9100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9101 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009103 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009104 p += 8;
9105
9106 session->start = (time_t) start;
9107#endif /* MBEDTLS_HAVE_TIME */
9108
9109 /*
9110 * Basic mandatory fields
9111 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9113 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9114 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009115
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009116 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009117 p += 2;
9118
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009120 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009121 p += 32;
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009124 p += 48;
9125
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009126 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127 p += 4;
9128
9129 /* Immediately clear invalid pointer values that have been read, in case
9130 * we exit early before we replaced them with valid ones. */
9131#if defined(MBEDTLS_X509_CRT_PARSE_C)
9132#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9133 session->peer_cert = NULL;
9134#else
9135 session->peer_cert_digest = NULL;
9136#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9137#endif /* MBEDTLS_X509_CRT_PARSE_C */
9138#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9139 session->ticket = NULL;
9140#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9141
9142 /*
9143 * Peer certificate
9144 */
9145#if defined(MBEDTLS_X509_CRT_PARSE_C)
9146#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9147 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if (3 > (size_t) (end - p)) {
9149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9150 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009151
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009152 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153 p += 3;
9154
Gilles Peskine449bd832023-01-11 14:50:10 +01009155 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9157
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 if (cert_len > (size_t) (end - p)) {
9159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9160 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 if (session->peer_cert == NULL) {
9165 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9166 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009167
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009169
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9171 p, cert_len)) != 0) {
9172 mbedtls_x509_crt_free(session->peer_cert);
9173 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009174 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176 }
9177
9178 p += cert_len;
9179 }
9180#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9181 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 if (2 > (size_t) (end - p)) {
9183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9184 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185
9186 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9187 session->peer_cert_digest_len = (size_t) *p++;
9188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009190 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9192 if (md_info == NULL) {
9193 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9194 }
9195 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9196 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9197 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009198
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9200 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9201 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009202
9203 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 mbedtls_calloc(1, session->peer_cert_digest_len);
9205 if (session->peer_cert_digest == NULL) {
9206 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9207 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009208
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 memcpy(session->peer_cert_digest, p,
9210 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009211 p += session->peer_cert_digest_len;
9212 }
9213#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9214#endif /* MBEDTLS_X509_CRT_PARSE_C */
9215
9216 /*
9217 * Session ticket and associated data
9218 */
9219#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if (3 > (size_t) (end - p)) {
9221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9222 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009223
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009224 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009225 p += 3;
9226
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 if (session->ticket_len != 0) {
9228 if (session->ticket_len > (size_t) (end - p)) {
9229 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9230 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009231
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 session->ticket = mbedtls_calloc(1, session->ticket_len);
9233 if (session->ticket == NULL) {
9234 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9235 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009236
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009238 p += session->ticket_len;
9239 }
9240
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 if (4 > (size_t) (end - p)) {
9242 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9243 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009244
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009245 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009246 p += 4;
9247#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9248
9249 /*
9250 * Misc extension-related info
9251 */
9252#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 if (1 > (size_t) (end - p)) {
9254 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9255 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009256
9257 session->mfl_code = *p++;
9258#endif
9259
9260#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 if (1 > (size_t) (end - p)) {
9262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9263 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009264
9265 session->encrypt_then_mac = *p++;
9266#endif
9267
9268 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009269 if (p != end) {
9270 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9271 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009272
Gilles Peskine449bd832023-01-11 14:50:10 +01009273 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009274}
Jerry Yudc7bd172022-02-17 13:44:15 +08009275#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9276
XiaokangQian75d40ef2022-04-20 11:05:24 +00009277int mbedtls_ssl_validate_ciphersuite(
9278 const mbedtls_ssl_context *ssl,
9279 const mbedtls_ssl_ciphersuite_t *suite_info,
9280 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009281 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009282{
9283 (void) ssl;
9284
Gilles Peskine449bd832023-01-11 14:50:10 +01009285 if (suite_info == NULL) {
9286 return -1;
9287 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009288
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 if ((suite_info->min_tls_version > max_tls_version) ||
9290 (suite_info->max_tls_version < min_tls_version)) {
9291 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009292 }
9293
XiaokangQian060d8672022-04-21 09:24:56 +00009294#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009295#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009297 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9298 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009299#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009300 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9301 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009302#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009303 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009304 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009305 }
9306#endif
9307
9308 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9309#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9311 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9312 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009313 }
9314#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9315#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9316
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009318}
9319
Ronald Crone68ab4f2022-10-05 12:46:29 +02009320#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009321/*
9322 * Function for writing a signature algorithm extension.
9323 *
9324 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9325 * value (TLS 1.3 RFC8446):
9326 * enum {
9327 * ....
9328 * ecdsa_secp256r1_sha256( 0x0403 ),
9329 * ecdsa_secp384r1_sha384( 0x0503 ),
9330 * ecdsa_secp521r1_sha512( 0x0603 ),
9331 * ....
9332 * } SignatureScheme;
9333 *
9334 * struct {
9335 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9336 * } SignatureSchemeList;
9337 *
9338 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9339 * value (TLS 1.2 RFC5246):
9340 * enum {
9341 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9342 * sha512(6), (255)
9343 * } HashAlgorithm;
9344 *
9345 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9346 * SignatureAlgorithm;
9347 *
9348 * struct {
9349 * HashAlgorithm hash;
9350 * SignatureAlgorithm signature;
9351 * } SignatureAndHashAlgorithm;
9352 *
9353 * SignatureAndHashAlgorithm
9354 * supported_signature_algorithms<2..2^16-2>;
9355 *
9356 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9357 * generalization of the TLS 1.2 signature algorithm extension.
9358 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9359 * `SignatureScheme` field of TLS 1.3
9360 *
9361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009362int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9363 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009364{
9365 unsigned char *p = buf;
9366 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9367 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9368
9369 *out_len = 0;
9370
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009372
9373 /* Check if we have space for header and length field:
9374 * - extension_type (2 bytes)
9375 * - extension_data_length (2 bytes)
9376 * - supported_signature_algorithms_length (2 bytes)
9377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009379 p += 6;
9380
9381 /*
9382 * Write supported_signature_algorithms
9383 */
9384 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9386 if (sig_alg == NULL) {
9387 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9388 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009389
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9391 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9392 *sig_alg,
9393 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9394 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009395 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 }
9397 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9398 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009399 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9401 *sig_alg,
9402 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009403 }
9404
9405 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009406 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 if (supported_sig_alg_len == 0) {
9408 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9409 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009410 }
9411
Gilles Peskine449bd832023-01-11 14:50:10 +01009412 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9413 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9414 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009415
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009416 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009417
9418#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009420#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009421
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009423}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009424#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009425
XiaokangQian40a35232022-05-07 09:02:40 +00009426#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009427/*
9428 * mbedtls_ssl_parse_server_name_ext
9429 *
9430 * Structure of server_name extension:
9431 *
9432 * enum {
9433 * host_name(0), (255)
9434 * } NameType;
9435 * opaque HostName<1..2^16-1>;
9436 *
9437 * struct {
9438 * NameType name_type;
9439 * select (name_type) {
9440 * case host_name: HostName;
9441 * } name;
9442 * } ServerName;
9443 * struct {
9444 * ServerName server_name_list<1..2^16-1>
9445 * } ServerNameList;
9446 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009447MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009448int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9449 const unsigned char *buf,
9450 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009451{
9452 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9453 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009454 size_t server_name_list_len, hostname_len;
9455 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009456
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009458
Gilles Peskine449bd832023-01-11 14:50:10 +01009459 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9460 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009461 p += 2;
9462
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009464 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 while (p < server_name_list_end) {
9466 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9467 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9469 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009470
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009472 /* sni_name is intended to be used only during the parsing of the
9473 * ClientHello message (it is reset to NULL before the end of
9474 * the message parsing). Thus it is ok to just point to the
9475 * reception buffer and not make a copy of it.
9476 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009477 ssl->handshake->sni_name = p + 3;
9478 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 if (ssl->conf->f_sni == NULL) {
9480 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009481 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009482 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9483 ssl, p + 3, hostname_len);
9484 if (ret != 0) {
9485 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9486 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9487 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9488 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9489 }
9490 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009491 }
9492
9493 p += hostname_len + 3;
9494 }
9495
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009497}
9498#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9499
XiaokangQianacb39922022-06-17 10:18:48 +00009500#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009501MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009502int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9503 const unsigned char *buf,
9504 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009505{
9506 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009507 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009508 const unsigned char *protocol_name_list;
9509 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009510 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009511
9512 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 if (ssl->conf->alpn_list == NULL) {
9514 return 0;
9515 }
XiaokangQianacb39922022-06-17 10:18:48 +00009516
9517 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009518 * RFC7301, section 3.1
9519 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009520 *
XiaokangQianc7403452022-06-23 03:24:12 +00009521 * struct {
9522 * ProtocolName protocol_name_list<2..2^16-1>
9523 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009524 */
9525
XiaokangQianc7403452022-06-23 03:24:12 +00009526 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009527 * protocol_name_list_len 2 bytes
9528 * protocol_name_len 1 bytes
9529 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009534 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009536 protocol_name_list = p;
9537 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009538
9539 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009541 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9543 protocol_name_len);
9544 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009545 MBEDTLS_SSL_PEND_FATAL_ALERT(
9546 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9548 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009549 }
9550
9551 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009552 }
9553
9554 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9556 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009557 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009559 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 if (protocol_name_len == alpn_len &&
9561 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009562 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009563 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009564 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009565
9566 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009567 }
9568 }
9569
XiaokangQian95d5f542022-06-24 02:29:26 +00009570 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009571 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9573 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9574 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009575}
9576
Gilles Peskine449bd832023-01-11 14:50:10 +01009577int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9578 unsigned char *buf,
9579 unsigned char *end,
9580 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009581{
9582 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009583 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009584 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009585
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 if (ssl->alpn_chosen == NULL) {
9587 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009588 }
9589
Gilles Peskine449bd832023-01-11 14:50:10 +01009590 protocol_name_len = strlen(ssl->alpn_chosen);
9591 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009592
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009594 /*
9595 * 0 . 1 ext identifier
9596 * 2 . 3 ext length
9597 * 4 . 5 protocol list length
9598 * 6 . 6 protocol name length
9599 * 7 . 7+n protocol name
9600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009602
XiaokangQian95d5f542022-06-24 02:29:26 +00009603 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009604
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9606 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009607 /* Note: the length of the chosen protocol has been checked to be less
9608 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009611
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009613
9614#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009616#endif
9617
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009619}
9620#endif /* MBEDTLS_SSL_ALPN */
9621
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009622#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009623 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009624 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009625 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009626int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9627 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009628{
9629 /* Initialize to suppress unnecessary compiler warning */
9630 size_t hostname_len = 0;
9631
9632 /* Check if new hostname is valid before
9633 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009634 if (hostname != NULL) {
9635 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009636
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9639 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009640 }
9641
9642 /* Now it's clear that we will overwrite the old hostname,
9643 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009644 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009645 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009647 }
9648
9649 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009650 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009651 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009652 } else {
9653 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9654 if (session->hostname == NULL) {
9655 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9656 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009657
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009659 }
9660
Gilles Peskine449bd832023-01-11 14:50:10 +01009661 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009662}
Xiaokang Qian03409292022-10-12 02:49:52 +00009663#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9664 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009665 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009666 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009668#endif /* MBEDTLS_SSL_TLS_C */