blob: b163e93c2582a6e5bc4486bffde594fe291c9f64 [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) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500309 return -1;
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;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * select ( endpoint ) {
2459 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002460 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * };
2462 * } serialized_session_tls13;
2463 *
2464 */
2465#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002467static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2468 unsigned char *buf,
2469 size_t buf_len,
2470 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002471{
2472 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002473#if defined(MBEDTLS_SSL_CLI_C) && \
2474 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 size_t hostname_len = (session->hostname == NULL) ?
2476 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002477#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002478 size_t needed = 1 /* endpoint */
2479 + 2 /* ciphersuite */
2480 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002481 + 1 /* ticket_flags */
2482 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002483 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2486 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2487 }
Jerry Yu34191072022-08-18 10:32:09 +08002488 needed += session->resumption_key_len; /* resumption_key */
2489
Jerry Yu02e3a072022-12-12 15:13:20 +08002490#if defined(MBEDTLS_SSL_EARLY_DATA)
2491 needed += 4; /* max_early_data_size */
2492#endif
2493
Jerry Yu438ddd82022-07-07 06:55:50 +00002494#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002495 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002496#endif
2497
2498#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002500#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002501 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002503#endif
2504
Jerry Yu438ddd82022-07-07 06:55:50 +00002505 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002506 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002507
2508 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->ticket_len > SIZE_MAX - needed) {
2510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2511 }
Jerry Yu34191072022-08-18 10:32:09 +08002512
Jerry Yue28d9742022-08-18 15:44:03 +08002513 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002514 }
2515#endif /* MBEDTLS_SSL_CLI_C */
2516
Jerry Yue36fdd62022-08-17 21:31:36 +08002517 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (needed > buf_len) {
2519 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2520 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002521
2522 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2524 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002525 p[7] = session->ticket_flags;
2526
2527 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002528 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002531 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002532
Jerry Yu02e3a072022-12-12 15:13:20 +08002533#if defined(MBEDTLS_SSL_EARLY_DATA)
2534 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2535 p += 4;
2536#endif
2537
Jerry Yu438ddd82022-07-07 06:55:50 +00002538#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002540 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002541 p += 8;
2542 }
2543#endif /* MBEDTLS_HAVE_TIME */
2544
2545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002547#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 p += hostname_len;
2554 }
2555#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2556
Jerry Yu438ddd82022-07-07 06:55:50 +00002557#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002558 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += 8;
2560#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 4;
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (session->ticket != NULL && session->ticket_len > 0) {
2568 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += session->ticket_len;
2570 }
2571 }
2572#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002574}
2575
2576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2578 const unsigned char *buf,
2579 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002580{
2581 const unsigned char *p = buf;
2582 const unsigned char *end = buf + len;
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (end - p < 9) {
2585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2586 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002587 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2589 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->ticket_flags = p[7];
2591
2592 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002593 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002594 p += 9;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < session->resumption_key_len) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2602 }
2603 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002604 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002605
Jerry Yu02e3a072022-12-12 15:13:20 +08002606#if defined(MBEDTLS_SSL_EARLY_DATA)
2607 if (end - p < 4) {
2608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2609 }
2610 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2611 p += 4;
2612#endif
2613
Jerry Yu438ddd82022-07-07 06:55:50 +00002614#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2616 if (end - p < 8) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002619 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002620 p += 8;
2621 }
2622#endif /* MBEDTLS_HAVE_TIME */
2623
2624#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002626#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002628 size_t hostname_len;
2629 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (end - p < 2) {
2631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2632 }
2633 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002634 p += 2;
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (end - p < (long int) hostname_len) {
2637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2638 }
2639 if (hostname_len > 0) {
2640 session->hostname = mbedtls_calloc(1, hostname_len);
2641 if (session->hostname == NULL) {
2642 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2643 }
2644 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002645 p += hostname_len;
2646 }
2647#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2648 MBEDTLS_SSL_SESSION_TICKETS */
2649
Jerry Yu438ddd82022-07-07 06:55:50 +00002650#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < 8) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
Jerry Yu342a5552023-11-10 14:23:39 +08002654 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002655 p += 8;
2656#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (end - p < 4) {
2658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2659 }
2660 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002661 p += 4;
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < 2) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002667 p += 2;
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (end - p < (long int) session->ticket_len) {
2670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2671 }
2672 if (session->ticket_len > 0) {
2673 session->ticket = mbedtls_calloc(1, session->ticket_len);
2674 if (session->ticket == NULL) {
2675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2676 }
2677 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002678 p += session->ticket_len;
2679 }
2680 }
2681#endif /* MBEDTLS_SSL_CLI_C */
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002684
2685}
2686#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002688static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2689 unsigned char *buf,
2690 size_t buf_len,
2691 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002692{
2693 ((void) session);
2694 ((void) buf);
2695 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002696 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002698}
Jerry Yu438ddd82022-07-07 06:55:50 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2701 unsigned char *buf,
2702 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002703{
2704 ((void) session);
2705 ((void) buf);
2706 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002708}
2709#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002710#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2713 size_t taglen,
2714 psa_algorithm_t *alg,
2715 psa_key_type_t *key_type,
2716 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002717{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002718#if !defined(MBEDTLS_SSL_HAVE_CCM)
2719 (void) taglen;
2720#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002722#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002723 case MBEDTLS_CIPHER_AES_128_CBC:
2724 *alg = PSA_ALG_CBC_NO_PADDING;
2725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 128;
2727 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002728#endif
2729#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002732 *key_type = PSA_KEY_TYPE_AES;
2733 *key_size = 128;
2734 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002735#endif
2736#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002737 case MBEDTLS_CIPHER_AES_128_GCM:
2738 *alg = PSA_ALG_GCM;
2739 *key_type = PSA_KEY_TYPE_AES;
2740 *key_size = 128;
2741 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002742#endif
2743#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002744 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002746 *key_type = PSA_KEY_TYPE_AES;
2747 *key_size = 192;
2748 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002749#endif
2750#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 case MBEDTLS_CIPHER_AES_192_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 192;
2755 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002756#endif
2757#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002758 case MBEDTLS_CIPHER_AES_256_CBC:
2759 *alg = PSA_ALG_CBC_NO_PADDING;
2760 *key_type = PSA_KEY_TYPE_AES;
2761 *key_size = 256;
2762 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002763#endif
2764#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002765 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002767 *key_type = PSA_KEY_TYPE_AES;
2768 *key_size = 256;
2769 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002770#endif
2771#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002772 case MBEDTLS_CIPHER_AES_256_GCM:
2773 *alg = PSA_ALG_GCM;
2774 *key_type = PSA_KEY_TYPE_AES;
2775 *key_size = 256;
2776 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002777#endif
2778#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002779 case MBEDTLS_CIPHER_ARIA_128_CBC:
2780 *alg = PSA_ALG_CBC_NO_PADDING;
2781 *key_type = PSA_KEY_TYPE_ARIA;
2782 *key_size = 128;
2783 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002784#endif
2785#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002786 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 128;
2790 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002791#endif
2792#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002793 case MBEDTLS_CIPHER_ARIA_128_GCM:
2794 *alg = PSA_ALG_GCM;
2795 *key_type = PSA_KEY_TYPE_ARIA;
2796 *key_size = 128;
2797 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002798#endif
2799#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002802 *key_type = PSA_KEY_TYPE_ARIA;
2803 *key_size = 192;
2804 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002805#endif
2806#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002807 case MBEDTLS_CIPHER_ARIA_192_GCM:
2808 *alg = PSA_ALG_GCM;
2809 *key_type = PSA_KEY_TYPE_ARIA;
2810 *key_size = 192;
2811 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002812#endif
2813#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002814 case MBEDTLS_CIPHER_ARIA_256_CBC:
2815 *alg = PSA_ALG_CBC_NO_PADDING;
2816 *key_type = PSA_KEY_TYPE_ARIA;
2817 *key_size = 256;
2818 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002819#endif
2820#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002821 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002823 *key_type = PSA_KEY_TYPE_ARIA;
2824 *key_size = 256;
2825 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002826#endif
2827#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 case MBEDTLS_CIPHER_ARIA_256_GCM:
2829 *alg = PSA_ALG_GCM;
2830 *key_type = PSA_KEY_TYPE_ARIA;
2831 *key_size = 256;
2832 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002833#endif
2834#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002835 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2836 *alg = PSA_ALG_CBC_NO_PADDING;
2837 *key_type = PSA_KEY_TYPE_CAMELLIA;
2838 *key_size = 128;
2839 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002840#endif
2841#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002842 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002844 *key_type = PSA_KEY_TYPE_CAMELLIA;
2845 *key_size = 128;
2846 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002847#endif
2848#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002849 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2850 *alg = PSA_ALG_GCM;
2851 *key_type = PSA_KEY_TYPE_CAMELLIA;
2852 *key_size = 128;
2853 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002854#endif
2855#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002856 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002858 *key_type = PSA_KEY_TYPE_CAMELLIA;
2859 *key_size = 192;
2860 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002861#endif
2862#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002863 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2864 *alg = PSA_ALG_GCM;
2865 *key_type = PSA_KEY_TYPE_CAMELLIA;
2866 *key_size = 192;
2867 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002868#endif
2869#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002870 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2871 *alg = PSA_ALG_CBC_NO_PADDING;
2872 *key_type = PSA_KEY_TYPE_CAMELLIA;
2873 *key_size = 256;
2874 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002875#endif
2876#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002877 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002879 *key_type = PSA_KEY_TYPE_CAMELLIA;
2880 *key_size = 256;
2881 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002882#endif
2883#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002884 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2885 *alg = PSA_ALG_GCM;
2886 *key_type = PSA_KEY_TYPE_CAMELLIA;
2887 *key_size = 256;
2888 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002889#endif
2890#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002891 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2892 *alg = PSA_ALG_CHACHA20_POLY1305;
2893 *key_type = PSA_KEY_TYPE_CHACHA20;
2894 *key_size = 256;
2895 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002896#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002897 case MBEDTLS_CIPHER_NULL:
2898 *alg = MBEDTLS_SSL_NULL_CIPHER;
2899 *key_type = 0;
2900 *key_size = 0;
2901 break;
2902 default:
2903 return PSA_ERROR_NOT_SUPPORTED;
2904 }
2905
2906 return PSA_SUCCESS;
2907}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002908#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002909
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002910#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002911int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2912 const unsigned char *dhm_P, size_t P_len,
2913 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002914{
Janos Follath865b3eb2019-12-16 11:46:15 +00002915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 mbedtls_mpi_free(&conf->dhm_P);
2918 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2921 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2922 mbedtls_mpi_free(&conf->dhm_P);
2923 mbedtls_mpi_free(&conf->dhm_G);
2924 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002925 }
2926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002928}
Paul Bakker5121ce52009-01-03 21:22:43 +00002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002931{
Janos Follath865b3eb2019-12-16 11:46:15 +00002932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 mbedtls_mpi_free(&conf->dhm_P);
2935 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2938 &conf->dhm_P)) != 0 ||
2939 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2940 &conf->dhm_G)) != 0) {
2941 mbedtls_mpi_free(&conf->dhm_P);
2942 mbedtls_mpi_free(&conf->dhm_G);
2943 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002944 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002947}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002948#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002949
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002950#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2951/*
2952 * Set the minimum length for Diffie-Hellman parameters
2953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2955 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002956{
2957 conf->dhm_min_bitlen = bitlen;
2958}
2959#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2960
Ronald Crone68ab4f2022-10-05 12:46:29 +02002961#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002962#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002963/*
2964 * Set allowed/preferred hashes for handshake signatures
2965 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002966void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2967 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002968{
2969 conf->sig_hashes = hashes;
2970}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002971#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002972
Jerry Yuf017ee42022-01-12 15:49:48 +08002973/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002974void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2975 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002976{
Jerry Yuf017ee42022-01-12 15:49:48 +08002977#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2978 conf->sig_hashes = NULL;
2979#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2980 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002981}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002982#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002983
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002984#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002985#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002986/*
2987 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002988 *
2989 * mbedtls_ssl_setup() takes the provided list
2990 * and translates it to a list of IANA TLS group identifiers,
2991 * stored in ssl->handshake->group_list.
2992 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002993 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002994void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2995 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002996{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002997 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002998 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002999}
Brett Warrene0edc842021-08-17 09:53:13 +01003000#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003001#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003002
Brett Warrene0edc842021-08-17 09:53:13 +01003003/*
3004 * Set the allowed groups
3005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003006void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3007 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003008{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003009#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003010 conf->curve_list = NULL;
3011#endif
3012 conf->group_list = group_list;
3013}
3014
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003015#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003016int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003017{
Hanno Becker947194e2017-04-07 13:25:49 +01003018 /* Initialize to suppress unnecessary compiler warning */
3019 size_t hostname_len = 0;
3020
3021 /* Check if new hostname is valid before
3022 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if (hostname != NULL) {
3024 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3027 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3028 }
Hanno Becker947194e2017-04-07 13:25:49 +01003029 }
3030
3031 /* Now it's clear that we will overwrite the old hostname,
3032 * so we can free it safely */
3033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003035 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003036 }
3037
3038 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003041 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 } else {
3043 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3044 if (ssl->hostname == NULL) {
3045 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3046 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003049
Hanno Becker947194e2017-04-07 13:25:49 +01003050 ssl->hostname[hostname_len] = '\0';
3051 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003054}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003055#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003056
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003057#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003058void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3059 int (*f_sni)(void *, mbedtls_ssl_context *,
3060 const unsigned char *, size_t),
3061 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003062{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003063 conf->f_sni = f_sni;
3064 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003065}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003069int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003070{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003071 size_t cur_len, tot_len;
3072 const char **p;
3073
3074 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003075 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3076 * MUST NOT be truncated."
3077 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003078 */
3079 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 for (p = protos; *p != NULL; p++) {
3081 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003082 tot_len += cur_len;
3083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 if ((cur_len == 0) ||
3085 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3086 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3088 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003089 }
3090
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003091 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003097{
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003099}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003101
Johan Pascalb62bb512015-12-03 21:56:45 +01003102#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003103void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3104 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003105{
3106 conf->dtls_srtp_mki_support = support_mki_value;
3107}
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3110 unsigned char *mki_value,
3111 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003112{
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003115 }
Ron Eldor591f1622018-01-22 12:30:04 +02003116
Gilles Peskine449bd832023-01-11 14:50:10 +01003117 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3118 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003119 }
Ron Eldor591f1622018-01-22 12:30:04 +02003120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003122 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003124}
3125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3127 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003128{
Johan Pascal253d0262020-09-22 13:04:45 +02003129 const mbedtls_ssl_srtp_profile *p;
3130 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003131
Johan Pascal253d0262020-09-22 13:04:45 +02003132 /* check the profiles list: all entry must be valid,
3133 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3135 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3136 p++) {
3137 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003138 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003140 /* unsupported value, stop parsing and set the size to an error value */
3141 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003142 }
3143 }
3144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3146 conf->dtls_srtp_profile_list = NULL;
3147 conf->dtls_srtp_profile_list_len = 0;
3148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003149 }
3150
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003151 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003152 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003153
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003155}
3156
Gilles Peskine449bd832023-01-11 14:50:10 +01003157void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3158 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003159{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003160 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3161 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003163 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003165 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3167 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003168 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003169}
Johan Pascalb62bb512015-12-03 21:56:45 +01003170#endif /* MBEDTLS_SSL_DTLS_SRTP */
3171
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303172#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003174{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003175 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003176}
3177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003179{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003180 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003181}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303182#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003183
Janos Follath088ce432017-04-10 12:42:31 +01003184#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003185void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3186 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003187{
3188 conf->cert_req_ca_list = cert_req_ca_list;
3189}
3190#endif
3191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003193void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003194{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003195 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003196}
3197#endif
3198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003200void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003201{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003202 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003203}
3204#endif
3205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003207int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003208{
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3210 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003212 }
3213
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003214 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003215
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003217}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003221{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003222 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003223}
3224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003226void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003227{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003228 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003229}
3230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003232{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003233 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003234}
3235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3237 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003238{
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003240}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003244#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003245void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003246{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003247 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003248}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003249#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003250
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003251#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003252
Jerry Yud0766ec2022-09-22 10:46:57 +08003253#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003254void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3255 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003256{
Jerry Yud0766ec2022-09-22 10:46:57 +08003257 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003258}
3259#endif
3260
Gilles Peskine449bd832023-01-11 14:50:10 +01003261void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3262 mbedtls_ssl_ticket_write_t *f_ticket_write,
3263 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3264 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003265{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003266 conf->f_ticket_write = f_ticket_write;
3267 conf->f_ticket_parse = f_ticket_parse;
3268 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003269}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003270#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003272
Gilles Peskine449bd832023-01-11 14:50:10 +01003273void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3274 mbedtls_ssl_export_keys_t *f_export_keys,
3275 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003276{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003277 ssl->f_export_keys = f_export_keys;
3278 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003279}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003280
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003281#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003282void mbedtls_ssl_conf_async_private_cb(
3283 mbedtls_ssl_config *conf,
3284 mbedtls_ssl_async_sign_t *f_async_sign,
3285 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3286 mbedtls_ssl_async_resume_t *f_async_resume,
3287 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003289{
3290 conf->f_async_sign_start = f_async_sign;
3291 conf->f_async_decrypt_start = f_async_decrypt;
3292 conf->f_async_resume = f_async_resume;
3293 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003294 conf->p_async_config_data = async_config_data;
3295}
3296
Gilles Peskine449bd832023-01-11 14:50:10 +01003297void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003298{
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003300}
3301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003303{
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 if (ssl->handshake == NULL) {
3305 return NULL;
3306 } else {
3307 return ssl->handshake->user_async_ctx;
3308 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003309}
3310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3312 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003313{
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003315 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003317}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003318#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003319
Paul Bakker5121ce52009-01-03 21:22:43 +00003320/*
3321 * SSL get accessors
3322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003323uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003324{
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 if (ssl->session != NULL) {
3326 return ssl->session->verify_result;
3327 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003328
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl->session_negotiate != NULL) {
3330 return ssl->session_negotiate->verify_result;
3331 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003334}
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003337{
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 if (ssl == NULL || ssl->session == NULL) {
3339 return 0;
3340 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003341
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003343}
3344
Gilles Peskine449bd832023-01-11 14:50:10 +01003345const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003346{
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 if (ssl == NULL || ssl->session == NULL) {
3348 return NULL;
3349 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003352}
3353
Gilles Peskine449bd832023-01-11 14:50:10 +01003354const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003355{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3358 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003359 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003361 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003363 }
3364 }
3365#endif
3366
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003368 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003370 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003372 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003374 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003375}
3376
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003377#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003378size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003379{
David Horstmann95d516f2021-05-04 18:36:56 +01003380 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003381 size_t read_mfl;
3382
Jerry Yuddda0502022-12-01 19:43:12 +08003383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003384 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3386 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3387 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003388 }
Jerry Yuddda0502022-12-01 19:43:12 +08003389#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003390
3391 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 if (ssl->session_out != NULL) {
3393 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3394 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003395 max_len = read_mfl;
3396 }
3397 }
3398
Jerry Yuddda0502022-12-01 19:43:12 +08003399 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 if (ssl->session_negotiate != NULL) {
3401 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3402 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003403 max_len = read_mfl;
3404 }
3405 }
3406
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003408}
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003411{
3412 size_t max_len;
3413
3414 /*
3415 * Assume mfl_code is correct since it was checked when set
3416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003418
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003419 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (ssl->session_out != NULL &&
3421 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3422 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003423 }
3424
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003425 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 if (ssl->session_negotiate != NULL &&
3427 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3428 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003429 }
3430
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003432}
3433#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3434
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003436size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003437{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003438 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3440 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3441 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3442 return 0;
3443 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3446 return ssl->mtu;
3447 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 if (ssl->mtu == 0) {
3450 return ssl->handshake->mtu;
3451 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 return ssl->mtu < ssl->handshake->mtu ?
3454 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003455}
3456#endif /* MBEDTLS_SSL_PROTO_DTLS */
3457
Gilles Peskine449bd832023-01-11 14:50:10 +01003458int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003459{
3460 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3461
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003462#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3463 !defined(MBEDTLS_SSL_PROTO_DTLS)
3464 (void) ssl;
3465#endif
3466
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003467#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003469
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003471 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003472 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003473#endif
3474
3475#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3477 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3478 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003479 const size_t overhead = (size_t) ret;
3480
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 if (ret < 0) {
3482 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003483 }
3484
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 if (mtu <= overhead) {
3486 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3487 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3488 }
3489
3490 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003491 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003493 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003494#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003495
Hanno Becker0defedb2018-08-10 12:35:02 +01003496#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3497 !defined(MBEDTLS_SSL_PROTO_DTLS)
3498 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003499#endif
3500
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003502}
3503
Gilles Peskine449bd832023-01-11 14:50:10 +01003504int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003505{
3506 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3507
3508#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3509 (void) ssl;
3510#endif
3511
3512#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003514
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003516 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003518#endif
3519
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003521}
3522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003524const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003525{
Gilles Peskine449bd832023-01-11 14:50:10 +01003526 if (ssl == NULL || ssl->session == NULL) {
3527 return NULL;
3528 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003529
Hanno Beckere6824572019-02-07 13:18:46 +00003530#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003531 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003532#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003534#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003535}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003539int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3540 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003541{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003542 int ret;
3543
Gilles Peskine449bd832023-01-11 14:50:10 +01003544 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003545 dst == NULL ||
3546 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003547 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3548 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003549 }
3550
Hanno Beckere810bbc2021-05-14 16:01:05 +01003551 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3552 * idempotent: Each session can only be exported once.
3553 *
3554 * (This is in preparation for TLS 1.3 support where we will
3555 * need the ability to export multiple sessions (aka tickets),
3556 * which will be achieved by calling mbedtls_ssl_get_session()
3557 * multiple times until it fails.)
3558 *
3559 * Check whether we have already exported the current session,
3560 * and fail if so.
3561 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003562 if (ssl->session->exported == 1) {
3563 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3564 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003565
Gilles Peskine449bd832023-01-11 14:50:10 +01003566 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3567 if (ret != 0) {
3568 return ret;
3569 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003570
3571 /* Remember that we've exported the session. */
3572 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003573 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003574}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003576
Paul Bakker5121ce52009-01-03 21:22:43 +00003577/*
Hanno Beckera835da52019-05-16 12:39:07 +01003578 * Define ticket header determining Mbed TLS version
3579 * and structure of the ticket.
3580 */
3581
Hanno Becker94ef3b32019-05-16 12:50:45 +01003582/*
Hanno Becker50b59662019-05-28 14:30:45 +01003583 * Define bitflag determining compile-time settings influencing
3584 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003585 */
3586
Hanno Becker50b59662019-05-28 14:30:45 +01003587#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003588#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003589#else
Hanno Becker3e088662019-05-29 11:10:18 +01003590#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003591#endif /* MBEDTLS_HAVE_TIME */
3592
3593#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003594#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003595#else
Hanno Becker3e088662019-05-29 11:10:18 +01003596#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003597#endif /* MBEDTLS_X509_CRT_PARSE_C */
3598
3599#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003600#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003601#else
Hanno Becker3e088662019-05-29 11:10:18 +01003602#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003603#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3604
3605#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003606#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003607#else
Hanno Becker3e088662019-05-29 11:10:18 +01003608#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003609#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3610
Hanno Becker94ef3b32019-05-16 12:50:45 +01003611#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003612#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003613#else
Hanno Becker3e088662019-05-29 11:10:18 +01003614#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003615#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3616
Hanno Becker94ef3b32019-05-16 12:50:45 +01003617#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3618#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3619#else
3620#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3621#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3622
Hanno Becker3e088662019-05-29 11:10:18 +01003623#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3624#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3625#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3626#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003627#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3628#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003629
Hanno Becker50b59662019-05-28 14:30:45 +01003630#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 ((uint16_t) ( \
3632 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3633 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3634 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3635 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3636 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3637 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3638 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003639
Hanno Beckerf8787072019-05-16 12:41:07 +01003640static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003641 MBEDTLS_VERSION_MAJOR,
3642 MBEDTLS_VERSION_MINOR,
3643 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003644 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3645 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003646};
Hanno Beckera835da52019-05-16 12:39:07 +01003647
3648/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003649 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003650 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003651 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003652 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003653 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003654 * opaque mbedtls_version[3]; // library version: major, minor, patch
3655 * opaque session_format[2]; // library-version specific 16-bit field
3656 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003657 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003658 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003659 * Note: When updating the format, remember to keep
3660 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003661 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003662 * // In this version, `session_format` determines
3663 * // the setting of those compile-time
3664 * // configuration options which influence
3665 * // the structure of mbedtls_ssl_session.
3666 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003667 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003668 * // - TLS 1.2 (0x0303)
3669 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003670 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003671 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003672 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003673 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003674 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003675 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003676 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003677 *
3678 * };
3679 *
3680 * } serialized_session;
3681 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003682 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003683
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003685static int ssl_session_save(const mbedtls_ssl_session *session,
3686 unsigned char omit_header,
3687 unsigned char *buf,
3688 size_t buf_len,
3689 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003690{
3691 unsigned char *p = buf;
3692 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003693 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003694#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3695 size_t out_len;
3696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3697#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 if (session == NULL) {
3699 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3700 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003701
Gilles Peskine449bd832023-01-11 14:50:10 +01003702 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003703 /*
3704 * Add Mbed TLS version identifier
3705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003707
Gilles Peskine449bd832023-01-11 14:50:10 +01003708 if (used <= buf_len) {
3709 memcpy(p, ssl_serialized_session_header,
3710 sizeof(ssl_serialized_session_header));
3711 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003712 }
3713 }
3714
3715 /*
3716 * TLS version identifier
3717 */
3718 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003719 if (used <= buf_len) {
3720 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003721 }
3722
3723 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003724 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003725 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003727 case MBEDTLS_SSL_VERSION_TLS1_2:
3728 used += ssl_tls12_session_save(session, p, remaining_len);
3729 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003730#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3731
Jerry Yu251a12e2022-07-13 15:15:48 +08003732#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 case MBEDTLS_SSL_VERSION_TLS1_3:
3734 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3735 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3736 return ret;
3737 }
3738 used += out_len;
3739 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003740#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3741
Gilles Peskine449bd832023-01-11 14:50:10 +01003742 default:
3743 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003744 }
3745
3746 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003747 if (used > buf_len) {
3748 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3749 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003750
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003752}
3753
3754/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003755 * Public wrapper for ssl_session_save()
3756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003757int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3758 unsigned char *buf,
3759 size_t buf_len,
3760 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003761{
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003763}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003764
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003765/*
3766 * Deserialize session, see mbedtls_ssl_session_save() for format.
3767 *
3768 * This internal version is wrapped by a public function that cleans up in
3769 * case of error, and has an extra option omit_header.
3770 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003771MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003772static int ssl_session_load(mbedtls_ssl_session *session,
3773 unsigned char omit_header,
3774 const unsigned char *buf,
3775 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003776{
3777 const unsigned char *p = buf;
3778 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003779 size_t remaining_len;
3780
3781
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 if (session == NULL) {
3783 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3784 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003785
Gilles Peskine449bd832023-01-11 14:50:10 +01003786 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003787 /*
3788 * Check Mbed TLS version identifier
3789 */
3790
Gilles Peskine449bd832023-01-11 14:50:10 +01003791 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003793 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003794
3795 if (memcmp(p, ssl_serialized_session_header,
3796 sizeof(ssl_serialized_session_header)) != 0) {
3797 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3798 }
3799 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003800 }
3801
3802 /*
3803 * TLS version identifier
3804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003805 if (1 > (size_t) (end - p)) {
3806 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3807 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003808 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003809
3810 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 remaining_len = (end - p);
3812 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003813#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003814 case MBEDTLS_SSL_VERSION_TLS1_2:
3815 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003816#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3817
Jerry Yu438ddd82022-07-07 06:55:50 +00003818#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 case MBEDTLS_SSL_VERSION_TLS1_3:
3820 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003821#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 default:
3824 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003825 }
3826}
3827
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003828/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003829 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003831int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3832 const unsigned char *buf,
3833 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003834{
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003836
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 if (ret != 0) {
3838 mbedtls_ssl_session_free(session);
3839 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003840
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003842}
3843
3844/*
Paul Bakker1961b702013-01-25 14:49:24 +01003845 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003846 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003847MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003848static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003849{
3850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3851
Ronald Cron66dbf912022-02-02 15:33:46 +01003852 /*
3853 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003854 * that were written into the output buffer by the previous handshake step,
3855 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003856 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3857 * We proceed to the next handshake step only when all data from the
3858 * previous one have been sent to the peer, thus we make sure that this is
3859 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3860 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3861 * we have to wait before to go ahead.
3862 * In the case of TLS 1.3, handshake step handlers do not send data to the
3863 * peer. Data are only sent here and through
3864 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003865 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003867 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3868 return ret;
3869 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003870
3871#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3873 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3874 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3875 return ret;
3876 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003877 }
3878#endif /* MBEDTLS_SSL_PROTO_DTLS */
3879
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003881}
3882
Gilles Peskine449bd832023-01-11 14:50:10 +01003883int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003884{
Hanno Becker41934dd2021-08-07 19:13:43 +01003885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003886
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003888 ssl->conf == NULL ||
3889 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003892 }
3893
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 ret = ssl_prepare_handshake_step(ssl);
3895 if (ret != 0) {
3896 return ret;
3897 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003898
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 ret = mbedtls_ssl_handle_pending_alert(ssl);
3900 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003901 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 }
Jerry Yue7047812021-09-13 19:26:39 +08003903
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003904 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3905 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3906 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003908#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3910 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003911 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003912
Gilles Peskine449bd832023-01-11 14:50:10 +01003913 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003914 case MBEDTLS_SSL_HELLO_REQUEST:
3915 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003916 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003917 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003918
Ronald Cron9f0fba32022-02-10 16:45:15 +01003919 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003921 break;
3922
3923 default:
3924#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3926 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3927 } else {
3928 ret = mbedtls_ssl_handshake_client_step(ssl);
3929 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003930#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003932#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003934#endif
3935 }
Jerry Yub9930e72021-08-06 17:11:51 +08003936 }
Ronald Cron6291b232023-03-08 15:51:25 +01003937#endif /* MBEDTLS_SSL_CLI_C */
3938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003939#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003941#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3942 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003944 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 ret = mbedtls_ssl_handshake_server_step(ssl);
3946 }
Ronald Cron6291b232023-03-08 15:51:25 +01003947#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3948 ret = mbedtls_ssl_handshake_server_step(ssl);
3949#else
3950 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003951#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003952 }
3953#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003954
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003956 /* handshake_step return error. And it is same
3957 * with alert_reason.
3958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 if (ssl->send_alert) {
3960 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003961 goto cleanup;
3962 }
3963 }
3964
3965cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003967}
3968
3969/*
3970 * Perform the SSL handshake
3971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003972int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003973{
3974 int ret = 0;
3975
Hanno Beckera817ea42020-10-20 15:20:23 +01003976 /* Sanity checks */
3977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if (ssl == NULL || ssl->conf == NULL) {
3979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3980 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003981
Hanno Beckera817ea42020-10-20 15:20:23 +01003982#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3984 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3985 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3986 "mbedtls_ssl_set_timer_cb() for DTLS"));
3987 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003988 }
3989#endif /* MBEDTLS_SSL_PROTO_DTLS */
3990
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003992
Hanno Beckera817ea42020-10-20 15:20:23 +01003993 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3995 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003996
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003998 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 }
Paul Bakker1961b702013-01-25 14:49:24 +01004000 }
4001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004003
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004005}
4006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004007#if defined(MBEDTLS_SSL_RENEGOTIATION)
4008#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004009/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004010 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004011 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004012MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004013static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004014{
Janos Follath865b3eb2019-12-16 11:46:15 +00004015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004018
4019 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4021 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4024 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4025 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004026 }
4027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004029
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004031}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004032#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004033
4034/*
4035 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036 * - any side: calling mbedtls_ssl_renegotiate(),
4037 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4038 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004039 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004040 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004041 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004044{
Janos Follath865b3eb2019-12-16 11:46:15 +00004045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004048
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 if ((ret = ssl_handshake_init(ssl)) != 0) {
4050 return ret;
4051 }
Paul Bakker48916f92012-09-16 19:57:18 +00004052
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004053 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4054 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4057 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4058 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004059 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004061 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004063 }
4064#endif
4065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004066 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4067 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4070 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4071 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004072 }
4073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004075
Gilles Peskine449bd832023-01-11 14:50:10 +01004076 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004077}
4078
4079/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004080 * Renegotiate current connection on client,
4081 * or request renegotiation on server
4082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004083int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004084{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004085 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (ssl == NULL || ssl->conf == NULL) {
4088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4089 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004091#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004092 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4094 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4096 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004098 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004099
4100 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (ssl->out_left != 0) {
4102 return mbedtls_ssl_flush_output(ssl);
4103 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004104
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004106 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004109#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004110 /*
4111 * On client, either start the renegotiation process or,
4112 * if already in progress, continue the handshake
4113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4115 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004117 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004118
4119 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4120 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4121 return ret;
4122 }
4123 } else {
4124 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4125 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4126 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004127 }
4128 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004129#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004132}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004133#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004136{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004137 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004140 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004142
Valerio Setti6f0441d2023-07-03 12:11:36 +02004143#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004144#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (ssl->handshake->group_list_heap_allocated) {
4146 mbedtls_free((void *) handshake->group_list);
4147 }
Brett Warrene0edc842021-08-17 09:53:13 +01004148 handshake->group_list = NULL;
4149#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004150#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004151
Ronald Crone68ab4f2022-10-05 12:46:29 +02004152#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004153#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 if (ssl->handshake->sig_algs_heap_allocated) {
4155 mbedtls_free((void *) handshake->sig_algs);
4156 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004157 handshake->sig_algs = NULL;
4158#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004159#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (ssl->handshake->certificate_request_context) {
4161 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004162 }
4163#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004164#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004165
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004166#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4168 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004169 handshake->async_in_progress = 0;
4170 }
4171#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4172
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004173#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004174#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004176#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004177 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004178#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004179#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004180#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004181#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004183#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004184 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004185#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004186#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004188#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004190#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004191#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004192 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004194#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004195
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004196#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004197#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004199 /*
4200 * Opaque keys are not stored in the handshake's data and it's the user
4201 * responsibility to destroy them. Clear ones, instead, are created by
4202 * the TLS library and should be destroyed at the same level
4203 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4205 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004206 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004207 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4208#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004211#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004213 handshake->ecjpake_cache = NULL;
4214 handshake->ecjpake_cache_len = 0;
4215#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004216#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004217
Valerio Setti7aeec542023-07-05 18:57:21 +02004218#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004219 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004220 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004221 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004223#endif
4224
Ronald Cron73fe8df2022-10-05 14:31:43 +02004225#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004226#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004228 /* The maintenance of the external PSK key slot is the
4229 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 if (ssl->handshake->psk_opaque_is_internal) {
4231 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004232 ssl->handshake->psk_opaque_is_internal = 0;
4233 }
4234 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4235 }
Neil Armstronge952a302022-05-03 10:22:14 +02004236#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004238 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004239 }
Neil Armstronge952a302022-05-03 10:22:14 +02004240#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004241#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004243#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4244 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004245 /*
4246 * Free only the linked list wrapper, not the keys themselves
4247 * since the belong to the SNI callback
4248 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004251
Gilles Peskineeccd8882020-03-10 12:19:08 +01004252#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4254 if (handshake->ecrs_peer_cert != NULL) {
4255 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4256 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004257 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004258#endif
4259
Hanno Becker75173122019-02-06 16:18:31 +00004260#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4261 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004263#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4264
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004265#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4267 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004268#endif /* MBEDTLS_SSL_CLI_C &&
4269 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004270
4271#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 mbedtls_ssl_flight_free(handshake->flight);
4273 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004274#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004275
Valerio Settiea59c432023-07-25 11:14:03 +02004276#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004277 if (handshake->xxdh_psa_privkey_is_external == 0) {
4278 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 }
Valerio Settiea59c432023-07-25 11:14:03 +02004280#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004281
Ronald Cron6f135e12021-12-08 16:57:54 +01004282#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 mbedtls_ssl_transform_free(handshake->transform_handshake);
4284 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004285#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4287 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004288#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004290
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004291
4292#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4293 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4294 * processes datagrams and the fact that a datagram is allowed to have
4295 * several records in it, it is possible that the I/O buffers are not
4296 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4298 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004299#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004300
Jerry Yuba9c7272021-10-30 11:54:10 +08004301 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 mbedtls_platform_zeroize(handshake,
4303 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004304}
4305
Gilles Peskine449bd832023-01-11 14:50:10 +01004306void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004307{
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004309 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004312#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004314#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004315
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004316#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004317#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4318 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004320#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004322#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004325}
4326
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004327#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004328
4329#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4330#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4331#else
4332#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4333#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4334
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004335#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004336
4337#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4338#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4339#else
4340#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4341#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4342
4343#if defined(MBEDTLS_SSL_ALPN)
4344#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4345#else
4346#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4347#endif /* MBEDTLS_SSL_ALPN */
4348
4349#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4350#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4351#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4352#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4353
4354#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 ((uint32_t) ( \
4356 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4357 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4358 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4359 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4360 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4361 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4362 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4363 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004364
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004365static unsigned char ssl_serialized_context_header[] = {
4366 MBEDTLS_VERSION_MAJOR,
4367 MBEDTLS_VERSION_MINOR,
4368 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4370 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4371 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4372 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4373 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004374};
4375
Paul Bakker5121ce52009-01-03 21:22:43 +00004376/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004377 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004378 *
4379 * The format of the serialized data is:
4380 * (in the presentation language of TLS, RFC 8446 section 3)
4381 *
4382 * // header
4383 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004384 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004385 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004386 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004387 * Note: When updating the format, remember to keep these
4388 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004389 *
4390 * // session sub-structure
4391 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4392 * // transform sub-structure
4393 * uint8 random[64]; // ServerHello.random+ClientHello.random
4394 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4395 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4396 * // fields from ssl_context
4397 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4398 * uint64 in_window_top; // DTLS: last validated record seq_num
4399 * uint64 in_window; // DTLS: bitmask for replay protection
4400 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4401 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4402 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4403 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4404 *
4405 * Note that many fields of the ssl_context or sub-structures are not
4406 * serialized, as they fall in one of the following categories:
4407 *
4408 * 1. forced value (eg in_left must be 0)
4409 * 2. pointer to dynamically-allocated memory (eg session, transform)
4410 * 3. value can be re-derived from other data (eg session keys from MS)
4411 * 4. value was temporary (eg content of input buffer)
4412 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004414int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4415 unsigned char *buf,
4416 size_t buf_len,
4417 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004418{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004419 unsigned char *p = buf;
4420 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004421 size_t session_len;
4422 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004423
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004424 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004425 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4426 * this function's documentation.
4427 *
4428 * These are due to assumptions/limitations in the implementation. Some of
4429 * them are likely to stay (no handshake in progress) some might go away
4430 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004431 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004432 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4434 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004436 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (ssl->handshake != NULL) {
4438 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004440 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004441 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (ssl->transform == NULL || ssl->session == NULL) {
4443 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4444 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004445 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004446 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (mbedtls_ssl_check_pending(ssl) != 0) {
4448 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if (ssl->out_left != 0) {
4452 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004454 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004455 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4457 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4458 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004459 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004460 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4462 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4463 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004464 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004465 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4467 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4468 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004469 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004470 /* Renegotiation must not be enabled */
4471#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4473 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4474 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004475 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004476#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004477
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004478 /*
4479 * Version and format identifier
4480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004482
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (used <= buf_len) {
4484 memcpy(p, ssl_serialized_context_header,
4485 sizeof(ssl_serialized_context_header));
4486 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004487 }
4488
4489 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004490 * Session (length + data)
4491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4493 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4494 return ret;
4495 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004496
4497 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (used <= buf_len) {
4499 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004500 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 ret = ssl_session_save(ssl->session, 1,
4503 p, session_len, &session_len);
4504 if (ret != 0) {
4505 return ret;
4506 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004507
4508 p += session_len;
4509 }
4510
4511 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004512 * Transform
4513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 used += sizeof(ssl->transform->randbytes);
4515 if (used <= buf_len) {
4516 memcpy(p, ssl->transform->randbytes,
4517 sizeof(ssl->transform->randbytes));
4518 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004519 }
4520
4521#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4522 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004524 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004526 p += ssl->transform->in_cid_len;
4527
4528 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004530 p += ssl->transform->out_cid_len;
4531 }
4532#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4533
4534 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004535 * Saved fields from top-level ssl_context structure
4536 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004537 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (used <= buf_len) {
4539 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004540 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004541 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004542
4543#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4544 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (used <= buf_len) {
4546 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004547 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004550 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004551 }
4552#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4553
4554#if defined(MBEDTLS_SSL_PROTO_DTLS)
4555 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004557 *p++ = ssl->disable_datagram_packing;
4558 }
4559#endif /* MBEDTLS_SSL_PROTO_DTLS */
4560
Jerry Yuae0b2e22021-10-08 15:21:19 +08004561 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (used <= buf_len) {
4563 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004564 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004565 }
4566
4567#if defined(MBEDTLS_SSL_PROTO_DTLS)
4568 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (used <= buf_len) {
4570 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004571 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004572 }
4573#endif /* MBEDTLS_SSL_PROTO_DTLS */
4574
4575#if defined(MBEDTLS_SSL_ALPN)
4576 {
4577 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004579 : 0;
4580
4581 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004583 *p++ = alpn_len;
4584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (ssl->alpn_chosen != NULL) {
4586 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004587 p += alpn_len;
4588 }
4589 }
4590 }
4591#endif /* MBEDTLS_SSL_ALPN */
4592
4593 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004594 * Done
4595 */
4596 *olen = used;
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (used > buf_len) {
4599 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4600 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004605}
4606
4607/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004608 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004609 *
4610 * This internal version is wrapped by a public function that cleans up in
4611 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004612 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004614static int ssl_context_load(mbedtls_ssl_context *ssl,
4615 const unsigned char *buf,
4616 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004617{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004618 const unsigned char *p = buf;
4619 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004620 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004621 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004622#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004623 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004624#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004625
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004626 /*
4627 * The context should have been freshly setup or reset.
4628 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004629 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004630 * renegotiating, or if the user mistakenly loaded a session first.)
4631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4633 ssl->session != NULL) {
4634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004635 }
4636
4637 /*
4638 * We can't check that the config matches the initial one, but we can at
4639 * least check it matches the requirements for serializing.
4640 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004641 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004642#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004643 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004644#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004645 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4646 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4647 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4648 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004650 }
4651
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004653
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004654 /*
4655 * Check version identifier
4656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004659 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004660
4661 if (memcmp(p, ssl_serialized_context_header,
4662 sizeof(ssl_serialized_context_header)) != 0) {
4663 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4664 }
4665 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004666
4667 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004668 * Session
4669 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if ((size_t) (end - p) < 4) {
4671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4672 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004673
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004674 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004675 p += 4;
4676
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004677 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004678 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004679 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004680 ssl->session_in = ssl->session;
4681 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004682 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004683
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 if ((size_t) (end - p) < session_len) {
4685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4686 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 ret = ssl_session_load(ssl->session, 1, p, session_len);
4689 if (ret != 0) {
4690 mbedtls_ssl_session_free(ssl->session);
4691 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004692 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004693
4694 p += session_len;
4695
4696 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 * Transform
4698 */
4699
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004700 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004701 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004702#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004703 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004704 ssl->transform_in = ssl->transform;
4705 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004706 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004707#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004708
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004709#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4711 if (prf_func == NULL) {
4712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4713 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004714
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004715 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4718 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004719
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 ret = ssl_tls12_populate_transform(ssl->transform,
4721 ssl->session->ciphersuite,
4722 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004723#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004725#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 prf_func,
4727 p, /* currently pointing to randbytes */
4728 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4729 ssl->conf->endpoint,
4730 ssl);
4731 if (ret != 0) {
4732 return ret;
4733 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004736
4737#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4738 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if ((size_t) (end - p) < 1) {
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4741 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004742
4743 ssl->transform->in_cid_len = *p++;
4744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4747 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004750 p += ssl->transform->in_cid_len;
4751
4752 ssl->transform->out_cid_len = *p++;
4753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4756 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004759 p += ssl->transform->out_cid_len;
4760#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4761
4762 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763 * Saved fields from top-level ssl_context structure
4764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if ((size_t) (end - p) < 4) {
4766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4767 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004768
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004769 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004771
4772#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if ((size_t) (end - p) < 16) {
4774 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4775 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004776
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004777 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778 p += 8;
4779
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004780 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004781 p += 8;
4782#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4783
4784#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if ((size_t) (end - p) < 1) {
4786 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4787 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004788
4789 ssl->disable_datagram_packing = *p++;
4790#endif /* MBEDTLS_SSL_PROTO_DTLS */
4791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4793 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4794 }
4795 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4796 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004797
4798#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if ((size_t) (end - p) < 2) {
4800 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4801 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004802
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004804 p += 2;
4805#endif /* MBEDTLS_SSL_PROTO_DTLS */
4806
4807#if defined(MBEDTLS_SSL_ALPN)
4808 {
4809 uint8_t alpn_len;
4810 const char **cur;
4811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if ((size_t) (end - p) < 1) {
4813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4814 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004815
4816 alpn_len = *p++;
4817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004819 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4821 if (strlen(*cur) == alpn_len &&
4822 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004823 ssl->alpn_chosen = *cur;
4824 break;
4825 }
4826 }
4827 }
4828
4829 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4831 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4832 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004833
4834 p += alpn_len;
4835 }
4836#endif /* MBEDTLS_SSL_ALPN */
4837
4838 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004839 * Forced fields from top-level ssl_context structure
4840 *
4841 * Most of them already set to the correct value by mbedtls_ssl_init() and
4842 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4843 */
4844 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004845 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004846
Hanno Becker361b10d2019-08-30 10:42:49 +01004847 /* Adjust pointers for header fields of outgoing records to
4848 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004850
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004851#if defined(MBEDTLS_SSL_PROTO_DTLS)
4852 ssl->in_epoch = 1;
4853#endif
4854
4855 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4856 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004857 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4858 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (ssl->handshake != NULL) {
4860 mbedtls_ssl_handshake_free(ssl);
4861 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004862 ssl->handshake = NULL;
4863 }
4864
4865 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004866 * Done - should have consumed entire buffer
4867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (p != end) {
4869 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4870 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004873}
4874
4875/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004876 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004877 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004878int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4879 const unsigned char *buf,
4880 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004881{
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004883
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if (ret != 0) {
4885 mbedtls_ssl_free(context);
4886 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004889}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004890#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004891
4892/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004893 * Free an SSL context
4894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004896{
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004898 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004904#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4905 size_t out_buf_len = ssl->out_buf_len;
4906#else
4907 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4908#endif
4909
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004910 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004911 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004912 }
4913
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004915#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4916 size_t in_buf_len = ssl->in_buf_len;
4917#else
4918 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4919#endif
4920
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004921 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004922 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004923 }
4924
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 if (ssl->transform) {
4926 mbedtls_ssl_transform_free(ssl->transform);
4927 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004928 }
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (ssl->handshake) {
4931 mbedtls_ssl_handshake_free(ssl);
4932 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004933
4934#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4936 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004937#endif
4938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 mbedtls_ssl_session_free(ssl->session_negotiate);
4940 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004941 }
4942
Ronald Cron6f135e12021-12-08 16:57:54 +01004943#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 mbedtls_ssl_transform_free(ssl->transform_application);
4945 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004946#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (ssl->session) {
4949 mbedtls_ssl_session_free(ssl->session);
4950 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004951 }
4952
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004953#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004955 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004956 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004957#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004958
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004959#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004961#endif
4962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004964
Paul Bakker86f04f42013-02-14 11:20:09 +01004965 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004967}
4968
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004969/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004970 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004972void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004973{
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004975}
4976
Gilles Peskineae270bf2021-06-02 00:05:29 +02004977/* The selection should be the same as mbedtls_x509_crt_profile_default in
4978 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004979 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004980 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004981 * about this list.
4982 */
Brett Warrene0edc842021-08-17 09:53:13 +01004983static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004984#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004985 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004986#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004987#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004988 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004989#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004990#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004991 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004992#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004993#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004994 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004995#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004996#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004997 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004998#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004999#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005000 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005001#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005002#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005003 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005004#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005005#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005006 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005007#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005008#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005009 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5010 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5011 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5012 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5013 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5014#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005015 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005016};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005017
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005018static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005019 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5020 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5021 0
5022};
5023
Ronald Crone68ab4f2022-10-05 12:46:29 +02005024#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005025
Jerry Yu909df7b2022-01-22 11:56:27 +08005026/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005027 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005028 * rules SHOULD be upheld.
5029 * - No duplicate entries.
5030 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005031 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005032 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005033 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005034static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005035
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005036#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005037 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005038 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005039 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005040 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5041#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005042
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005043#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005044 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005045 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005046 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005047 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5048#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005049
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005050#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005051 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005052 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005053 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005054 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5055#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005058 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005059 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005060#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005061 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005062
Gilles Peskine449bd832023-01-11 14:50:10 +01005063#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005064 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005065 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005066#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005067 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005070 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005071 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005072#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005074
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005075#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005076 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005077#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005078
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005080 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005081#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005082
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005084 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005085#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005086
Gabor Mezei15b95a62022-05-09 16:37:58 +02005087 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005088};
5089
5090/* NOTICE: see above */
5091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5092static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005093#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005094#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005096#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005097#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5098 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5099#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005100#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005102#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005103#endif /* MBEDTLS_MD_CAN_SHA512*/
5104#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005105#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005107#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005108#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5109 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5110#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005111#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005113#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005114#endif /* MBEDTLS_MD_CAN_SHA384*/
5115#if defined(MBEDTLS_MD_CAN_SHA256)
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_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +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_SHA256,
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_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005124#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005125#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005126 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005127};
5128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5129/* NOTICE: see above */
5130static uint16_t ssl_preset_suiteb_sig_algs[] = {
5131
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005132#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005133 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005134 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005135 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005136 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5137#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005138
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005139#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005140 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005141 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005142 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005143 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5144#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005145
Gilles Peskine449bd832023-01-11 14:50:10 +01005146#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005147 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005148 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005149#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005150 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005151
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005152#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005153 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005154#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005155
Gabor Mezei15b95a62022-05-09 16:37:58 +02005156 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005157};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005158
Jerry Yu909df7b2022-01-22 11:56:27 +08005159/* NOTICE: see above */
5160#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5161static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005162#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005163#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005165#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005166#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005168#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005169#endif /* MBEDTLS_MD_CAN_SHA256*/
5170#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005171#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005173#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005174#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005176#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005177#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005178 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005179};
Jerry Yu909df7b2022-01-22 11:56:27 +08005180#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5181
Ronald Crone68ab4f2022-10-05 12:46:29 +02005182#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005183
Brett Warrene0edc842021-08-17 09:53:13 +01005184static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005185#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005186 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005187#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005188#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005189 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005190#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005191 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005192};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005193
Ronald Crone68ab4f2022-10-05 12:46:29 +02005194#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005195/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005196 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005197MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005198static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005199{
5200 size_t i, j;
5201 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5204 for (j = 0; j < i; j++) {
5205 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005206 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 }
5208 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5209 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5210 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005211 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005212 }
5213 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005215}
5216
Ronald Crone68ab4f2022-10-05 12:46:29 +02005217#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005218
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005219/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005220 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005222int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5223 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005224{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005225#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005226 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005227#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005228
Ronald Crone68ab4f2022-10-05 12:46:29 +02005229#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5231 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5232 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005233 }
5234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5236 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5237 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005238 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005239
5240#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5242 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5243 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005244 }
5245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5247 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5248 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005249 }
5250#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005251#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005252
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005253 /* Use the functions here so that they are covered in tests,
5254 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 mbedtls_ssl_conf_endpoint(conf, endpoint);
5256 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005257
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005258 /*
5259 * Things that are common to all presets
5260 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005261#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005263 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5264#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5265 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5266#endif
5267 }
5268#endif
5269
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005270#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5271 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5272#endif
5273
5274#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5275 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5276#endif
5277
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005278#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005279 conf->f_cookie_write = ssl_cookie_write_dummy;
5280 conf->f_cookie_check = ssl_cookie_check_dummy;
5281#endif
5282
5283#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5284 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5285#endif
5286
Janos Follath088ce432017-04-10 12:42:31 +01005287#if defined(MBEDTLS_SSL_SRV_C)
5288 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005289 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005290#endif
5291
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005292#if defined(MBEDTLS_SSL_PROTO_DTLS)
5293 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5294 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5295#endif
5296
5297#if defined(MBEDTLS_SSL_RENEGOTIATION)
5298 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 memset(conf->renego_period, 0x00, 2);
5300 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005301#endif
5302
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005303#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005305 const unsigned char dhm_p[] =
5306 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5307 const unsigned char dhm_g[] =
5308 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5311 dhm_p, sizeof(dhm_p),
5312 dhm_g, sizeof(dhm_g))) != 0) {
5313 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005314 }
5315 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005316#endif
5317
Ronald Cron6f135e12021-12-08 16:57:54 +01005318#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005319
5320#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005321 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005322#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005323 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005324#endif
5325#endif /* MBEDTLS_SSL_EARLY_DATA */
5326
Jerry Yud0766ec2022-09-22 10:46:57 +08005327#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005328 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005330#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005331 /*
5332 * Allow all TLS 1.3 key exchange modes by default.
5333 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005334 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005335#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005338#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005339 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005340 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005341#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005343#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005345#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005346 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5347 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005348#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5349 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5350 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5351#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5352 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5353 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5354#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005356#endif
5357 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005358
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005359 /*
5360 * Preset-specific defaults
5361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005363 /*
5364 * NSA Suite B
5365 */
5366 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005368 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005369
5370#if defined(MBEDTLS_X509_CRT_PARSE_C)
5371 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005372#endif
5373
Ronald Crone68ab4f2022-10-05 12:46:29 +02005374#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005375#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005377 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005379#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005381#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005382
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005383#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005384 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005385#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005386 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005387 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005388
5389 /*
5390 * Default
5391 */
5392 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005393
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005394 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005395
5396#if defined(MBEDTLS_X509_CRT_PARSE_C)
5397 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5398#endif
5399
Ronald Crone68ab4f2022-10-05 12:46:29 +02005400#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005401#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005403 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005405#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005407#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005408
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005409#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005410 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005411#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005412 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005413
5414#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5415 conf->dhm_min_bitlen = 1024;
5416#endif
5417 }
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005420}
5421
5422/*
5423 * Free mbedtls_ssl_config
5424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005425void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005426{
5427#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 mbedtls_mpi_free(&conf->dhm_P);
5429 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005430#endif
5431
Ronald Cron73fe8df2022-10-05 14:31:43 +02005432#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005433#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005435 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5436 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005437#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005439 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005440 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005441 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005442 }
5443
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005445 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005446 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005447 conf->psk_identity_len = 0;
5448 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005449#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005450
5451#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005453#endif
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005456}
5457
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005458#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005459 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005460/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005461 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005463unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005464{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5467 return MBEDTLS_SSL_SIG_RSA;
5468 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005469#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005470#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5472 return MBEDTLS_SSL_SIG_ECDSA;
5473 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005474#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005476}
5477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005479{
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005481 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005483 case MBEDTLS_PK_ECDSA:
5484 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005486 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005488 }
5489}
5490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005492{
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494#if defined(MBEDTLS_RSA_C)
5495 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005497#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005498#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005499 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005501#endif
5502 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005504 }
5505}
Valerio Settie9646ec2023-08-02 20:02:28 +02005506#endif /* MBEDTLS_PK_C &&
5507 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005508
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005509/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005513{
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005515#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005518#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005519#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005522#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005523#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005526#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005527#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005530#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005531#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005534#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005535#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005536 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005538#endif
5539 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005541 }
5542}
5543
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005544/*
5545 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5546 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005547unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005548{
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005550#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005551 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005553#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005554#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005555 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005557#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005558#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005559 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005561#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005562#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005563 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005565#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005566#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005567 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005569#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005570#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005571 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005573#endif
5574 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005576 }
5577}
5578
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005579/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005580 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005581 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005584{
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (group_list == NULL) {
5588 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005589 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 for (; *group_list != 0; group_list++) {
5592 if (*group_list == tls_id) {
5593 return 0;
5594 }
5595 }
5596
5597 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005598}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005599
Valerio Setti49e69072023-06-27 17:27:51 +02005600#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005601/*
5602 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005604int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005605{
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005607
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005609 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005611
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005613}
Valerio Setti49e69072023-06-27 17:27:51 +02005614#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005615
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616static const struct {
5617 uint16_t tls_id;
5618 mbedtls_ecp_group_id ecp_group_id;
5619 psa_ecc_family_t psa_family;
5620 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005621} tls_id_match_table[] =
5622{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005623#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005624 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005626#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005627 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005628#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005629#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005630 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005631#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005632#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005633 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005634#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005635#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005636 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005638#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005639 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005640#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005641#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005642 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005644#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005645 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005646#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005647#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005648 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005650#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005651 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005652#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005653#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005654 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005655#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005656#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005657 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005658#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005659#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005660 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005661#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005662 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005663};
5664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005666 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668{
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5670 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005671 if (type != NULL) {
5672 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 }
5674 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005675 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677 return PSA_SUCCESS;
5678 }
5679 }
5680
5681 return PSA_ERROR_NOT_SUPPORTED;
5682}
5683
Gilles Peskine449bd832023-01-11 14:50:10 +01005684mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005685{
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5687 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005688 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005690 }
5691
5692 return MBEDTLS_ECP_DP_NONE;
5693}
5694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005696{
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5698 i++) {
5699 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005700 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005702 }
5703
5704 return 0;
5705}
5706
Valerio Setti67419f02023-01-04 16:12:42 +01005707#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005708static const struct {
5709 uint16_t tls_id;
5710 const char *name;
5711} tls_id_curve_name_table[] =
5712{
Valerio Setti54e23792023-07-07 10:49:27 +02005713 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5714 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5715 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5716 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5717 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5718 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5719 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5720 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5721 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5722 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5723 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5724 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5725 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005726 { 0, NULL },
5727};
5728
Gilles Peskine449bd832023-01-11 14:50:10 +01005729const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005730{
Valerio Settiacd32c02023-06-29 18:06:29 +02005731 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5732 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5733 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005735 }
5736
5737 return NULL;
5738}
Valerio Setti67419f02023-01-04 16:12:42 +01005739#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005741#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005742int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5743 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5744 int cert_endpoint,
5745 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005746{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005747 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005748 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005749 const char *ext_oid;
5750 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005751
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005753 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005755 case MBEDTLS_KEY_EXCHANGE_RSA:
5756 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005757 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005758 break;
5759
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5761 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5762 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5763 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005764 break;
5765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5767 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005768 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005769 break;
5770
5771 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 case MBEDTLS_KEY_EXCHANGE_NONE:
5773 case MBEDTLS_KEY_EXCHANGE_PSK:
5774 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5775 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005776 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005777 usage = 0;
5778 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5781 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005782 }
5783
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005785 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005786 ret = -1;
5787 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005788
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005790 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5792 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005795 }
5796
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005798 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005799 ret = -1;
5800 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005803}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005804#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005805
Jerry Yu148165c2021-09-24 23:20:59 +08005806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005807int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5808 const mbedtls_md_type_t md,
5809 unsigned char *dst,
5810 size_t dst_len,
5811 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005812{
Ronald Cronf6893e12022-01-07 22:09:01 +01005813 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5814 psa_hash_operation_t *hash_operation_to_clone;
5815 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5816
Jerry Yu148165c2021-09-24 23:20:59 +08005817 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005820#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 case MBEDTLS_MD_SHA384:
5822 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5823 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005824#endif
5825
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005826#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 case MBEDTLS_MD_SHA256:
5828 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5829 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005830#endif
5831
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 default:
5833 goto exit;
5834 }
5835
5836 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5837 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005838 goto exit;
5839 }
5840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5842 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005843 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005845
5846exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005847#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5848 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005849 (void) ssl;
5850#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005851 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005852}
5853#else /* MBEDTLS_USE_PSA_CRYPTO */
5854
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005855#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005857static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5858 unsigned char *dst,
5859 size_t dst_len,
5860 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005861{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005863 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (dst_len < 48) {
5866 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5867 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005868
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005869 mbedtls_md_init(&sha384);
5870 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005871 if (ret != 0) {
5872 goto exit;
5873 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005874 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005875 if (ret != 0) {
5876 goto exit;
5877 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005878
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005879 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005880 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005881 goto exit;
5882 }
5883
5884 *olen = 48;
5885
5886exit:
5887
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005888 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005891#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005892
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005893#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005894MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005895static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5896 unsigned char *dst,
5897 size_t dst_len,
5898 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005899{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005900 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005901 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005902
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 if (dst_len < 32) {
5904 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5905 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005906
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005907 mbedtls_md_init(&sha256);
5908 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5909 if (ret != 0) {
5910 goto exit;
5911 }
5912 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5913 if (ret != 0) {
5914 goto exit;
5915 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005916
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005917 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5918 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005919 goto exit;
5920 }
5921
5922 *olen = 32;
5923
5924exit:
5925
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005926 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005928}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005929#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5932 const mbedtls_md_type_t md,
5933 unsigned char *dst,
5934 size_t dst_len,
5935 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005936{
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005939#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 case MBEDTLS_MD_SHA384:
5941 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005942#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005943
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005944#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 case MBEDTLS_MD_SHA256:
5946 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005947#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005950#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5951 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 (void) ssl;
5953 (void) dst;
5954 (void) dst_len;
5955 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005956#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005958 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005960}
XiaokangQian647719a2021-12-07 09:16:29 +00005961
Jerry Yu148165c2021-09-24 23:20:59 +08005962#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005963
Ronald Crone68ab4f2022-10-05 12:46:29 +02005964#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005965/* mbedtls_ssl_parse_sig_alg_ext()
5966 *
5967 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5968 * value (TLS 1.3 RFC8446):
5969 * enum {
5970 * ....
5971 * ecdsa_secp256r1_sha256( 0x0403 ),
5972 * ecdsa_secp384r1_sha384( 0x0503 ),
5973 * ecdsa_secp521r1_sha512( 0x0603 ),
5974 * ....
5975 * } SignatureScheme;
5976 *
5977 * struct {
5978 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5979 * } SignatureSchemeList;
5980 *
5981 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5982 * value (TLS 1.2 RFC5246):
5983 * enum {
5984 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5985 * sha512(6), (255)
5986 * } HashAlgorithm;
5987 *
5988 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5989 * SignatureAlgorithm;
5990 *
5991 * struct {
5992 * HashAlgorithm hash;
5993 * SignatureAlgorithm signature;
5994 * } SignatureAndHashAlgorithm;
5995 *
5996 * SignatureAndHashAlgorithm
5997 * supported_signature_algorithms<2..2^16-2>;
5998 *
5999 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6000 * generalization of the TLS 1.2 signature algorithm extension.
6001 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6002 * `SignatureScheme` field of TLS 1.3
6003 *
6004 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006005int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6006 const unsigned char *buf,
6007 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006008{
6009 const unsigned char *p = buf;
6010 size_t supported_sig_algs_len = 0;
6011 const unsigned char *supported_sig_algs_end;
6012 uint16_t sig_alg;
6013 uint32_t common_idx = 0;
6014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6016 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006017 p += 2;
6018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 memset(ssl->handshake->received_sig_algs, 0,
6020 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006021
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006023 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 while (p < supported_sig_algs_end) {
6025 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6026 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006027 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6029 sig_alg,
6030 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006031#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6033 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6034 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006035 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006036 }
6037#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6040 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006043 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6044 common_idx += 1;
6045 }
6046 }
6047 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 if (p != end) {
6049 MBEDTLS_SSL_DEBUG_MSG(1,
6050 ("Signature algorithms extension length misaligned"));
6051 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6052 MBEDTLS_ERR_SSL_DECODE_ERROR);
6053 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006054 }
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (common_idx == 0) {
6057 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6058 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6059 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6060 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006061 }
6062
Gabor Mezei15b95a62022-05-09 16:37:58 +02006063 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006065}
6066
Ronald Crone68ab4f2022-10-05 12:46:29 +02006067#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006068
Jerry Yudc7bd172022-02-17 13:44:15 +08006069#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6070
6071#if defined(MBEDTLS_USE_PSA_CRYPTO)
6072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6074 mbedtls_svc_key_id_t key,
6075 psa_algorithm_t alg,
6076 const unsigned char *raw_psk, size_t raw_psk_length,
6077 const unsigned char *seed, size_t seed_length,
6078 const unsigned char *label, size_t label_length,
6079 const unsigned char *other_secret,
6080 size_t other_secret_length,
6081 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006082{
6083 psa_status_t status;
6084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 status = psa_key_derivation_setup(derivation, alg);
6086 if (status != PSA_SUCCESS) {
6087 return status;
6088 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006089
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6091 status = psa_key_derivation_input_bytes(derivation,
6092 PSA_KEY_DERIVATION_INPUT_SEED,
6093 seed, seed_length);
6094 if (status != PSA_SUCCESS) {
6095 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006096 }
6097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 if (other_secret != NULL) {
6099 status = psa_key_derivation_input_bytes(derivation,
6100 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6101 other_secret, other_secret_length);
6102 if (status != PSA_SUCCESS) {
6103 return status;
6104 }
6105 }
6106
6107 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006108 status = psa_key_derivation_input_bytes(
6109 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 raw_psk, raw_psk_length);
6111 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006112 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (status != PSA_SUCCESS) {
6116 return status;
6117 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 status = psa_key_derivation_input_bytes(derivation,
6120 PSA_KEY_DERIVATION_INPUT_LABEL,
6121 label, label_length);
6122 if (status != PSA_SUCCESS) {
6123 return status;
6124 }
6125 } else {
6126 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006127 }
6128
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 status = psa_key_derivation_set_capacity(derivation, capacity);
6130 if (status != PSA_SUCCESS) {
6131 return status;
6132 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006135}
6136
Andrzej Kurek57d10632022-10-24 10:32:01 -04006137#if defined(PSA_WANT_ALG_SHA_384) || \
6138 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006139MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006140static int tls_prf_generic(mbedtls_md_type_t md_type,
6141 const unsigned char *secret, size_t slen,
6142 const char *label,
6143 const unsigned char *random, size_t rlen,
6144 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006145{
6146 psa_status_t status;
6147 psa_algorithm_t alg;
6148 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6149 psa_key_derivation_operation_t derivation =
6150 PSA_KEY_DERIVATION_OPERATION_INIT;
6151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006153 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006155 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006157
6158 /* Normally a "secret" should be long enough to be impossible to
6159 * find by brute force, and in particular should not be empty. But
6160 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6161 * and for this use case it makes sense to have a 0-length "secret".
6162 * Since the key API doesn't allow importing a key of length 0,
6163 * keep master_key=0, which setup_psa_key_derivation() understands
6164 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006166 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6168 psa_set_key_algorithm(&key_attributes, alg);
6169 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6172 if (status != PSA_SUCCESS) {
6173 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6174 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 }
6176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 status = setup_psa_key_derivation(&derivation,
6178 master_key, alg,
6179 NULL, 0,
6180 random, rlen,
6181 (unsigned char const *) label,
6182 (size_t) strlen(label),
6183 NULL, 0,
6184 dlen);
6185 if (status != PSA_SUCCESS) {
6186 psa_key_derivation_abort(&derivation);
6187 psa_destroy_key(master_key);
6188 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 }
6190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6192 if (status != PSA_SUCCESS) {
6193 psa_key_derivation_abort(&derivation);
6194 psa_destroy_key(master_key);
6195 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006196 }
6197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 status = psa_key_derivation_abort(&derivation);
6199 if (status != PSA_SUCCESS) {
6200 psa_destroy_key(master_key);
6201 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 }
6203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (!mbedtls_svc_key_id_is_null(master_key)) {
6205 status = psa_destroy_key(master_key);
6206 }
6207 if (status != PSA_SUCCESS) {
6208 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6209 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006212}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006213#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006214#else /* MBEDTLS_USE_PSA_CRYPTO */
6215
Andrzej Kurek57d10632022-10-24 10:32:01 -04006216#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006217 (defined(MBEDTLS_MD_CAN_SHA256) || \
6218 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006220static int tls_prf_generic(mbedtls_md_type_t md_type,
6221 const unsigned char *secret, size_t slen,
6222 const char *label,
6223 const unsigned char *random, size_t rlen,
6224 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006225{
6226 size_t nb;
6227 size_t i, j, k, md_len;
6228 unsigned char *tmp;
6229 size_t tmp_len = 0;
6230 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6231 const mbedtls_md_info_t *md_info;
6232 mbedtls_md_context_t md_ctx;
6233 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6238 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6239 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 tmp_len = md_len + strlen(label) + rlen;
6244 tmp = mbedtls_calloc(1, tmp_len);
6245 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6247 goto exit;
6248 }
6249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 nb = strlen(label);
6251 memcpy(tmp + md_len, label, nb);
6252 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 nb += rlen;
6254
6255 /*
6256 * Compute P_<hash>(secret, label + random)[0..dlen]
6257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6263 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 }
6266 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6267 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 }
6270 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6271 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 for (i = 0; i < dlen; i += md_len) {
6276 ret = mbedtls_md_hmac_reset(&md_ctx);
6277 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
6280 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6281 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006282 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 }
6284 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6285 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006286 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 ret = mbedtls_md_hmac_reset(&md_ctx);
6290 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 }
6293 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6294 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006295 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
6297 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6298 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006305 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006307 }
6308
6309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006311
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (tmp != NULL) {
6313 mbedtls_platform_zeroize(tmp, tmp_len);
6314 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006317
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006319
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006321}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006322#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006323#endif /* MBEDTLS_USE_PSA_CRYPTO */
6324
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006325#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006326MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006327static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6328 const char *label,
6329 const unsigned char *random, size_t rlen,
6330 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006331{
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6333 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006334}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006335#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006336
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006337#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006338MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006339static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6340 const char *label,
6341 const unsigned char *random, size_t rlen,
6342 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006343{
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6345 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006346}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006347#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006348
Jerry Yuf009d862022-02-17 14:01:37 +08006349/*
6350 * Set appropriate PRF function and other SSL / TLS1.2 functions
6351 *
6352 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006353 * - hash associated with the ciphersuite (only used by TLS 1.2)
6354 *
6355 * Outputs:
6356 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6357 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006358MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006359static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6360 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006361{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006362#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006364 handshake->tls_prf = tls_prf_sha384;
6365 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6366 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006368#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006369#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006370 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006371 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006372 handshake->tls_prf = tls_prf_sha256;
6373 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6374 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6375 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006376#else
Jerry Yuf009d862022-02-17 14:01:37 +08006377 {
Jerry Yuf009d862022-02-17 14:01:37 +08006378 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006379 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006381 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006382#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006385}
Jerry Yud6ab2352022-02-17 14:03:43 +08006386
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006387/*
6388 * Compute master secret if needed
6389 *
6390 * Parameters:
6391 * [in/out] handshake
6392 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6393 * (PSA-PSK) ciphersuite_info, psk_opaque
6394 * [out] premaster (cleared)
6395 * [out] master
6396 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6397 * debug: conf->f_dbg, conf->p_dbg
6398 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006399 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006401MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006402static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6403 unsigned char *master,
6404 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405{
6406 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6407
6408 /* cf. RFC 5246, Section 8.1:
6409 * "The master secret is always exactly 48 bytes in length." */
6410 size_t const master_secret_len = 48;
6411
6412#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6413 unsigned char session_hash[48];
6414#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6415
6416 /* The label for the KDF used for key expansion.
6417 * This is either "master secret" or "extended master secret"
6418 * depending on whether the Extended Master Secret extension
6419 * is used. */
6420 char const *lbl = "master secret";
6421
Przemek Stekielae4ed302022-04-05 17:15:55 +02006422 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423 * - If the Extended Master Secret extension is not used,
6424 * this is ClientHello.Random + ServerHello.Random
6425 * (see Sect. 8.1 in RFC 5246).
6426 * - If the Extended Master Secret extension is used,
6427 * this is the transcript of the handshake so far.
6428 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006429 unsigned char const *seed = handshake->randbytes;
6430 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431
6432#if !defined(MBEDTLS_DEBUG_C) && \
6433 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6434 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436 ssl = NULL; /* make sure we don't use it except for those cases */
6437 (void) ssl;
6438#endif
6439
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 if (handshake->resume != 0) {
6441 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6442 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006443 }
6444
6445#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006447 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006448 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006449 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6450 if (ret != 0) {
6451 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6452 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6455 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006456 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006457#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458
Przemek Stekiel99114f32022-04-22 11:20:09 +02006459#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006460 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006462 /* Perform PSK-to-MS expansion in a single step. */
6463 psa_status_t status;
6464 psa_algorithm_t alg;
6465 mbedtls_svc_key_id_t psk;
6466 psa_key_derivation_operation_t derivation =
6467 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006468 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006477 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006479
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006480 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006484 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006485 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006486 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006487 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006488 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006489 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006490 other_secret_len = 48;
6491 other_secret = handshake->premaster + 2;
6492 break;
6493 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006494 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006495 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6496 other_secret = handshake->premaster + 2;
6497 break;
6498 default:
6499 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006500 }
6501
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 status = setup_psa_key_derivation(&derivation, psk, alg,
6503 ssl->conf->psk, ssl->conf->psk_len,
6504 seed, seed_len,
6505 (unsigned char const *) lbl,
6506 (size_t) strlen(lbl),
6507 other_secret, other_secret_len,
6508 master_secret_len);
6509 if (status != PSA_SUCCESS) {
6510 psa_key_derivation_abort(&derivation);
6511 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006512 }
6513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 status = psa_key_derivation_output_bytes(&derivation,
6515 master,
6516 master_secret_len);
6517 if (status != PSA_SUCCESS) {
6518 psa_key_derivation_abort(&derivation);
6519 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006520 }
6521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 status = psa_key_derivation_abort(&derivation);
6523 if (status != PSA_SUCCESS) {
6524 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6525 }
6526 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006527#endif
6528 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006529#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6531 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006532 psa_status_t status;
6533 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6534 psa_key_derivation_operation_t derivation =
6535 PSA_KEY_DERIVATION_OPERATION_INIT;
6536
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006538
6539 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 status = psa_key_derivation_setup(&derivation, alg);
6542 if (status != PSA_SUCCESS) {
6543 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006544 }
6545
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 status = psa_key_derivation_set_capacity(&derivation,
6547 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6548 if (status != PSA_SUCCESS) {
6549 psa_key_derivation_abort(&derivation);
6550 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006551 }
6552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6554 &derivation);
6555 if (status != PSA_SUCCESS) {
6556 psa_key_derivation_abort(&derivation);
6557 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006558 }
6559
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 status = psa_key_derivation_output_bytes(&derivation,
6561 handshake->premaster,
6562 handshake->pmslen);
6563 if (status != PSA_SUCCESS) {
6564 psa_key_derivation_abort(&derivation);
6565 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6566 }
6567
6568 status = psa_key_derivation_abort(&derivation);
6569 if (status != PSA_SUCCESS) {
6570 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006571 }
6572 }
6573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6575 lbl, seed, seed_len,
6576 master,
6577 master_secret_len);
6578 if (ret != 0) {
6579 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6580 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006581 }
6582
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6584 handshake->premaster,
6585 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 mbedtls_platform_zeroize(handshake->premaster,
6588 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006589 }
6590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006592}
6593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006595{
6596 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6597 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6598 ssl->handshake->ciphersuite_info;
6599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006601
6602 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006604 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 if (ret != 0) {
6606 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6607 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006608 }
6609
6610 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 ret = ssl_compute_master(ssl->handshake,
6612 ssl->session_negotiate->master,
6613 ssl);
6614 if (ret != 0) {
6615 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6616 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006617 }
6618
6619 /* Swap the client and server random values:
6620 * - MS derivation wanted client+server (RFC 5246 8.1)
6621 * - key derivation wants server+client (RFC 5246 6.3) */
6622 {
6623 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 memcpy(tmp, ssl->handshake->randbytes, 64);
6625 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6626 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6627 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006628 }
6629
6630 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006631 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6632 ssl->session_negotiate->ciphersuite,
6633 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006634#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006636#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 ssl->handshake->tls_prf,
6638 ssl->handshake->randbytes,
6639 ssl->tls_version,
6640 ssl->conf->endpoint,
6641 ssl);
6642 if (ret != 0) {
6643 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6644 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006645 }
6646
6647 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6649 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006654}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006657{
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006659#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006660 case MBEDTLS_SSL_HASH_SHA384:
6661 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6662 break;
6663#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006664#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006665 case MBEDTLS_SSL_HASH_SHA256:
6666 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6667 break;
6668#endif
6669 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006671 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006672#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6673 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006674 (void) ssl;
6675#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006677}
6678
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006679#if defined(MBEDTLS_USE_PSA_CRYPTO)
6680static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6681 const psa_hash_operation_t *hs_op,
6682 size_t buffer_size,
6683 unsigned char *hash,
6684 size_t *hlen)
6685{
6686 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006687 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006688
6689#if !defined(MBEDTLS_DEBUG_C)
6690 (void) ssl;
6691#endif
6692 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006693 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006694 if (status != PSA_SUCCESS) {
6695 goto exit;
6696 }
6697
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006698 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006699 if (status != PSA_SUCCESS) {
6700 goto exit;
6701 }
6702
6703 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6704 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6705
6706exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006707 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006708 return mbedtls_md_error_from_psa(status);
6709}
6710#else
6711static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6712 const mbedtls_md_context_t *hs_ctx,
6713 unsigned char *hash,
6714 size_t *hlen)
6715{
6716 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006717 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006718
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006719 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006720
6721#if !defined(MBEDTLS_DEBUG_C)
6722 (void) ssl;
6723#endif
6724 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6725
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006726 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006727 if (ret != 0) {
6728 goto exit;
6729 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006730 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006731 if (ret != 0) {
6732 goto exit;
6733 }
6734
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006735 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006736 if (ret != 0) {
6737 goto exit;
6738 }
6739
6740 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6741
6742 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6743 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6744
6745exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006746 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006747 return ret;
6748}
6749#endif /* MBEDTLS_USE_PSA_CRYPTO */
6750
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006751#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006752int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6753 unsigned char *hash,
6754 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006755{
6756#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006757 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6758 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006759#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006760 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6761 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006762#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006763}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006764#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006765
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006766#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006767int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6768 unsigned char *hash,
6769 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006770{
6771#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006772 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6773 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006774#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006775 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6776 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006777#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006778}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006779#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006780
Neil Armstrong80f6f322022-05-03 17:56:38 +02006781#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6782 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006783int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006784{
6785 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006787 const unsigned char *psk = NULL;
6788 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006792 /*
6793 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006794 * checked before calling this function.
6795 *
6796 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006797 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006798 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6800 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6801 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006802 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006803 }
6804
6805 /*
6806 * PMS = struct {
6807 * opaque other_secret<0..2^16-1>;
6808 * opaque psk<0..2^16-1>;
6809 * };
6810 * with "other_secret" depending on the particular key exchange
6811 */
6812#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6814 if (end - p < 2) {
6815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6816 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006819 p += 2;
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (end < p || (size_t) (end - p) < psk_len) {
6822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6823 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006826 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006828#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6829#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 /*
6832 * other_secret already set by the ClientKeyExchange message,
6833 * and is 48 bytes long
6834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (end - p < 2) {
6836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6837 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006838
6839 *p++ = 0;
6840 *p++ = 48;
6841 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006843#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6844#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6847 size_t len;
6848
6849 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6851 p + 2, end - (p + 2), &len,
6852 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6853 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6854 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006855 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 p += 2 + len;
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6860 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006861#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006862#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6865 size_t zlen;
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6868 p + 2, end - (p + 2),
6869 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6870 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6871 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006872 }
6873
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006875 p += 2 + zlen;
6876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6878 MBEDTLS_DEBUG_ECDH_Z);
6879 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006880#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006881 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6883 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006884 }
6885
6886 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 if (end - p < 2) {
6888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6889 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006892 p += 2;
6893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 if (end < p || (size_t) (end - p) < psk_len) {
6895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6896 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006899 p += psk_len;
6900
6901 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006904}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006905#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006906
6907#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006908MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006909static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006910
6911#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006912int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006913{
6914 /* If renegotiation is not enforced, retransmit until we would reach max
6915 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006917 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6918 unsigned char doublings = 1;
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006921 ++doublings;
6922 ratio >>= 1;
6923 }
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (++ssl->renego_records_seen > doublings) {
6926 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6927 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006928 }
6929 }
6930
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006932}
6933#endif
6934#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006935
Jerry Yud9526692022-02-17 14:23:47 +08006936/*
6937 * Handshake functions
6938 */
6939#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6940/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006941int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006942{
6943 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6944 ssl->handshake->ciphersuite_info;
6945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6949 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006950 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006952 }
6953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6955 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006956}
6957
Gilles Peskine449bd832023-01-11 14:50:10 +01006958int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006959{
6960 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6961 ssl->handshake->ciphersuite_info;
6962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006964
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6966 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006967 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006969 }
6970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6972 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006973}
6974
6975#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6976/* Some certificate support -> implement write and parse */
6977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006979{
6980 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6981 size_t i, n;
6982 const mbedtls_x509_crt *crt;
6983 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6984 ssl->handshake->ciphersuite_info;
6985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006987
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6989 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006990 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006992 }
6993
6994#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6996 if (ssl->handshake->client_auth == 0) {
6997 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006998 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007000 }
7001 }
7002#endif /* MBEDTLS_SSL_CLI_C */
7003#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7005 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007006 /* Should never happen because we shouldn't have picked the
7007 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007009 }
7010 }
7011#endif
7012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007014
7015 /*
7016 * 0 . 0 handshake type
7017 * 1 . 3 handshake length
7018 * 4 . 6 length of all certs
7019 * 7 . 9 length of cert. 1
7020 * 10 . n-1 peer certificate
7021 * n . n+2 length of cert. 2
7022 * n+3 . ... upper level cert, etc.
7023 */
7024 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007028 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7030 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7031 " > %" MBEDTLS_PRINTF_SIZET,
7032 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7033 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007034 }
7035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7037 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7038 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007039
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007041 i += n; crt = crt->next;
7042 }
7043
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7045 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7046 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007047
7048 ssl->out_msglen = i;
7049 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7050 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7051
7052 ssl->state++;
7053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7055 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7056 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007057 }
7058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007062}
7063
7064#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7065
7066#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007067MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007068static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7069 unsigned char *crt_buf,
7070 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007071{
7072 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 if (peer_crt == NULL) {
7075 return -1;
7076 }
Jerry Yud9526692022-02-17 14:23:47 +08007077
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (peer_crt->raw.len != crt_buf_len) {
7079 return -1;
7080 }
Jerry Yud9526692022-02-17 14:23:47 +08007081
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007083}
7084#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007085MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007086static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7087 unsigned char *crt_buf,
7088 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007089{
7090 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7091 unsigned char const * const peer_cert_digest =
7092 ssl->session->peer_cert_digest;
7093 mbedtls_md_type_t const peer_cert_digest_type =
7094 ssl->session->peer_cert_digest_type;
7095 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007097 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7098 size_t digest_len;
7099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 if (peer_cert_digest == NULL || digest_info == NULL) {
7101 return -1;
7102 }
Jerry Yud9526692022-02-17 14:23:47 +08007103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 digest_len = mbedtls_md_get_size(digest_info);
7105 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7106 return -1;
7107 }
Jerry Yud9526692022-02-17 14:23:47 +08007108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7110 if (ret != 0) {
7111 return -1;
7112 }
Jerry Yud9526692022-02-17 14:23:47 +08007113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007115}
7116#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7117#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7118
7119/*
7120 * Once the certificate message is read, parse it into a cert chain and
7121 * perform basic checks, but leave actual verification to the caller
7122 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007124static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7125 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007126{
7127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7128#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007130#endif
7131 size_t i, n;
7132 uint8_t alert;
7133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7135 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7136 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7137 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7138 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007139 }
7140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7142 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7143 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7144 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007145 }
7146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7148 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7149 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7150 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7151 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007152 }
7153
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007155
7156 /*
7157 * Same message structure as in mbedtls_ssl_write_certificate()
7158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 if (ssl->in_msg[i] != 0 ||
7162 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7163 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7164 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7165 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7166 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007167 }
7168
7169 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7170 i += 3;
7171
7172 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007174 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 if (i + 3 > ssl->in_hslen) {
7176 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7177 mbedtls_ssl_send_alert_message(ssl,
7178 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7179 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7180 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007181 }
7182 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7183 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 if (ssl->in_msg[i] != 0) {
7185 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7186 mbedtls_ssl_send_alert_message(ssl,
7187 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7188 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7189 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007190 }
7191
7192 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007194 | (unsigned int) ssl->in_msg[i + 2];
7195 i += 3;
7196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (n < 128 || i + n > 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
7205 /* Check if we're handling the first CRT in the chain. */
7206#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007208 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007210 /* During client-side renegotiation, check that the server's
7211 * end-CRTs hasn't changed compared to the initial handshake,
7212 * mitigating the triple handshake attack. On success, reuse
7213 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7215 if (ssl_check_peer_crt_unchanged(ssl,
7216 &ssl->in_msg[i],
7217 n) != 0) {
7218 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7219 mbedtls_ssl_send_alert_message(ssl,
7220 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7221 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7222 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007223 }
7224
7225 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007227 }
7228#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7229
7230 /* Parse the next certificate in the chain. */
7231#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007233#else
7234 /* If we don't need to store the CRT chain permanently, parse
7235 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007237#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007239 case 0: /*ok*/
7240 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7241 /* Ignore certificate with an unknown algorithm: maybe a
7242 prior certificate was already trusted. */
7243 break;
7244
7245 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7246 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7247 goto crt_parse_der_failed;
7248
7249 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7250 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7251 goto crt_parse_der_failed;
7252
7253 default:
7254 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007255crt_parse_der_failed:
7256 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7257 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7258 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007259 }
7260
7261 i += n;
7262 }
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7265 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007266}
7267
7268#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007270static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007271{
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7273 return -1;
7274 }
Jerry Yud9526692022-02-17 14:23:47 +08007275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007277 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7278 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7280 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7281 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007282 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007284}
7285#endif /* MBEDTLS_SSL_SRV_C */
7286
7287/* Check if a certificate message is expected.
7288 * Return either
7289 * - SSL_CERTIFICATE_EXPECTED, or
7290 * - SSL_CERTIFICATE_SKIP
7291 * indicating whether a Certificate message is expected or not.
7292 */
7293#define SSL_CERTIFICATE_EXPECTED 0
7294#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007295MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007296static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7297 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007298{
7299 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7300 ssl->handshake->ciphersuite_info;
7301
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7303 return SSL_CERTIFICATE_SKIP;
7304 }
Jerry Yud9526692022-02-17 14:23:47 +08007305
7306#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7308 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7309 return SSL_CERTIFICATE_SKIP;
7310 }
Jerry Yud9526692022-02-17 14:23:47 +08007311
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007313 ssl->session_negotiate->verify_result =
7314 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007316 }
7317 }
7318#else
7319 ((void) authmode);
7320#endif /* MBEDTLS_SSL_SRV_C */
7321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007323}
7324
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007326static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7327 int authmode,
7328 mbedtls_x509_crt *chain,
7329 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007330{
7331 int ret = 0;
7332 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7333 ssl->handshake->ciphersuite_info;
7334 int have_ca_chain = 0;
7335
7336 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7337 void *p_vrfy;
7338
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7340 return 0;
7341 }
Jerry Yud9526692022-02-17 14:23:47 +08007342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (ssl->f_vrfy != NULL) {
7344 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007345 f_vrfy = ssl->f_vrfy;
7346 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 } else {
7348 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007349 f_vrfy = ssl->conf->f_vrfy;
7350 p_vrfy = ssl->conf->p_vrfy;
7351 }
7352
7353 /*
7354 * Main check: verify certificate
7355 */
7356#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007358 ((void) rs_ctx);
7359 have_ca_chain = 1;
7360
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007362 ret = mbedtls_x509_crt_verify_with_ca_cb(
7363 chain,
7364 ssl->conf->f_ca_cb,
7365 ssl->conf->p_ca_cb,
7366 ssl->conf->cert_profile,
7367 ssl->hostname,
7368 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 f_vrfy, p_vrfy);
7370 } else
Jerry Yud9526692022-02-17 14:23:47 +08007371#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7372 {
7373 mbedtls_x509_crt *ca_chain;
7374 mbedtls_x509_crl *ca_crl;
7375
7376#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007378 ca_chain = ssl->handshake->sni_ca_chain;
7379 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 } else
Jerry Yud9526692022-02-17 14:23:47 +08007381#endif
7382 {
7383 ca_chain = ssl->conf->ca_chain;
7384 ca_crl = ssl->conf->ca_crl;
7385 }
7386
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007388 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 }
Jerry Yud9526692022-02-17 14:23:47 +08007390
7391 ret = mbedtls_x509_crt_verify_restartable(
7392 chain,
7393 ca_chain, ca_crl,
7394 ssl->conf->cert_profile,
7395 ssl->hostname,
7396 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007398 }
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (ret != 0) {
7401 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007402 }
7403
7404#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7406 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7407 }
Jerry Yud9526692022-02-17 14:23:47 +08007408#endif
7409
7410 /*
7411 * Secondary checks: always done, but change 'ret' only if it was 0
7412 */
7413
Valerio Settiacd32c02023-06-29 18:06:29 +02007414#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007415 {
7416 const mbedtls_pk_context *pk = &chain->pk;
7417
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007418 /* If certificate uses an EC key, make sure the curve is OK.
7419 * This is a public key, so it can't be opaque, so can_do() is a good
7420 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007422 /* and in the unlikely case the above assumption no longer holds
7423 * we are making sure that pk_ec() here does not return a NULL
7424 */
Valerio Settid0405092023-05-24 13:16:40 +02007425 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7426 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7427 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007429 }
Valerio Setti97207782023-05-18 18:59:06 +02007430 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007431 ssl->session_negotiate->verify_result |=
7432 MBEDTLS_X509_BADCERT_BAD_KEY;
7433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7435 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007436 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007438 }
Jerry Yud9526692022-02-17 14:23:47 +08007439 }
7440 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007441#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 if (mbedtls_ssl_check_cert_usage(chain,
7444 ciphersuite_info,
7445 !ssl->conf->endpoint,
7446 &ssl->session_negotiate->verify_result) != 0) {
7447 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7448 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007449 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 }
Jerry Yud9526692022-02-17 14:23:47 +08007451 }
7452
7453 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7454 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7455 * with details encoded in the verification flags. All other kinds
7456 * of error codes, including those from the user provided f_vrfy
7457 * functions, are treated as fatal and lead to a failure of
7458 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7460 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7461 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007462 ret = 0;
7463 }
7464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7466 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007467 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7468 }
7469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007471 uint8_t alert;
7472
7473 /* The certificate may have been rejected for several reasons.
7474 Pick one and send the corresponding alert. Which alert to send
7475 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007477 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007479 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007481 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007483 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007485 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007487 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007489 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007491 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007493 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007495 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007497 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 }
7499 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7500 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007501 }
7502
7503#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (ssl->session_negotiate->verify_result != 0) {
7505 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7506 (unsigned int) ssl->session_negotiate->verify_result));
7507 } else {
7508 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007509 }
7510#endif /* MBEDTLS_DEBUG_C */
7511
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007513}
7514
7515#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007516MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007517static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7518 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007519{
7520 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7521 /* Remember digest of the peer's end-CRT. */
7522 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7524 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7525 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7526 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7527 mbedtls_ssl_send_alert_message(ssl,
7528 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7529 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007532 }
7533
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 ret = mbedtls_md(mbedtls_md_info_from_type(
7535 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7536 start, len,
7537 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007538
7539 ssl->session_negotiate->peer_cert_digest_type =
7540 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7541 ssl->session_negotiate->peer_cert_digest_len =
7542 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007545}
7546
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007547MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007548static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7549 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007550{
7551 unsigned char *end = start + len;
7552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7553
7554 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7556 ret = mbedtls_pk_parse_subpubkey(&start, end,
7557 &ssl->handshake->peer_pubkey);
7558 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007559 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007561 }
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007564}
7565#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007568{
7569 int ret = 0;
7570 int crt_expected;
7571#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7572 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7573 ? ssl->handshake->sni_authmode
7574 : ssl->conf->authmode;
7575#else
7576 const int authmode = ssl->conf->authmode;
7577#endif
7578 void *rs_ctx = NULL;
7579 mbedtls_x509_crt *chain = NULL;
7580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7584 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7585 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007586 goto exit;
7587 }
7588
7589#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 if (ssl->handshake->ecrs_enabled &&
7591 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007592 chain = ssl->handshake->ecrs_peer_cert;
7593 ssl->handshake->ecrs_peer_cert = NULL;
7594 goto crt_verify;
7595 }
7596#endif
7597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007599 /* mbedtls_ssl_read_record may have sent an alert already. We
7600 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007602 goto exit;
7603 }
7604
7605#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007607 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7608
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007610 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 }
Jerry Yud9526692022-02-17 14:23:47 +08007612
7613 goto exit;
7614 }
7615#endif /* MBEDTLS_SSL_SRV_C */
7616
7617 /* Clear existing peer CRT structure in case we tried to
7618 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007620
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7622 if (chain == NULL) {
7623 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7624 sizeof(mbedtls_x509_crt)));
7625 mbedtls_ssl_send_alert_message(ssl,
7626 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7627 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007628
7629 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7630 goto exit;
7631 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007633
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 ret = ssl_parse_certificate_chain(ssl, chain);
7635 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007636 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
Jerry Yud9526692022-02-17 14:23:47 +08007638
7639#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007641 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 }
Jerry Yud9526692022-02-17 14:23:47 +08007643
7644crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648#endif
7649
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 ret = ssl_parse_certificate_verify(ssl, authmode,
7651 chain, rs_ctx);
7652 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007653 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 }
Jerry Yud9526692022-02-17 14:23:47 +08007655
7656#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7657 {
7658 unsigned char *crt_start, *pk_start;
7659 size_t crt_len, pk_len;
7660
7661 /* We parse the CRT chain without copying, so
7662 * these pointers point into the input buffer,
7663 * and are hence still valid after freeing the
7664 * CRT chain. */
7665
7666 crt_start = chain->raw.p;
7667 crt_len = chain->raw.len;
7668
7669 pk_start = chain->pk_raw.p;
7670 pk_len = chain->pk_raw.len;
7671
7672 /* Free the CRT structures before computing
7673 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 mbedtls_x509_crt_free(chain);
7675 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007676 chain = NULL;
7677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7679 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007680 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 }
Jerry Yud9526692022-02-17 14:23:47 +08007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7684 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007685 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 }
Jerry Yud9526692022-02-17 14:23:47 +08007687 }
7688#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7689 /* Pass ownership to session structure. */
7690 ssl->session_negotiate->peer_cert = chain;
7691 chain = NULL;
7692#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007695
7696exit:
7697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007699 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 }
Jerry Yud9526692022-02-17 14:23:47 +08007701
7702#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007704 ssl->handshake->ecrs_peer_cert = chain;
7705 chain = NULL;
7706 }
7707#endif
7708
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (chain != NULL) {
7710 mbedtls_x509_crt_free(chain);
7711 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007712 }
7713
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007715}
7716#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7717
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007718static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7719 unsigned char *padbuf, size_t hlen,
7720 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007721{
7722 int len = 12;
7723 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007725 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007726 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007727 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007728 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007731 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007732 mbedtls_md_context_t cloned_ctx;
7733 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007734#endif
7735
7736 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007740
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007742 ? "client finished"
7743 : "server finished";
7744
7745#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007746 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007747
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007748 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007750 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007751 }
7752
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007753 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007755 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007756 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007757 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007758#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007759 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007760
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007761 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007762 if (ret != 0) {
7763 goto exit;
7764 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007765 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007766 if (ret != 0) {
7767 goto exit;
7768 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007769
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007770 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007771 if (ret != 0) {
7772 goto exit;
7773 }
7774#endif /* MBEDTLS_USE_PSA_CRYPTO */
7775
7776 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7777
Jerry Yu615bd6f2022-02-17 14:25:15 +08007778 /*
7779 * TLSv1.2:
7780 * hash = PRF( master, finished_label,
7781 * Hash( handshake ) )[0.11]
7782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007784 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007787
Paul Elliottecb95be2023-08-11 16:41:04 +01007788 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007789
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007790 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007791
7792exit:
7793#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007794 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007795 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007796#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007797 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007798 return ret;
7799#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007800}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007801
7802#if defined(MBEDTLS_MD_CAN_SHA256)
7803static int ssl_calc_finished_tls_sha256(
7804 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7805{
7806 unsigned char padbuf[32];
7807 return ssl_calc_finished_tls_generic(ssl,
7808#if defined(MBEDTLS_USE_PSA_CRYPTO)
7809 &ssl->handshake->fin_sha256_psa,
7810#else
7811 &ssl->handshake->fin_sha256,
7812#endif
7813 padbuf, sizeof(padbuf),
7814 buf, from);
7815}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007816#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007817
Jerry Yub7ba49e2022-02-17 14:25:53 +08007818
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007819#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007820static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007822{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007823 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007824 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007825#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007826 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007828 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007829#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007830 padbuf, sizeof(padbuf),
7831 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007832}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007833#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007834
Gilles Peskine449bd832023-01-11 14:50:10 +01007835void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007836{
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007838
7839 /*
7840 * Free our handshake params
7841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 mbedtls_ssl_handshake_free(ssl);
7843 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007844 ssl->handshake = NULL;
7845
7846 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007847 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 if (ssl->transform) {
7850 mbedtls_ssl_transform_free(ssl->transform);
7851 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007852 }
7853 ssl->transform = ssl->transform_negotiate;
7854 ssl->transform_negotiate = NULL;
7855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007857}
7858
Gilles Peskine449bd832023-01-11 14:50:10 +01007859void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007860{
7861 int resume = ssl->handshake->resume;
7862
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007864
7865#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007867 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7868 ssl->renego_records_seen = 0;
7869 }
7870#endif
7871
7872 /*
7873 * Free the previous session and switch in the current one
7874 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007876#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7877 /* RFC 7366 3.1: keep the EtM state */
7878 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007880#endif
7881
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 mbedtls_ssl_session_free(ssl->session);
7883 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007884 }
7885 ssl->session = ssl->session_negotiate;
7886 ssl->session_negotiate = NULL;
7887
7888 /*
7889 * Add cache entry
7890 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007892 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 resume == 0) {
7894 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7895 ssl->session->id,
7896 ssl->session->id_len,
7897 ssl->session) != 0) {
7898 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7899 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007900 }
7901
7902#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7904 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007905 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007907
7908 /* Keep last flight around in case we need to resend it:
7909 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7911 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007912#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007914
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007915 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007916
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007918}
7919
Gilles Peskine449bd832023-01-11 14:50:10 +01007920int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921{
7922 int ret, hash_len;
7923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007927
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007928 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7929 if (ret != 0) {
7930 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7931 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007932
7933 /*
7934 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7935 * may define some other value. Currently (early 2016), no defined
7936 * ciphersuite does this (and this is unlikely to change as activity has
7937 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7938 */
7939 hash_len = 12;
7940
7941#if defined(MBEDTLS_SSL_RENEGOTIATION)
7942 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007944#endif
7945
7946 ssl->out_msglen = 4 + hash_len;
7947 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7948 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7949
7950 /*
7951 * In case of session resuming, invert the client and server
7952 * ChangeCipherSpec messages order.
7953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007955#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007957 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959#endif
7960#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007964#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007966 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007968
7969 /*
7970 * Switch to our negotiated transform and session parameters for outbound
7971 * data.
7972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007974
7975#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977 unsigned char i;
7978
7979 /* Remember current epoch settings for resending */
7980 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7982 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007983
7984 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007986
7987
7988 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 for (i = 2; i > 0; i--) {
7990 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007991 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 }
7993 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007994
7995 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (i == 0) {
7997 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7998 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008003
8004 ssl->transform_out = ssl->transform_negotiate;
8005 ssl->session_out = ssl->session_negotiate;
8006
8007#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8009 mbedtls_ssl_send_flight_completed(ssl);
8010 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008011#endif
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8014 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8015 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016 }
8017
8018#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8020 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8021 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8022 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008023 }
8024#endif
8025
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008029}
8030
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008031#define SSL_MAX_HASH_LEN 12
8032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008034{
8035 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8036 unsigned int hash_len = 12;
8037 unsigned char buf[SSL_MAX_HASH_LEN];
8038
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008040
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008041 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8042 if (ret != 0) {
8043 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8044 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008045
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8047 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008048 goto exit;
8049 }
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8052 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8053 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8054 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008055 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8056 goto exit;
8057 }
8058
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8060 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8061 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008062 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8063 goto exit;
8064 }
8065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8067 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8068 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8069 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008070 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8071 goto exit;
8072 }
8073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8075 buf, hash_len) != 0) {
8076 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8077 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8078 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008079 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8080 goto exit;
8081 }
8082
8083#if defined(MBEDTLS_SSL_RENEGOTIATION)
8084 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008086#endif
8087
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008091 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008093#endif
8094#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008096 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008098#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008100 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008102
8103#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8105 mbedtls_ssl_recv_flight_completed(ssl);
8106 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008107#endif
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008110
8111exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 mbedtls_platform_zeroize(buf, hash_len);
8113 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008114}
8115
Jerry Yu392112c2022-02-17 14:34:10 +08008116#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8117/*
8118 * Helper to get TLS 1.2 PRF from ciphersuite
8119 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8120 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008121static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008122{
Jerry Yu392112c2022-02-17 14:34:10 +08008123 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008125#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8127 return tls_prf_sha384;
8128 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008129#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008130#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008131 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8133 return tls_prf_sha256;
8134 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008135 }
8136#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008137#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8138 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008139 (void) ciphersuite_info;
8140#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008141
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008143}
8144#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008145
Gilles Peskine449bd832023-01-11 14:50:10 +01008146static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008147{
8148 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008149#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 if (tls_prf == tls_prf_sha384) {
8151 return MBEDTLS_SSL_TLS_PRF_SHA384;
8152 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008153#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008154#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 if (tls_prf == tls_prf_sha256) {
8156 return MBEDTLS_SSL_TLS_PRF_SHA256;
8157 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008158#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008160}
8161
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008162/*
8163 * Populate a transform structure with session keys and all the other
8164 * necessary information.
8165 *
8166 * Parameters:
8167 * - [in/out]: transform: structure to populate
8168 * [in] must be just initialised with mbedtls_ssl_transform_init()
8169 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8170 * - [in] ciphersuite
8171 * - [in] master
8172 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008173 * - [in] tls_prf: pointer to PRF to use for key derivation
8174 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008175 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008176 * - [in] endpoint: client or server
8177 * - [in] ssl: used for:
8178 * - ssl->conf->{f,p}_export_keys
8179 * [in] optionally used for:
8180 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8181 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008182MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008183static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8184 int ciphersuite,
8185 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008186#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008188#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 ssl_tls_prf_t tls_prf,
8190 const unsigned char randbytes[64],
8191 mbedtls_ssl_protocol_version tls_version,
8192 unsigned endpoint,
8193 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008194{
8195 int ret = 0;
8196 unsigned char keyblk[256];
8197 unsigned char *key1;
8198 unsigned char *key2;
8199 unsigned char *mac_enc;
8200 unsigned char *mac_dec;
8201 size_t mac_key_len = 0;
8202 size_t iv_copy_len;
8203 size_t keylen;
8204 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008205 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008206#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008207 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008208 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008209#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008210
8211#if defined(MBEDTLS_USE_PSA_CRYPTO)
8212 psa_key_type_t key_type;
8213 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8214 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008215 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008216 size_t key_bits;
8217 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8218#endif
8219
8220#if !defined(MBEDTLS_DEBUG_C) && \
8221 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008223 ssl = NULL; /* make sure we don't use it except for these cases */
8224 (void) ssl;
8225 }
8226#endif
8227
8228 /*
8229 * Some data just needs copying into the structure
8230 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008231#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008233#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008234 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235
8236#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008238#endif
8239
8240#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008242 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8243 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008245 }
8246#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8247
8248 /*
8249 * Get various info structures
8250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8252 if (ciphersuite_info == NULL) {
8253 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8254 ciphersuite));
8255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008256 }
8257
Neil Armstrongab555e02022-04-04 11:07:59 +02008258 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008259#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008261#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008262 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008263
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008265 transform->taglen =
8266 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008268
8269#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008270 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 transform->taglen,
8272 &alg,
8273 &key_type,
8274 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008275 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008277 goto end;
8278 }
8279#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008280 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 if (cipher_info == NULL) {
8282 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8283 ciphersuite_info->cipher));
8284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008286#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008287
Neil Armstronge4512952022-03-08 09:08:22 +01008288#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008289 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008291 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 (unsigned) ciphersuite_info->mac));
8293 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008294 }
8295#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008296 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (md_info == NULL) {
8298 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8299 (unsigned) ciphersuite_info->mac));
8300 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008301 }
Neil Armstronge4512952022-03-08 09:08:22 +01008302#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008303
8304#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8305 /* Copy own and peer's CID if the use of the CID
8306 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8308 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008309
8310 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8312 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8313 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008314
8315 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8317 ssl->handshake->peer_cid_len);
8318 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8319 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008320 }
8321#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8322
8323 /*
8324 * Compute key block using the PRF
8325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8327 if (ret != 0) {
8328 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8329 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008330 }
8331
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8333 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8334 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8335 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8336 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008337
8338 /*
8339 * Determine the appropriate key, IV and MAC length.
8340 */
8341
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008342#if defined(MBEDTLS_USE_PSA_CRYPTO)
8343 keylen = PSA_BITS_TO_BYTES(key_bits);
8344#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008346#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008347
Valerio Settie5707042023-10-11 11:54:42 +02008348#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008350 size_t explicit_ivlen;
8351
8352 transform->maclen = 0;
8353 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008354
8355 /* All modes haves 96-bit IVs, but the length of the static parts vary
8356 * with mode and version:
8357 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8358 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8359 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8360 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8361 * sequence number).
8362 */
8363 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008364
8365 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008366#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008368#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8370 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008371#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008372
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008376 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008378
8379 /* Minimum length of encrypted record */
8380 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8381 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 } else
Valerio Settie5707042023-10-11 11:54:42 +02008383#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008384#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008386 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008388#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008390#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008391 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008392#endif /* MBEDTLS_USE_PSA_CRYPTO */
8393
8394#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008395 /* Get MAC length */
8396 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8397#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8400 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8401 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008402 goto end;
8403 }
8404
8405 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008407#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008408 transform->maclen = mac_key_len;
8409
8410 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008411#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008413#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008414 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008415#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416
8417 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008421 /*
8422 * GenericBlockCipher:
8423 * 1. if EtM is in use: one block plus MAC
8424 * otherwise: * first multiple of blocklen greater than maclen
8425 * 2. IV
8426 */
8427#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008429 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008430 + block_size;
8431 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008432#endif
8433 {
8434 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 + block_size
8436 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437 }
8438
Gilles Peskine449bd832023-01-11 14:50:10 +01008439 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008440 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 } else {
8442 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008443 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8444 goto end;
8445 }
8446 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8449 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8451 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008452 }
8453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8455 (unsigned) keylen,
8456 (unsigned) transform->minlen,
8457 (unsigned) transform->ivlen,
8458 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459
8460 /*
8461 * Finally setup the cipher contexts, IVs and MAC secrets.
8462 */
8463#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008464 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008465 key1 = keyblk + mac_key_len * 2;
8466 key2 = keyblk + mac_key_len * 2 + keylen;
8467
8468 mac_enc = keyblk;
8469 mac_dec = keyblk + mac_key_len;
8470
Gilles Peskine449bd832023-01-11 14:50:10 +01008471 iv_copy_len = (transform->fixed_ivlen) ?
8472 transform->fixed_ivlen : transform->ivlen;
8473 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8474 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8475 iv_copy_len);
8476 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477#endif /* MBEDTLS_SSL_CLI_C */
8478#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008479 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008480 key1 = keyblk + mac_key_len * 2 + keylen;
8481 key2 = keyblk + mac_key_len * 2;
8482
8483 mac_enc = keyblk + mac_key_len;
8484 mac_dec = keyblk;
8485
Gilles Peskine449bd832023-01-11 14:50:10 +01008486 iv_copy_len = (transform->fixed_ivlen) ?
8487 transform->fixed_ivlen : transform->ivlen;
8488 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8489 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8490 iv_copy_len);
8491 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008492#endif /* MBEDTLS_SSL_SRV_C */
8493 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008495 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8496 goto end;
8497 }
8498
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 if (ssl != NULL && ssl->f_export_keys != NULL) {
8500 ssl->f_export_keys(ssl->p_export_keys,
8501 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8502 master, 48,
8503 randbytes + 32,
8504 randbytes,
8505 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008506 }
8507
8508#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509 transform->psa_alg = alg;
8510
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8512 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8513 psa_set_key_algorithm(&attributes, alg);
8514 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 if ((status = psa_import_key(&attributes,
8517 key1,
8518 PSA_BITS_TO_BYTES(key_bits),
8519 &transform->psa_key_enc)) != PSA_SUCCESS) {
8520 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008521 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008523 goto end;
8524 }
8525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 if ((status = psa_import_key(&attributes,
8529 key2,
8530 PSA_BITS_TO_BYTES(key_bits),
8531 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008532 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008534 goto end;
8535 }
8536 }
8537#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8539 cipher_info)) != 0) {
8540 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008541 goto end;
8542 }
8543
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8545 cipher_info)) != 0) {
8546 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008547 goto end;
8548 }
8549
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8551 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8552 MBEDTLS_ENCRYPT)) != 0) {
8553 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008554 goto end;
8555 }
8556
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8558 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8559 MBEDTLS_DECRYPT)) != 0) {
8560 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008561 goto end;
8562 }
8563
8564#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8566 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8567 MBEDTLS_PADDING_NONE)) != 0) {
8568 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", 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_set_padding_mode(&transform->cipher_ctx_dec,
8573 MBEDTLS_PADDING_NONE)) != 0) {
8574 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008575 goto end;
8576 }
8577 }
8578#endif /* MBEDTLS_CIPHER_MODE_CBC */
8579#endif /* MBEDTLS_USE_PSA_CRYPTO */
8580
Neil Armstrong29c0c042022-03-17 17:47:28 +01008581#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8582 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8583 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008585#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8589 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8590 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 if ((status = psa_import_key(&attributes,
8593 mac_enc, mac_key_len,
8594 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008595 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008597 goto end;
8598 }
8599
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8601 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008602#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008604#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008606 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8608 PSA_KEY_USAGE_VERIFY_HASH);
8609 } else {
8610 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8611 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008612
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if ((status = psa_import_key(&attributes,
8614 mac_dec, mac_key_len,
8615 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008616 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008617 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008618 goto end;
8619 }
8620#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8622 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008623 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008624 }
8625 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8626 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008627 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008629#endif /* MBEDTLS_USE_PSA_CRYPTO */
8630 }
8631#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8632
8633 ((void) mac_dec);
8634 ((void) mac_enc);
8635
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008636end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8638 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008639}
8640
Valerio Settia08b1a42022-11-17 15:10:02 +01008641#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8642 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008643int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 psa_pake_operation_t *pake_ctx,
8645 const unsigned char *buf,
8646 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008647{
8648 psa_status_t status;
8649 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008650 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008651 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8652 * At round two perform a single cycle
8653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 for (; remaining_steps > 0; remaining_steps--) {
8657 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008658 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008660 /* Length is stored at the first byte */
8661 size_t length = buf[input_offset];
8662 input_offset += 1;
8663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008665 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8666 }
8667
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 status = psa_pake_input(pake_ctx, step,
8669 buf + input_offset, length);
8670 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008671 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008672 }
8673
8674 input_offset += length;
8675 }
8676 }
8677
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008679 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008681
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008683}
8684
Valerio Setti6b3dab02022-11-17 17:14:54 +01008685int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 psa_pake_operation_t *pake_ctx,
8687 unsigned char *buf,
8688 size_t len, size_t *olen,
8689 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008690{
8691 psa_status_t status;
8692 size_t output_offset = 0;
8693 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008694 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008695 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8696 * At round two perform a single cycle
8697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 for (; remaining_steps > 0; remaining_steps--) {
8701 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8702 step <= PSA_PAKE_STEP_ZK_PROOF;
8703 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008704 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008705 * For each step, prepend 1 byte with the length of the data as
8706 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 status = psa_pake_output(pake_ctx, step,
8709 buf + output_offset + 1,
8710 len - output_offset - 1,
8711 &output_len);
8712 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008713 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008714 }
8715
Valerio Setti99d88c12022-11-22 16:03:43 +01008716 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008717
8718 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008719 }
8720 }
8721
8722 *olen = output_offset;
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008725}
Valerio Settia08b1a42022-11-17 15:10:02 +01008726#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8727
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008729int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8730 unsigned char *hash, size_t *hashlen,
8731 unsigned char *data, size_t data_len,
8732 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008733{
8734 psa_status_t status;
8735 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008736 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008737
Gilles Peskine449bd832023-01-11 14:50:10 +01008738 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008739
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if ((status = psa_hash_setup(&hash_operation,
8741 hash_alg)) != PSA_SUCCESS) {
8742 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008743 goto exit;
8744 }
8745
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8747 64)) != PSA_SUCCESS) {
8748 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008749 goto exit;
8750 }
8751
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 if ((status = psa_hash_update(&hash_operation,
8753 data, data_len)) != PSA_SUCCESS) {
8754 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755 goto exit;
8756 }
8757
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8759 hashlen)) != PSA_SUCCESS) {
8760 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8761 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008762 }
8763
8764exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 if (status != PSA_SUCCESS) {
8766 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8767 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8768 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008769 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8772 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008774 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778 }
8779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781}
8782
8783#else
8784
Gilles Peskine449bd832023-01-11 14:50:10 +01008785int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8786 unsigned char *hash, size_t *hashlen,
8787 unsigned char *data, size_t data_len,
8788 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008789{
8790 int ret = 0;
8791 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8793 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008794
Gilles Peskine449bd832023-01-11 14:50:10 +01008795 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008796
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798
8799 /*
8800 * digitally-signed struct {
8801 * opaque client_random[32];
8802 * opaque server_random[32];
8803 * ServerDHParams params;
8804 * };
8805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8807 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008808 goto exit;
8809 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8811 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008812 goto exit;
8813 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8815 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816 goto exit;
8817 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8819 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008820 goto exit;
8821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008822 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8823 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008824 goto exit;
8825 }
8826
8827exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008829
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 if (ret != 0) {
8831 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8832 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8833 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008836}
8837#endif /* MBEDTLS_USE_PSA_CRYPTO */
8838
Jerry Yud9d91da2022-02-17 14:57:06 +08008839#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8840
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008841/* Find the preferred hash for a given signature algorithm. */
8842unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 mbedtls_ssl_context *ssl,
8844 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008845{
Gabor Mezei078e8032022-04-27 21:17:56 +02008846 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008847 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008848
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8850 return MBEDTLS_SSL_HASH_NONE;
8851 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008852
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008854 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8856 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008857 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8859 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008860
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008861 mbedtls_md_type_t md_alg =
8862 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8863 if (md_alg == MBEDTLS_MD_NONE) {
8864 continue;
8865 }
8866
Gilles Peskine449bd832023-01-11 14:50:10 +01008867 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008868#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008870 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008871 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008872
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8874 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8875 PSA_ALG_ECDSA(psa_hash_alg),
8876 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008877 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008879
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8881 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8882 PSA_ALG_RSA_PKCS1V15_SIGN(
8883 psa_hash_alg),
8884 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008885 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008886 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008887 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008888#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008889
Gilles Peskine449bd832023-01-11 14:50:10 +01008890 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008891 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008892 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008893
Gilles Peskine449bd832023-01-11 14:50:10 +01008894 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008895}
8896
8897#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8898
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008899/* Serialization of TLS 1.2 sessions:
8900 *
8901 * struct {
8902 * uint64 start_time;
8903 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904 * uint8 session_id_len; // at most 32
8905 * opaque session_id[32];
8906 * opaque master[48]; // fixed length in the standard
8907 * uint32 verify_result;
8908 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8909 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8910 * uint32 ticket_lifetime;
8911 * uint8 mfl_code; // up to 255 according to standard
8912 * uint8 encrypt_then_mac; // 0 or 1
8913 * } serialized_session_tls12;
8914 *
8915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008916static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8917 unsigned char *buf,
8918 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008919{
8920 unsigned char *p = buf;
8921 size_t used = 0;
8922
8923#if defined(MBEDTLS_HAVE_TIME)
8924 uint64_t start;
8925#endif
8926#if defined(MBEDTLS_X509_CRT_PARSE_C)
8927#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8928 size_t cert_len;
8929#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8930#endif /* MBEDTLS_X509_CRT_PARSE_C */
8931
8932 /*
8933 * Time
8934 */
8935#if defined(MBEDTLS_HAVE_TIME)
8936 used += 8;
8937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008939 start = (uint64_t) session->start;
8940
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942 p += 8;
8943 }
8944#endif /* MBEDTLS_HAVE_TIME */
8945
8946 /*
8947 * Basic mandatory fields
8948 */
8949 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 + 1 /* id_len */
8951 + sizeof(session->id)
8952 + sizeof(session->master)
8953 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008954
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 if (used <= buf_len) {
8956 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957 p += 2;
8958
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 *p++ = MBEDTLS_BYTE_0(session->id_len);
8960 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008961 p += 32;
8962
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008964 p += 48;
8965
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008967 p += 4;
8968 }
8969
8970 /*
8971 * Peer's end-entity certificate
8972 */
8973#if defined(MBEDTLS_X509_CRT_PARSE_C)
8974#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008977 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008978 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980
8981 used += 3 + cert_len;
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 if (used <= buf_len) {
8984 *p++ = MBEDTLS_BYTE_2(cert_len);
8985 *p++ = MBEDTLS_BYTE_1(cert_len);
8986 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008987
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 if (session->peer_cert != NULL) {
8989 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990 p += cert_len;
8991 }
8992 }
8993#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008995 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008996 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008997 *p++ = (unsigned char) session->peer_cert_digest_type;
8998 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 memcpy(p, session->peer_cert_digest,
9000 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001 p += session->peer_cert_digest_len;
9002 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009004 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009006 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9007 *p++ = 0;
9008 }
9009 }
9010#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9011#endif /* MBEDTLS_X509_CRT_PARSE_C */
9012
9013 /*
9014 * Session ticket if any, plus associated data
9015 */
9016#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9017 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
9020 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9021 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9022 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (session->ticket != NULL) {
9025 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009026 p += session->ticket_len;
9027 }
9028
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009030 p += 4;
9031 }
9032#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9033
9034 /*
9035 * Misc extension-related info
9036 */
9037#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9038 used += 1;
9039
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009043#endif
9044
9045#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9046 used += 1;
9047
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 if (used <= buf_len) {
9049 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9050 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009051#endif
9052
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009054}
9055
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009056MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009057static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9058 const unsigned char *buf,
9059 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009060{
9061#if defined(MBEDTLS_HAVE_TIME)
9062 uint64_t start;
9063#endif
9064#if defined(MBEDTLS_X509_CRT_PARSE_C)
9065#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9066 size_t cert_len;
9067#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9068#endif /* MBEDTLS_X509_CRT_PARSE_C */
9069
9070 const unsigned char *p = buf;
9071 const unsigned char * const end = buf + len;
9072
9073 /*
9074 * Time
9075 */
9076#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 if (8 > (size_t) (end - p)) {
9078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9079 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009080
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009081 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009082 p += 8;
9083
9084 session->start = (time_t) start;
9085#endif /* MBEDTLS_HAVE_TIME */
9086
9087 /*
9088 * Basic mandatory fields
9089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9092 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009093
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095 p += 2;
9096
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009097 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009099 p += 32;
9100
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102 p += 48;
9103
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009104 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009105 p += 4;
9106
9107 /* Immediately clear invalid pointer values that have been read, in case
9108 * we exit early before we replaced them with valid ones. */
9109#if defined(MBEDTLS_X509_CRT_PARSE_C)
9110#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9111 session->peer_cert = NULL;
9112#else
9113 session->peer_cert_digest = NULL;
9114#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9115#endif /* MBEDTLS_X509_CRT_PARSE_C */
9116#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9117 session->ticket = NULL;
9118#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9119
9120 /*
9121 * Peer certificate
9122 */
9123#if defined(MBEDTLS_X509_CRT_PARSE_C)
9124#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9125 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009126 if (3 > (size_t) (end - p)) {
9127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9128 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009131 p += 3;
9132
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9135
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 if (cert_len > (size_t) (end - p)) {
9137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9138 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139
Gilles Peskine449bd832023-01-11 14:50:10 +01009140 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009141
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 if (session->peer_cert == NULL) {
9143 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9144 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009145
Gilles Peskine449bd832023-01-11 14:50:10 +01009146 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009147
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9149 p, cert_len)) != 0) {
9150 mbedtls_x509_crt_free(session->peer_cert);
9151 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009152 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009154 }
9155
9156 p += cert_len;
9157 }
9158#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9159 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009160 if (2 > (size_t) (end - p)) {
9161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9162 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163
9164 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9165 session->peer_cert_digest_len = (size_t) *p++;
9166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9170 if (md_info == NULL) {
9171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9172 }
9173 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9175 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9179 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
9181 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 mbedtls_calloc(1, session->peer_cert_digest_len);
9183 if (session->peer_cert_digest == NULL) {
9184 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9185 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009186
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 memcpy(session->peer_cert_digest, p,
9188 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189 p += session->peer_cert_digest_len;
9190 }
9191#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9192#endif /* MBEDTLS_X509_CRT_PARSE_C */
9193
9194 /*
9195 * Session ticket and associated data
9196 */
9197#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if (3 > (size_t) (end - p)) {
9199 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9200 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009203 p += 3;
9204
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 if (session->ticket_len != 0) {
9206 if (session->ticket_len > (size_t) (end - p)) {
9207 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9208 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 session->ticket = mbedtls_calloc(1, session->ticket_len);
9211 if (session->ticket == NULL) {
9212 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9213 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009214
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009216 p += session->ticket_len;
9217 }
9218
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 if (4 > (size_t) (end - p)) {
9220 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9221 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009222
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009223 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224 p += 4;
9225#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9226
9227 /*
9228 * Misc extension-related info
9229 */
9230#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if (1 > (size_t) (end - p)) {
9232 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9233 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009234
9235 session->mfl_code = *p++;
9236#endif
9237
9238#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 if (1 > (size_t) (end - p)) {
9240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9241 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009242
9243 session->encrypt_then_mac = *p++;
9244#endif
9245
9246 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 if (p != end) {
9248 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9249 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009250
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009252}
Jerry Yudc7bd172022-02-17 13:44:15 +08009253#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9254
XiaokangQian75d40ef2022-04-20 11:05:24 +00009255int mbedtls_ssl_validate_ciphersuite(
9256 const mbedtls_ssl_context *ssl,
9257 const mbedtls_ssl_ciphersuite_t *suite_info,
9258 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009260{
9261 (void) ssl;
9262
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 if (suite_info == NULL) {
9264 return -1;
9265 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009266
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 if ((suite_info->min_tls_version > max_tls_version) ||
9268 (suite_info->max_tls_version < min_tls_version)) {
9269 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009270 }
9271
XiaokangQian060d8672022-04-21 09:24:56 +00009272#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009273#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009274#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009275 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9276 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009277#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9279 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009280#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009281 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009282 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009283 }
9284#endif
9285
9286 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9287#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9289 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9290 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009291 }
9292#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9293#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9294
Gilles Peskine449bd832023-01-11 14:50:10 +01009295 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009296}
9297
Ronald Crone68ab4f2022-10-05 12:46:29 +02009298#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009299/*
9300 * Function for writing a signature algorithm extension.
9301 *
9302 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9303 * value (TLS 1.3 RFC8446):
9304 * enum {
9305 * ....
9306 * ecdsa_secp256r1_sha256( 0x0403 ),
9307 * ecdsa_secp384r1_sha384( 0x0503 ),
9308 * ecdsa_secp521r1_sha512( 0x0603 ),
9309 * ....
9310 * } SignatureScheme;
9311 *
9312 * struct {
9313 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9314 * } SignatureSchemeList;
9315 *
9316 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9317 * value (TLS 1.2 RFC5246):
9318 * enum {
9319 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9320 * sha512(6), (255)
9321 * } HashAlgorithm;
9322 *
9323 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9324 * SignatureAlgorithm;
9325 *
9326 * struct {
9327 * HashAlgorithm hash;
9328 * SignatureAlgorithm signature;
9329 * } SignatureAndHashAlgorithm;
9330 *
9331 * SignatureAndHashAlgorithm
9332 * supported_signature_algorithms<2..2^16-2>;
9333 *
9334 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9335 * generalization of the TLS 1.2 signature algorithm extension.
9336 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9337 * `SignatureScheme` field of TLS 1.3
9338 *
9339 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009340int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9341 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009342{
9343 unsigned char *p = buf;
9344 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9345 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9346
9347 *out_len = 0;
9348
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009350
9351 /* Check if we have space for header and length field:
9352 * - extension_type (2 bytes)
9353 * - extension_data_length (2 bytes)
9354 * - supported_signature_algorithms_length (2 bytes)
9355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009357 p += 6;
9358
9359 /*
9360 * Write supported_signature_algorithms
9361 */
9362 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009363 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9364 if (sig_alg == NULL) {
9365 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9366 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009367
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9369 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9370 *sig_alg,
9371 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9372 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009373 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009374 }
9375 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9376 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009377 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9379 *sig_alg,
9380 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009381 }
9382
9383 /* Length of supported_signature_algorithms */
9384 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 if (supported_sig_alg_len == 0) {
9386 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9387 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009388 }
9389
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9391 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9392 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009393
XiaokangQianeaf36512022-04-24 09:07:44 +00009394 *out_len = p - buf;
9395
9396#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009397 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009398#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009399
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009401}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009402#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009403
XiaokangQian40a35232022-05-07 09:02:40 +00009404#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009405/*
9406 * mbedtls_ssl_parse_server_name_ext
9407 *
9408 * Structure of server_name extension:
9409 *
9410 * enum {
9411 * host_name(0), (255)
9412 * } NameType;
9413 * opaque HostName<1..2^16-1>;
9414 *
9415 * struct {
9416 * NameType name_type;
9417 * select (name_type) {
9418 * case host_name: HostName;
9419 * } name;
9420 * } ServerName;
9421 * struct {
9422 * ServerName server_name_list<1..2^16-1>
9423 * } ServerNameList;
9424 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009426int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9427 const unsigned char *buf,
9428 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009429{
9430 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9431 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009432 size_t server_name_list_len, hostname_len;
9433 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009434
Gilles Peskine449bd832023-01-11 14:50:10 +01009435 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009436
Gilles Peskine449bd832023-01-11 14:50:10 +01009437 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9438 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009439 p += 2;
9440
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009442 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 while (p < server_name_list_end) {
9444 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9445 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9446 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9447 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009448
Gilles Peskine449bd832023-01-11 14:50:10 +01009449 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009450 /* sni_name is intended to be used only during the parsing of the
9451 * ClientHello message (it is reset to NULL before the end of
9452 * the message parsing). Thus it is ok to just point to the
9453 * reception buffer and not make a copy of it.
9454 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009455 ssl->handshake->sni_name = p + 3;
9456 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 if (ssl->conf->f_sni == NULL) {
9458 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009459 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9461 ssl, p + 3, hostname_len);
9462 if (ret != 0) {
9463 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9464 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9465 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9466 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9467 }
9468 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009469 }
9470
9471 p += hostname_len + 3;
9472 }
9473
Gilles Peskine449bd832023-01-11 14:50:10 +01009474 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009475}
9476#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9477
XiaokangQianacb39922022-06-17 10:18:48 +00009478#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009479MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009480int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9481 const unsigned char *buf,
9482 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009483{
9484 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009485 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009486 const unsigned char *protocol_name_list;
9487 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009488 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009489
9490 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 if (ssl->conf->alpn_list == NULL) {
9492 return 0;
9493 }
XiaokangQianacb39922022-06-17 10:18:48 +00009494
9495 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009496 * RFC7301, section 3.1
9497 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009498 *
XiaokangQianc7403452022-06-23 03:24:12 +00009499 * struct {
9500 * ProtocolName protocol_name_list<2..2^16-1>
9501 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009502 */
9503
XiaokangQianc7403452022-06-23 03:24:12 +00009504 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009505 * protocol_name_list_len 2 bytes
9506 * protocol_name_len 1 bytes
9507 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009509 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009510
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009512 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009514 protocol_name_list = p;
9515 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009516
9517 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009519 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9521 protocol_name_len);
9522 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009523 MBEDTLS_SSL_PEND_FATAL_ALERT(
9524 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9526 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009527 }
9528
9529 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009530 }
9531
9532 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9534 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009535 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009537 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 if (protocol_name_len == alpn_len &&
9539 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009540 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009542 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009543
9544 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009545 }
9546 }
9547
XiaokangQian95d5f542022-06-24 02:29:26 +00009548 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009549 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9551 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9552 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009553}
9554
Gilles Peskine449bd832023-01-11 14:50:10 +01009555int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9556 unsigned char *buf,
9557 unsigned char *end,
9558 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009559{
9560 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009561 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009562 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009563
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 if (ssl->alpn_chosen == NULL) {
9565 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009566 }
9567
Gilles Peskine449bd832023-01-11 14:50:10 +01009568 protocol_name_len = strlen(ssl->alpn_chosen);
9569 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009570
Gilles Peskine449bd832023-01-11 14:50:10 +01009571 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009572 /*
9573 * 0 . 1 ext identifier
9574 * 2 . 3 ext length
9575 * 4 . 5 protocol list length
9576 * 6 . 6 protocol name length
9577 * 7 . 7+n protocol name
9578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009579 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009580
XiaokangQian95d5f542022-06-24 02:29:26 +00009581 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009582
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9584 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009585 /* Note: the length of the chosen protocol has been checked to be less
9586 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009588 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009589
Gilles Peskine449bd832023-01-11 14:50:10 +01009590 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009591
9592#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009594#endif
9595
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009597}
9598#endif /* MBEDTLS_SSL_ALPN */
9599
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009600#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009601 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009602 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009603 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009604int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9605 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009606{
9607 /* Initialize to suppress unnecessary compiler warning */
9608 size_t hostname_len = 0;
9609
9610 /* Check if new hostname is valid before
9611 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 if (hostname != NULL) {
9613 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9617 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009618 }
9619
9620 /* Now it's clear that we will overwrite the old hostname,
9621 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009622 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009623 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009624 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009625 }
9626
9627 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009628 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009629 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 } else {
9631 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9632 if (session->hostname == NULL) {
9633 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9634 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009635
Gilles Peskine449bd832023-01-11 14:50:10 +01009636 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009637 }
9638
Gilles Peskine449bd832023-01-11 14:50:10 +01009639 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009640}
Xiaokang Qian03409292022-10-12 02:49:52 +00009641#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9642 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009643 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009644 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009646#endif /* MBEDTLS_SSL_TLS_C */