blob: 02e828e58c8f85fa8b0dbd8e0fa0ce12b1fbeea3 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800309 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Jerry Yu525990f2023-11-15 14:51:18 +08001103#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
1104 ssl->session_negotiate->max_early_data_size = ssl->conf->max_early_data_size;
1105#endif
Paul Bakker968afaa2014-07-09 11:09:24 +02001106
Jerry Yu2e199812022-12-01 18:57:19 +08001107#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001109#endif
1110
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001111 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001112 ret = mbedtls_ssl_reset_checksum(ssl);
1113 if (ret != 0) {
1114 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1115 return ret;
1116 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001117
Jerry Yud0766ec2022-09-22 10:46:57 +08001118#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1119 defined(MBEDTLS_SSL_SRV_C) && \
1120 defined(MBEDTLS_SSL_SESSION_TICKETS)
1121 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001123#endif
1124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001130 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001132 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001136 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001137#endif
1138
Brett Warrene0edc842021-08-17 09:53:13 +01001139/*
1140 * curve_list is translated to IANA TLS group identifiers here because
1141 * mbedtls_ssl_conf_curves returns void and so can't return
1142 * any error codes.
1143 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001144#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001145#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1146 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001148 size_t length;
1149 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1150
Thomas Daubney850a0792023-05-22 12:05:03 +01001151 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Brett Warrene0edc842021-08-17 09:53:13 +01001153
1154 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1156 if (group_list == NULL) {
1157 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1158 }
Brett Warrene0edc842021-08-17 09:53:13 +01001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001161 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 curve_list[i]);
1163 if (tls_id == 0) {
1164 mbedtls_free(group_list);
1165 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001166 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001167 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001168 }
1169
1170 group_list[length] = 0;
1171
1172 ssl->handshake->group_list = group_list;
1173 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001175 ssl->handshake->group_list = ssl->conf->group_list;
1176 ssl->handshake->group_list_heap_allocated = 0;
1177 }
1178#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001179#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001180
Ronald Crone68ab4f2022-10-05 12:46:29 +02001181#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001182#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001183#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001184 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1185 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1187 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 const int *md;
1189 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001190 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001191 uint16_t *p;
1192
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001193 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1194 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1195 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001196
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1198 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001199 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001201#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001203#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001204
Jerry Yub476a442022-01-21 18:14:45 +08001205#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001207#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1209 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1210 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001211 }
1212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1214 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1215 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1218 sizeof(uint16_t));
1219 if (ssl->handshake->sig_algs == NULL) {
1220 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1221 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 p = (uint16_t *) ssl->handshake->sig_algs;
1224 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1225 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1226 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001227 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001229#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001231 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001232#endif
1233#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001235 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001236#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001237 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001238 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001241#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001242 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001243 ssl->handshake->sig_algs_heap_allocated = 0;
1244 }
Jerry Yucc539102022-06-27 16:27:35 +08001245#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001246#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001248}
1249
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001250#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001251/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001252MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001253static int ssl_cookie_write_dummy(void *ctx,
1254 unsigned char **p, unsigned char *end,
1255 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001256{
1257 ((void) ctx);
1258 ((void) p);
1259 ((void) end);
1260 ((void) cli_id);
1261 ((void) cli_id_len);
1262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001264}
1265
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001266MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001267static int ssl_cookie_check_dummy(void *ctx,
1268 const unsigned char *cookie, size_t cookie_len,
1269 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001270{
1271 ((void) ctx);
1272 ((void) cookie);
1273 ((void) cookie_len);
1274 ((void) cli_id);
1275 ((void) cli_id_len);
1276
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001278}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001279#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001280
Paul Bakker5121ce52009-01-03 21:22:43 +00001281/*
1282 * Initialize an SSL context
1283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001284void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001285{
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001287}
1288
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001289MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001290static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001291{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001292 const mbedtls_ssl_config *conf = ssl->conf;
1293
Ronald Cron6f135e12021-12-08 16:57:54 +01001294#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1296 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1297 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1298 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001299 }
1300
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1302 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001303 }
1304#endif
1305
1306#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1308 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1309 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001310 }
1311#endif
1312
Ronald Cron6f135e12021-12-08 16:57:54 +01001313#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1315 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1316 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001318 }
1319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1321 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001322 }
1323#endif
1324
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1326 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001327}
1328
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001329MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001330static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1331{
1332 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 ret = ssl_conf_version_check(ssl);
1334 if (ret != 0) {
1335 return ret;
1336 }
Jerry Yu60835a82021-08-04 10:13:52 +08001337
Jerry Yudef7ae42022-10-30 14:13:19 +08001338#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1339 /* RFC 8446 section 4.4.3
1340 *
1341 * If the verification fails, the receiver MUST terminate the handshake with
1342 * a "decrypt_error" alert.
1343 *
1344 * If the client is configured as TLS 1.3 only with optional verify, return
1345 * bad config.
1346 *
1347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1349 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001350 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1351 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1352 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001354 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 1, ("Optional verify auth mode "
1356 "is not available for TLS 1.3 client"));
1357 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001358 }
1359#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1360
Jerry Yu60835a82021-08-04 10:13:52 +08001361 /* Space for further checks */
1362
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001364}
1365
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001366/*
1367 * Setup an SSL context
1368 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1371 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001372{
Janos Follath865b3eb2019-12-16 11:46:15 +00001373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001374 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1375 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001377 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 if ((ret = ssl_conf_check(ssl)) != 0) {
1380 return ret;
1381 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001382 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001383
Paul Bakker62f2dee2012-09-28 07:31:51 +00001384 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001385 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001387
1388 /* Set to NULL in case of an error condition */
1389 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001390
Darryl Greenb33cc762019-11-28 14:29:44 +00001391#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1392 ssl->in_buf_len = in_buf_len;
1393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1395 if (ssl->in_buf == NULL) {
1396 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001397 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001398 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001399 }
1400
Darryl Greenb33cc762019-11-28 14:29:44 +00001401#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1402 ssl->out_buf_len = out_buf_len;
1403#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1405 if (ssl->out_buf == NULL) {
1406 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001407 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001408 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 }
1410
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001412
Johan Pascalb62bb512015-12-03 21:56:45 +01001413#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001415#endif
1416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001418 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001422
1423error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 mbedtls_free(ssl->in_buf);
1425 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001426
1427 ssl->conf = NULL;
1428
Darryl Greenb33cc762019-11-28 14:29:44 +00001429#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1430 ssl->in_buf_len = 0;
1431 ssl->out_buf_len = 0;
1432#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001433 ssl->in_buf = NULL;
1434 ssl->out_buf = NULL;
1435
1436 ssl->in_hdr = NULL;
1437 ssl->in_ctr = NULL;
1438 ssl->in_len = NULL;
1439 ssl->in_iv = NULL;
1440 ssl->in_msg = NULL;
1441
1442 ssl->out_hdr = NULL;
1443 ssl->out_ctr = NULL;
1444 ssl->out_len = NULL;
1445 ssl->out_iv = NULL;
1446 ssl->out_msg = NULL;
1447
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001449}
1450
1451/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001452 * Reset an initialized and used SSL context for re-use while retaining
1453 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001454 *
1455 * If partial is non-zero, keep data in the input buffer and client ID.
1456 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001458void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1459 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460{
Darryl Greenb33cc762019-11-28 14:29:44 +00001461#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1462 size_t in_buf_len = ssl->in_buf_len;
1463 size_t out_buf_len = ssl->out_buf_len;
1464#else
1465 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1466 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1467#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001468
Hanno Beckerb0302c42021-08-03 09:39:42 +01001469#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1470 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001471#endif
1472
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001473 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001477
1478 /* Reset incoming message parsing */
1479 ssl->in_offt = NULL;
1480 ssl->nb_zero = 0;
1481 ssl->in_msgtype = 0;
1482 ssl->in_msglen = 0;
1483 ssl->in_hslen = 0;
1484 ssl->keep_current_message = 0;
1485 ssl->transform_in = NULL;
1486
1487#if defined(MBEDTLS_SSL_PROTO_DTLS)
1488 ssl->next_record_offset = 0;
1489 ssl->in_epoch = 0;
1490#endif
1491
1492 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001494 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001496 }
1497
Ronald Cronad8c17b2022-06-10 17:18:09 +02001498 ssl->send_alert = 0;
1499
Hanno Beckerb0302c42021-08-03 09:39:42 +01001500 /* Reset outgoing message writing */
1501 ssl->out_msgtype = 0;
1502 ssl->out_msglen = 0;
1503 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->out_buf, 0, out_buf_len);
1505 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001506 ssl->transform_out = NULL;
1507
1508#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001510#endif
1511
XiaokangQian2b01dc32022-01-21 02:53:13 +00001512#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (ssl->transform) {
1514 mbedtls_ssl_transform_free(ssl->transform);
1515 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001516 ssl->transform = NULL;
1517 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001518#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1519
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 mbedtls_ssl_transform_free(ssl->transform_application);
1522 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001523 ssl->transform_application = NULL;
1524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001526#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1528 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001530#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1533 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534 ssl->handshake->transform_handshake = NULL;
1535 }
1536
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538}
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001541{
1542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1543
1544 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547
1548 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#if defined(MBEDTLS_SSL_RENEGOTIATION)
1550 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001551 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001552
1553 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1555 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001556#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001558
Hanno Beckerb0302c42021-08-03 09:39:42 +01001559 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001560 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 if (ssl->session) {
1562 mbedtls_ssl_session_free(ssl->session);
1563 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001564 ssl->session = NULL;
1565 }
1566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001568 ssl->alpn_chosen = NULL;
1569#endif
1570
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001571#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001572 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001573#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001575#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 if (free_cli_id) {
1577 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001578 ssl->cli_id = NULL;
1579 ssl->cli_id_len = 0;
1580 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001581#endif
1582
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 if ((ret = ssl_handshake_init(ssl)) != 0) {
1584 return ret;
1585 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001588}
1589
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001590/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001591 * Reset an initialized and used SSL context for re-use while retaining
1592 * all application-set variables, function pointers and data.
1593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001594int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001595{
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001597}
1598
1599/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001600 * SSL set accessors
1601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001603{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001604 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001605}
1606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001608{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001609 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001610}
1611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001613void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001614{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001615 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001616}
1617#endif
1618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001621 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1627 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001628{
1629 ssl->disable_datagram_packing = !allow_packing;
1630}
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1633 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001635 conf->hs_timeout_min = min;
1636 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001637}
1638#endif
1639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001641{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001642 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001643}
1644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001646void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1647 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1648 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001650 conf->f_vrfy = f_vrfy;
1651 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001652}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1656 int (*f_rng)(void *, unsigned char *, size_t),
1657 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001658{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001659 conf->f_rng = f_rng;
1660 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001661}
1662
Gilles Peskine449bd832023-01-11 14:50:10 +01001663void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1664 void (*f_dbg)(void *, int, const char *, int, const char *),
1665 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001667 conf->f_dbg = f_dbg;
1668 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1672 void *p_bio,
1673 mbedtls_ssl_send_t *f_send,
1674 mbedtls_ssl_recv_t *f_recv,
1675 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001676{
1677 ssl->p_bio = p_bio;
1678 ssl->f_send = f_send;
1679 ssl->f_recv = f_recv;
1680 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001681}
1682
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001683#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001684void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001685{
1686 ssl->mtu = mtu;
1687}
1688#endif
1689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001691{
1692 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001693}
1694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1696 void *p_timer,
1697 mbedtls_ssl_set_timer_t *f_set_timer,
1698 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001699{
1700 ssl->p_timer = p_timer;
1701 ssl->f_set_timer = f_set_timer;
1702 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001703
1704 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001706}
1707
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001709void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1710 void *p_cache,
1711 mbedtls_ssl_cache_get_t *f_get_cache,
1712 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001713{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001714 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001715 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001716 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001717}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001721int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001722{
Janos Follath865b3eb2019-12-16 11:46:15 +00001723 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001726 session == NULL ||
1727 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001730 }
1731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (ssl->handshake->resume == 1) {
1733 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1734 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001735
Jerry Yu21092062022-10-10 21:21:31 +08001736#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001738 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001742 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1744 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1745 session->ciphersuite));
1746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001747 }
Jerry Yu40afab62022-10-08 10:42:13 +08001748 }
Jerry Yu21092062022-10-10 21:21:31 +08001749#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1752 session)) != 0) {
1753 return ret;
1754 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001755
Paul Bakker0a597072012-09-25 21:55:46 +00001756 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001759}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1763 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001764{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001765 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001766}
1767
Ronald Cron6f135e12021-12-08 16:57:54 +01001768#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001769void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1770 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001771{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001772 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001773}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001774
1775#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001776void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1777 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001778{
1779 conf->early_data_enabled = early_data_enabled;
1780}
Jerry Yucc4e0072022-11-22 17:22:22 +08001781
1782#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001783void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001785{
Jerry Yu39da9852022-12-06 16:58:36 +08001786 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001787}
1788#endif /* MBEDTLS_SSL_SRV_C */
1789
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001790#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001791#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001794void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1795 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001796{
1797 conf->cert_profile = profile;
1798}
1799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001801{
1802 mbedtls_ssl_key_cert *cur = key_cert, *next;
1803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001805 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001807 cur = next;
1808 }
1809}
1810
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001811/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001812MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001813static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1814 mbedtls_x509_crt *cert,
1815 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001816{
niisato8ee24222018-06-25 19:05:48 +09001817 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001820 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001822 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001824 }
1825
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1827 if (new_cert == NULL) {
1828 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1829 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001830
niisato8ee24222018-06-25 19:05:48 +09001831 new_cert->cert = cert;
1832 new_cert->key = key;
1833 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001834
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001837 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001839 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001841 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 }
niisato8ee24222018-06-25 19:05:48 +09001843 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001844 }
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847}
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852{
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001854}
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001859{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001860 conf->ca_chain = ca_chain;
1861 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001862
1863#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1864 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1865 * cannot be used together. */
1866 conf->f_ca_cb = NULL;
1867 conf->p_ca_cb = NULL;
1868#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001869}
Hanno Becker5adaad92019-03-27 16:54:37 +00001870
1871#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001872void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1873 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1874 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001875{
1876 conf->f_ca_cb = f_ca_cb;
1877 conf->p_ca_cb = p_ca_cb;
1878
1879 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1880 * cannot be used together. */
1881 conf->ca_chain = NULL;
1882 conf->ca_crl = NULL;
1883}
1884#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001886
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001887#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001888const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1889 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001890{
1891 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001893}
1894
Gilles Peskine449bd832023-01-11 14:50:10 +01001895int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1896 mbedtls_x509_crt *own_cert,
1897 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898{
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1900 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001901}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1904 mbedtls_x509_crt *ca_chain,
1905 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001906{
1907 ssl->handshake->sni_ca_chain = ca_chain;
1908 ssl->handshake->sni_ca_crl = ca_crl;
1909}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001910
Glenn Strauss999ef702022-03-11 01:37:23 -05001911#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001912void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1913 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001914{
1915 ssl->handshake->dn_hints = crt;
1916}
1917#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1920 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001921{
1922 ssl->handshake->sni_authmode = authmode;
1923}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001924#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1925
Hanno Becker8927c832019-04-03 12:52:50 +01001926#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001927void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1928 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1929 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001930{
1931 ssl->f_vrfy = f_vrfy;
1932 ssl->p_vrfy = p_vrfy;
1933}
1934#endif
1935
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001936#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001937
Valerio Setti016f6822022-12-09 14:17:50 +01001938#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001939static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1940static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1941
Valerio Setti016f6822022-12-09 14:17:50 +01001942static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 mbedtls_ssl_context *ssl,
1944 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001945{
1946 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001947 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001948 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001949 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001950 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001951 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1953 psa_pake_cs_set_primitive(&cipher_suite,
1954 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1955 PSA_ECC_FAMILY_SECP_R1,
1956 256));
1957 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1960 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001961 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001965 user = jpake_server_id;
1966 user_len = sizeof(jpake_server_id);
1967 peer = jpake_client_id;
1968 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001970 user = jpake_client_id;
1971 user_len = sizeof(jpake_client_id);
1972 peer = jpake_server_id;
1973 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001975
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001976 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1977 if (status != PSA_SUCCESS) {
1978 return status;
1979 }
1980
1981 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001983 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Valerio Setti016f6822022-12-09 14:17:50 +01001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1987 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001988 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 }
Valerio Setti016f6822022-12-09 14:17:50 +01001990
1991 ssl->handshake->psa_pake_ctx_is_ok = 1;
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001994}
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1997 const unsigned char *pw,
1998 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001999{
2000 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2001 psa_status_t status;
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (ssl->handshake == NULL || ssl->conf == NULL) {
2004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002005 }
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 /* Empty password is not valid */
2008 if ((pw == NULL) || (pw_len == 0)) {
2009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2010 }
2011
2012 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2013 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2014 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2015
2016 status = psa_import_key(&attributes, pw, pw_len,
2017 &ssl->handshake->psa_pake_password);
2018 if (status != PSA_SUCCESS) {
2019 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2020 }
2021
2022 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2023 ssl->handshake->psa_pake_password);
2024 if (status != PSA_SUCCESS) {
2025 psa_destroy_key(ssl->handshake->psa_pake_password);
2026 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2027 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2028 }
2029
2030 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002031}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2034 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002035{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002036 psa_status_t status;
2037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (ssl->handshake == NULL || ssl->conf == NULL) {
2039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002040 }
2041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (mbedtls_svc_key_id_is_null(pwd)) {
2043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2044 }
2045
2046 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2047 if (status != PSA_SUCCESS) {
2048 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2049 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2050 }
2051
2052 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002053}
2054#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002055int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2056 const unsigned char *pw,
2057 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002058{
2059 mbedtls_ecjpake_role role;
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (ssl->handshake == NULL || ssl->conf == NULL) {
2062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2063 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002064
Valerio Settic689ed82022-12-07 14:40:38 +01002065 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if ((pw == NULL) || (pw_len == 0)) {
2067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2068 }
Valerio Settic689ed82022-12-07 14:40:38 +01002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002071 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2077 role,
2078 MBEDTLS_MD_SHA256,
2079 MBEDTLS_ECP_DP_SECP256R1,
2080 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081}
Valerio Setti02c25b52022-11-15 14:08:42 +01002082#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002083#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084
Ronald Cron73fe8df2022-10-05 14:31:43 +02002085#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002086int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002087{
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 if (conf->psk_identity == NULL ||
2089 conf->psk_identity_len == 0) {
2090 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002091 }
2092
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002093#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2095 return 1;
2096 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (conf->psk != NULL && conf->psk_len != 0) {
2100 return 1;
2101 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104}
2105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002107{
2108 /* Remove reference to existing PSK, if any. */
2109#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 /* The maintenance of the PSK key slot is the
2112 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002113 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002114 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002117 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118 conf->psk = NULL;
2119 conf->psk_len = 0;
2120 }
2121
2122 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (conf->psk_identity != NULL) {
2124 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125 conf->psk_identity = NULL;
2126 conf->psk_identity_len = 0;
2127 }
2128}
2129
Hanno Becker7390c712018-11-15 13:33:04 +00002130/* This function assumes that PSK identity in the SSL config is unset.
2131 * It checks that the provided identity is well-formed and attempts
2132 * to make a copy of it in the SSL config.
2133 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002134MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002135static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2136 unsigned char const *psk_identity,
2137 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002138{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002139 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002141 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 (psk_identity_len >> 16) != 0 ||
2143 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2144 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002145 }
2146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2148 if (conf->psk_identity == NULL) {
2149 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2150 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002151
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002152 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002156}
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2159 const unsigned char *psk, size_t psk_len,
2160 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002161{
Janos Follath865b3eb2019-12-16 11:46:15 +00002162 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002163
2164 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2166 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2167 }
Hanno Becker7390c712018-11-15 13:33:04 +00002168
2169 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (psk == NULL) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len == 0) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
2176 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2177 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2178 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002179
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2181 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2182 }
Hanno Becker7390c712018-11-15 13:33:04 +00002183 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002185
2186 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2188 if (ret != 0) {
2189 ssl_conf_remove_psk(conf);
2190 }
Hanno Becker7390c712018-11-15 13:33:04 +00002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002193}
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002196{
2197#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002199 /* The maintenance of the external PSK key slot is the
2200 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (ssl->handshake->psk_opaque_is_internal) {
2202 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002203 ssl->handshake->psk_opaque_is_internal = 0;
2204 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002205 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002206 }
Neil Armstronge952a302022-05-03 10:22:14 +02002207#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002209 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211 ssl->handshake->psk_len = 0;
2212 }
Neil Armstronge952a302022-05-03 10:22:14 +02002213#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002214}
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2217 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002218{
Neil Armstrong501c9322022-05-03 09:35:09 +02002219#if defined(MBEDTLS_USE_PSA_CRYPTO)
2220 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002222 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002223 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002224#endif /* MBEDTLS_USE_PSA_CRYPTO */
2225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 if (psk == NULL || ssl->handshake == NULL) {
2227 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2228 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2232 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002235
Neil Armstrong501c9322022-05-03 09:35:09 +02002236#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002237#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2239 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2240 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2241 } else {
2242 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2243 }
2244 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002245 }
2246#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002247
Jerry Yu568ec252022-07-22 21:27:34 +08002248#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2250 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2251 psa_set_key_usage_flags(&key_attributes,
2252 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002253 }
2254#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 psa_set_key_algorithm(&key_attributes, alg);
2257 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2260 if (status != PSA_SUCCESS) {
2261 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2262 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002263
2264 /* Allow calling psa_destroy_key() on psk remove */
2265 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002267#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2269 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2270 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
2272 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002276#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002277}
2278
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002279#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002280int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2281 mbedtls_svc_key_id_t psk,
2282 const unsigned char *psk_identity,
2283 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002284{
Janos Follath865b3eb2019-12-16 11:46:15 +00002285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002286
2287 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2289 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2290 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291
Hanno Becker7390c712018-11-15 13:33:04 +00002292 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (mbedtls_svc_key_id_is_null(psk)) {
2294 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2295 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002296 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002297
2298 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2300 psk_identity_len);
2301 if (ret != 0) {
2302 ssl_conf_remove_psk(conf);
2303 }
Hanno Becker7390c712018-11-15 13:33:04 +00002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002306}
2307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2309 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002310{
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 if ((mbedtls_svc_key_id_is_null(psk)) ||
2312 (ssl->handshake == NULL)) {
2313 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2314 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002317 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319}
2320#endif /* MBEDTLS_USE_PSA_CRYPTO */
2321
Jerry Yu8897c072022-08-12 13:56:53 +08002322#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002323void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2324 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2325 size_t),
2326 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327{
2328 conf->f_psk = f_psk;
2329 conf->p_psk = p_psk;
2330}
Jerry Yu8897c072022-08-12 13:56:53 +08002331#endif /* MBEDTLS_SSL_SRV_C */
2332
Ronald Cron73fe8df2022-10-05 14:31:43 +02002333#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002334
2335#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002336static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002338{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002339#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 if (alg == PSA_ALG_CBC_NO_PADDING) {
2341 return MBEDTLS_SSL_MODE_CBC;
2342 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002343#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (PSA_ALG_IS_AEAD(alg)) {
2345 return MBEDTLS_SSL_MODE_AEAD;
2346 }
2347 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002348}
2349
2350#else /* MBEDTLS_USE_PSA_CRYPTO */
2351
2352static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002354{
2355#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (mode == MBEDTLS_MODE_CBC) {
2357 return MBEDTLS_SSL_MODE_CBC;
2358 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002359#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2360
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002361#if defined(MBEDTLS_GCM_C) || \
2362 defined(MBEDTLS_CCM_C) || \
2363 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002365 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 mode == MBEDTLS_MODE_CHACHAPOLY) {
2367 return MBEDTLS_SSL_MODE_AEAD;
2368 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372}
Gilles Peskine301711e2022-04-26 16:57:05 +02002373#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374
Gilles Peskinee108d982022-04-26 16:50:40 +02002375static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2376 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002378{
2379#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2381 base_mode == MBEDTLS_SSL_MODE_CBC) {
2382 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002383 }
2384#else
2385 (void) encrypt_then_mac;
2386#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002388}
2389
Neil Armstrongab555e02022-04-04 11:07:59 +02002390mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002392{
Gilles Peskinee108d982022-04-26 16:50:40 +02002393 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002394#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002396#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002398#endif
2399 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002400
Gilles Peskinee108d982022-04-26 16:50:40 +02002401 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002402#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002403 encrypt_then_mac = transform->encrypt_then_mac;
2404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406}
2407
Neil Armstrongab555e02022-04-04 11:07:59 +02002408mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002409#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413{
Gilles Peskinee108d982022-04-26 16:50:40 +02002414 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2415
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416#if defined(MBEDTLS_USE_PSA_CRYPTO)
2417 psa_status_t status;
2418 psa_algorithm_t alg;
2419 psa_key_type_t type;
2420 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002421 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2422 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 if (status == PSA_SUCCESS) {
2424 base_mode = mbedtls_ssl_get_base_mode(alg);
2425 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002426#else
2427 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002428 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 base_mode =
2431 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002433 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002434#endif /* MBEDTLS_USE_PSA_CRYPTO */
2435
Gilles Peskinee108d982022-04-26 16:50:40 +02002436#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2437 int encrypt_then_mac = 0;
2438#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002440}
2441
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002442#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002443
2444#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002445/* Serialization of TLS 1.3 sessions:
2446 *
2447 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002448 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002449 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002450 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002451 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002452 * } ClientOnlyData;
2453 *
2454 * struct {
2455 * uint8 endpoint;
2456 * uint8 ciphersuite[2];
2457 * uint32 ticket_age_add;
2458 * uint8 ticket_flags;
2459 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002460 * uint32 max_early_data_size;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * select ( endpoint ) {
2462 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002463 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002464 * };
2465 * } serialized_session_tls13;
2466 *
2467 */
2468#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002470static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2471 unsigned char *buf,
2472 size_t buf_len,
2473 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002474{
2475 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002476#if defined(MBEDTLS_SSL_CLI_C) && \
2477 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 size_t hostname_len = (session->hostname == NULL) ?
2479 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002480#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002481 size_t needed = 1 /* endpoint */
2482 + 2 /* ciphersuite */
2483 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002484 + 1 /* ticket_flags */
2485 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002486 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2489 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2490 }
Jerry Yu34191072022-08-18 10:32:09 +08002491 needed += session->resumption_key_len; /* resumption_key */
2492
Jerry Yu02e3a072022-12-12 15:13:20 +08002493#if defined(MBEDTLS_SSL_EARLY_DATA)
2494 needed += 4; /* max_early_data_size */
2495#endif
2496
Jerry Yu438ddd82022-07-07 06:55:50 +00002497#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002498 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002499#endif
2500
2501#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002503#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002504 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002506#endif
2507
Jerry Yu438ddd82022-07-07 06:55:50 +00002508 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002509 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002510
2511 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (session->ticket_len > SIZE_MAX - needed) {
2513 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2514 }
Jerry Yu34191072022-08-18 10:32:09 +08002515
Jerry Yue28d9742022-08-18 15:44:03 +08002516 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002517 }
2518#endif /* MBEDTLS_SSL_CLI_C */
2519
Jerry Yue36fdd62022-08-17 21:31:36 +08002520 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 if (needed > buf_len) {
2522 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2523 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002524
2525 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2527 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002528 p[7] = session->ticket_flags;
2529
2530 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002531 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002532 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002534 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002535
Jerry Yu02e3a072022-12-12 15:13:20 +08002536#if defined(MBEDTLS_SSL_EARLY_DATA)
2537 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2538 p += 4;
2539#endif
2540
Jerry Yu438ddd82022-07-07 06:55:50 +00002541#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002543 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002544 p += 8;
2545 }
2546#endif /* MBEDTLS_HAVE_TIME */
2547
2548#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002550#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556 p += hostname_len;
2557 }
2558#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2559
Jerry Yu438ddd82022-07-07 06:55:50 +00002560#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002561 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 8;
2563#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 4;
2566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002568 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (session->ticket != NULL && session->ticket_len > 0) {
2571 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002572 p += session->ticket_len;
2573 }
2574 }
2575#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002577}
2578
2579MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002580static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2581 const unsigned char *buf,
2582 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002583{
2584 const unsigned char *p = buf;
2585 const unsigned char *end = buf + len;
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (end - p < 9) {
2588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2589 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2592 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002593 session->ticket_flags = p[7];
2594
2595 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002596 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002597 p += 9;
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (end - p < session->resumption_key_len) {
2600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2601 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2605 }
2606 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002607 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002608
Jerry Yu02e3a072022-12-12 15:13:20 +08002609#if defined(MBEDTLS_SSL_EARLY_DATA)
2610 if (end - p < 4) {
2611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2612 }
2613 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2614 p += 4;
2615#endif
2616
Jerry Yu438ddd82022-07-07 06:55:50 +00002617#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2619 if (end - p < 8) {
2620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2621 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002622 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002623 p += 8;
2624 }
2625#endif /* MBEDTLS_HAVE_TIME */
2626
2627#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002629#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002630 size_t hostname_len;
2631 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (end - p < 2) {
2633 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2634 }
2635 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002636 p += 2;
2637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (end - p < (long int) hostname_len) {
2639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2640 }
2641 if (hostname_len > 0) {
2642 session->hostname = mbedtls_calloc(1, hostname_len);
2643 if (session->hostname == NULL) {
2644 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2645 }
2646 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002647 p += hostname_len;
2648 }
Yanray Wangfd256542023-11-22 10:32:03 +08002649#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002650
Jerry Yu438ddd82022-07-07 06:55:50 +00002651#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (end - p < 8) {
2653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2654 }
Jerry Yu342a5552023-11-10 14:23:39 +08002655 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002656 p += 8;
2657#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 if (end - p < 4) {
2659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2660 }
2661 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002662 p += 4;
2663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (end - p < 2) {
2665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2666 }
2667 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002668 p += 2;
2669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (end - p < (long int) session->ticket_len) {
2671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2672 }
2673 if (session->ticket_len > 0) {
2674 session->ticket = mbedtls_calloc(1, session->ticket_len);
2675 if (session->ticket == NULL) {
2676 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2677 }
2678 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002679 p += session->ticket_len;
2680 }
2681 }
2682#endif /* MBEDTLS_SSL_CLI_C */
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002685
2686}
2687#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002688MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002689static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2690 unsigned char *buf,
2691 size_t buf_len,
2692 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002693{
2694 ((void) session);
2695 ((void) buf);
2696 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002697 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002699}
Jerry Yu438ddd82022-07-07 06:55:50 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2702 unsigned char *buf,
2703 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002704{
2705 ((void) session);
2706 ((void) buf);
2707 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002709}
2710#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002711#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2714 size_t taglen,
2715 psa_algorithm_t *alg,
2716 psa_key_type_t *key_type,
2717 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002718{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002719#if !defined(MBEDTLS_SSL_HAVE_CCM)
2720 (void) taglen;
2721#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002723#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002724 case MBEDTLS_CIPHER_AES_128_CBC:
2725 *alg = PSA_ALG_CBC_NO_PADDING;
2726 *key_type = PSA_KEY_TYPE_AES;
2727 *key_size = 128;
2728 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002729#endif
2730#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002731 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 128;
2735 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002736#endif
2737#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002738 case MBEDTLS_CIPHER_AES_128_GCM:
2739 *alg = PSA_ALG_GCM;
2740 *key_type = PSA_KEY_TYPE_AES;
2741 *key_size = 128;
2742 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002743#endif
2744#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002747 *key_type = PSA_KEY_TYPE_AES;
2748 *key_size = 192;
2749 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002750#endif
2751#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002752 case MBEDTLS_CIPHER_AES_192_GCM:
2753 *alg = PSA_ALG_GCM;
2754 *key_type = PSA_KEY_TYPE_AES;
2755 *key_size = 192;
2756 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002757#endif
2758#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002759 case MBEDTLS_CIPHER_AES_256_CBC:
2760 *alg = PSA_ALG_CBC_NO_PADDING;
2761 *key_type = PSA_KEY_TYPE_AES;
2762 *key_size = 256;
2763 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002764#endif
2765#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002766 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002768 *key_type = PSA_KEY_TYPE_AES;
2769 *key_size = 256;
2770 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002771#endif
2772#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002773 case MBEDTLS_CIPHER_AES_256_GCM:
2774 *alg = PSA_ALG_GCM;
2775 *key_type = PSA_KEY_TYPE_AES;
2776 *key_size = 256;
2777 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002778#endif
2779#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 case MBEDTLS_CIPHER_ARIA_128_CBC:
2781 *alg = PSA_ALG_CBC_NO_PADDING;
2782 *key_type = PSA_KEY_TYPE_ARIA;
2783 *key_size = 128;
2784 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002785#endif
2786#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002787 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002789 *key_type = PSA_KEY_TYPE_ARIA;
2790 *key_size = 128;
2791 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002792#endif
2793#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002794 case MBEDTLS_CIPHER_ARIA_128_GCM:
2795 *alg = PSA_ALG_GCM;
2796 *key_type = PSA_KEY_TYPE_ARIA;
2797 *key_size = 128;
2798 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002799#endif
2800#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002801 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 *key_type = PSA_KEY_TYPE_ARIA;
2804 *key_size = 192;
2805 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002806#endif
2807#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002808 case MBEDTLS_CIPHER_ARIA_192_GCM:
2809 *alg = PSA_ALG_GCM;
2810 *key_type = PSA_KEY_TYPE_ARIA;
2811 *key_size = 192;
2812 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002813#endif
2814#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002815 case MBEDTLS_CIPHER_ARIA_256_CBC:
2816 *alg = PSA_ALG_CBC_NO_PADDING;
2817 *key_type = PSA_KEY_TYPE_ARIA;
2818 *key_size = 256;
2819 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002820#endif
2821#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002822 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002824 *key_type = PSA_KEY_TYPE_ARIA;
2825 *key_size = 256;
2826 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002827#endif
2828#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002829 case MBEDTLS_CIPHER_ARIA_256_GCM:
2830 *alg = PSA_ALG_GCM;
2831 *key_type = PSA_KEY_TYPE_ARIA;
2832 *key_size = 256;
2833 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002834#endif
2835#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002836 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2837 *alg = PSA_ALG_CBC_NO_PADDING;
2838 *key_type = PSA_KEY_TYPE_CAMELLIA;
2839 *key_size = 128;
2840 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002841#endif
2842#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002843 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002845 *key_type = PSA_KEY_TYPE_CAMELLIA;
2846 *key_size = 128;
2847 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002848#endif
2849#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002850 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2851 *alg = PSA_ALG_GCM;
2852 *key_type = PSA_KEY_TYPE_CAMELLIA;
2853 *key_size = 128;
2854 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002855#endif
2856#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002857 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002859 *key_type = PSA_KEY_TYPE_CAMELLIA;
2860 *key_size = 192;
2861 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002862#endif
2863#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002864 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2865 *alg = PSA_ALG_GCM;
2866 *key_type = PSA_KEY_TYPE_CAMELLIA;
2867 *key_size = 192;
2868 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002869#endif
2870#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002871 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2872 *alg = PSA_ALG_CBC_NO_PADDING;
2873 *key_type = PSA_KEY_TYPE_CAMELLIA;
2874 *key_size = 256;
2875 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002876#endif
2877#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002878 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002880 *key_type = PSA_KEY_TYPE_CAMELLIA;
2881 *key_size = 256;
2882 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002883#endif
2884#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002885 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2886 *alg = PSA_ALG_GCM;
2887 *key_type = PSA_KEY_TYPE_CAMELLIA;
2888 *key_size = 256;
2889 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002890#endif
2891#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002892 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2893 *alg = PSA_ALG_CHACHA20_POLY1305;
2894 *key_type = PSA_KEY_TYPE_CHACHA20;
2895 *key_size = 256;
2896 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002897#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002898 case MBEDTLS_CIPHER_NULL:
2899 *alg = MBEDTLS_SSL_NULL_CIPHER;
2900 *key_type = 0;
2901 *key_size = 0;
2902 break;
2903 default:
2904 return PSA_ERROR_NOT_SUPPORTED;
2905 }
2906
2907 return PSA_SUCCESS;
2908}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002909#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002910
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002911#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002912int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2913 const unsigned char *dhm_P, size_t P_len,
2914 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002915{
Janos Follath865b3eb2019-12-16 11:46:15 +00002916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 mbedtls_mpi_free(&conf->dhm_P);
2919 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2922 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2923 mbedtls_mpi_free(&conf->dhm_P);
2924 mbedtls_mpi_free(&conf->dhm_G);
2925 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002926 }
2927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002929}
Paul Bakker5121ce52009-01-03 21:22:43 +00002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002932{
Janos Follath865b3eb2019-12-16 11:46:15 +00002933 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 mbedtls_mpi_free(&conf->dhm_P);
2936 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2939 &conf->dhm_P)) != 0 ||
2940 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2941 &conf->dhm_G)) != 0) {
2942 mbedtls_mpi_free(&conf->dhm_P);
2943 mbedtls_mpi_free(&conf->dhm_G);
2944 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002945 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002948}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002949#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002950
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002951#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2952/*
2953 * Set the minimum length for Diffie-Hellman parameters
2954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002955void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2956 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002957{
2958 conf->dhm_min_bitlen = bitlen;
2959}
2960#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2961
Ronald Crone68ab4f2022-10-05 12:46:29 +02002962#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002963#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002964/*
2965 * Set allowed/preferred hashes for handshake signatures
2966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2968 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002969{
2970 conf->sig_hashes = hashes;
2971}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002972#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002973
Jerry Yuf017ee42022-01-12 15:49:48 +08002974/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002975void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2976 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002977{
Jerry Yuf017ee42022-01-12 15:49:48 +08002978#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2979 conf->sig_hashes = NULL;
2980#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2981 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002982}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002983#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002984
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002985#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002986#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002987/*
2988 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002989 *
2990 * mbedtls_ssl_setup() takes the provided list
2991 * and translates it to a list of IANA TLS group identifiers,
2992 * stored in ssl->handshake->group_list.
2993 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002994 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002995void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2996 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002997{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002998 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002999 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003000}
Brett Warrene0edc842021-08-17 09:53:13 +01003001#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003002#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003003
Brett Warrene0edc842021-08-17 09:53:13 +01003004/*
3005 * Set the allowed groups
3006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003007void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3008 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003009{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003010#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003011 conf->curve_list = NULL;
3012#endif
3013 conf->group_list = group_list;
3014}
3015
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003016#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003017int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003018{
Hanno Becker947194e2017-04-07 13:25:49 +01003019 /* Initialize to suppress unnecessary compiler warning */
3020 size_t hostname_len = 0;
3021
3022 /* Check if new hostname is valid before
3023 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 if (hostname != NULL) {
3025 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3029 }
Hanno Becker947194e2017-04-07 13:25:49 +01003030 }
3031
3032 /* Now it's clear that we will overwrite the old hostname,
3033 * so we can free it safely */
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003036 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003037 }
3038
3039 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003042 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 } else {
3044 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3045 if (ssl->hostname == NULL) {
3046 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3047 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003050
Hanno Becker947194e2017-04-07 13:25:49 +01003051 ssl->hostname[hostname_len] = '\0';
3052 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003055}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003056#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003057
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003058#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003059void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3060 int (*f_sni)(void *, mbedtls_ssl_context *,
3061 const unsigned char *, size_t),
3062 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003063{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003064 conf->f_sni = f_sni;
3065 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003066}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003070int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003071{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003072 size_t cur_len, tot_len;
3073 const char **p;
3074
3075 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003076 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3077 * MUST NOT be truncated."
3078 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003079 */
3080 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 for (p = protos; *p != NULL; p++) {
3082 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003083 tot_len += cur_len;
3084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 if ((cur_len == 0) ||
3086 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3087 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3089 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003090 }
3091
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003092 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003095}
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003098{
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003100}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003102
Johan Pascalb62bb512015-12-03 21:56:45 +01003103#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003104void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3105 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003106{
3107 conf->dtls_srtp_mki_support = support_mki_value;
3108}
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3111 unsigned char *mki_value,
3112 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003113{
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3115 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003116 }
Ron Eldor591f1622018-01-22 12:30:04 +02003117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3119 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003120 }
Ron Eldor591f1622018-01-22 12:30:04 +02003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003123 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003125}
3126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3128 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003129{
Johan Pascal253d0262020-09-22 13:04:45 +02003130 const mbedtls_ssl_srtp_profile *p;
3131 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003132
Johan Pascal253d0262020-09-22 13:04:45 +02003133 /* check the profiles list: all entry must be valid,
3134 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3136 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3137 p++) {
3138 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003139 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003141 /* unsupported value, stop parsing and set the size to an error value */
3142 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003143 }
3144 }
3145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3147 conf->dtls_srtp_profile_list = NULL;
3148 conf->dtls_srtp_profile_list_len = 0;
3149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003150 }
3151
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003152 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003153 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003156}
3157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3159 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003160{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003161 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3162 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003164 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003166 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3168 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003169 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003170}
Johan Pascalb62bb512015-12-03 21:56:45 +01003171#endif /* MBEDTLS_SSL_DTLS_SRTP */
3172
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303173#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003174void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003175{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003176 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003177}
3178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003180{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003181 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003182}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303183#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003184
Janos Follath088ce432017-04-10 12:42:31 +01003185#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003186void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3187 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003188{
3189 conf->cert_req_ca_list = cert_req_ca_list;
3190}
3191#endif
3192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003194void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003195{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003196 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003197}
3198#endif
3199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003201void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003202{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003203 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003204}
3205#endif
3206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003208int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003209{
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3211 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3212 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003213 }
3214
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003215 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003218}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003222{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003223 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003224}
3225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003227void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003228{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003229 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003230}
3231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003233{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003234 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003235}
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3238 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003239{
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003241}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003243
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003245#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003246void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003247{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003248 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003249}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003250#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003251
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003252#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003253
Jerry Yud0766ec2022-09-22 10:46:57 +08003254#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003255void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3256 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003257{
Jerry Yud0766ec2022-09-22 10:46:57 +08003258 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003259}
3260#endif
3261
Gilles Peskine449bd832023-01-11 14:50:10 +01003262void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3263 mbedtls_ssl_ticket_write_t *f_ticket_write,
3264 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3265 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003266{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003267 conf->f_ticket_write = f_ticket_write;
3268 conf->f_ticket_parse = f_ticket_parse;
3269 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003270}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003271#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003272#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3275 mbedtls_ssl_export_keys_t *f_export_keys,
3276 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003277{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003278 ssl->f_export_keys = f_export_keys;
3279 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003280}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003281
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003282#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003283void mbedtls_ssl_conf_async_private_cb(
3284 mbedtls_ssl_config *conf,
3285 mbedtls_ssl_async_sign_t *f_async_sign,
3286 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3287 mbedtls_ssl_async_resume_t *f_async_resume,
3288 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003290{
3291 conf->f_async_sign_start = f_async_sign;
3292 conf->f_async_decrypt_start = f_async_decrypt;
3293 conf->f_async_resume = f_async_resume;
3294 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003295 conf->p_async_config_data = async_config_data;
3296}
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003299{
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003301}
3302
Gilles Peskine449bd832023-01-11 14:50:10 +01003303void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003304{
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 if (ssl->handshake == NULL) {
3306 return NULL;
3307 } else {
3308 return ssl->handshake->user_async_ctx;
3309 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003310}
3311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3313 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003314{
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003316 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003318}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003319#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003320
Paul Bakker5121ce52009-01-03 21:22:43 +00003321/*
3322 * SSL get accessors
3323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003324uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003325{
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 if (ssl->session != NULL) {
3327 return ssl->session->verify_result;
3328 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003329
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->session_negotiate != NULL) {
3331 return ssl->session_negotiate->verify_result;
3332 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003333
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003335}
3336
Gilles Peskine449bd832023-01-11 14:50:10 +01003337int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003338{
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl == NULL || ssl->session == NULL) {
3340 return 0;
3341 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003342
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003344}
3345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003347{
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 if (ssl == NULL || ssl->session == NULL) {
3349 return NULL;
3350 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003353}
3354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003356{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3359 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003360 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003362 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003364 }
3365 }
3366#endif
3367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003369 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003371 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003373 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003375 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003376}
3377
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003378#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003379size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003380{
David Horstmann95d516f2021-05-04 18:36:56 +01003381 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003382 size_t read_mfl;
3383
Jerry Yuddda0502022-12-01 19:43:12 +08003384#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003385 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3387 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3388 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003389 }
Jerry Yuddda0502022-12-01 19:43:12 +08003390#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003391
3392 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003393 if (ssl->session_out != NULL) {
3394 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3395 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003396 max_len = read_mfl;
3397 }
3398 }
3399
Jerry Yuddda0502022-12-01 19:43:12 +08003400 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 if (ssl->session_negotiate != NULL) {
3402 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3403 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003404 max_len = read_mfl;
3405 }
3406 }
3407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003409}
3410
Gilles Peskine449bd832023-01-11 14:50:10 +01003411size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003412{
3413 size_t max_len;
3414
3415 /*
3416 * Assume mfl_code is correct since it was checked when set
3417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003419
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003420 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 if (ssl->session_out != NULL &&
3422 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3423 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003424 }
3425
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003426 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 if (ssl->session_negotiate != NULL &&
3428 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3429 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003430 }
3431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003433}
3434#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3435
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003437size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003438{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003439 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3441 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3442 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3443 return 0;
3444 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3447 return ssl->mtu;
3448 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 if (ssl->mtu == 0) {
3451 return ssl->handshake->mtu;
3452 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003453
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 return ssl->mtu < ssl->handshake->mtu ?
3455 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003456}
3457#endif /* MBEDTLS_SSL_PROTO_DTLS */
3458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003460{
3461 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3462
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003463#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3464 !defined(MBEDTLS_SSL_PROTO_DTLS)
3465 (void) ssl;
3466#endif
3467
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003468#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003472 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003474#endif
3475
3476#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3478 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3479 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003480 const size_t overhead = (size_t) ret;
3481
Gilles Peskine449bd832023-01-11 14:50:10 +01003482 if (ret < 0) {
3483 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003484 }
3485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 if (mtu <= overhead) {
3487 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3489 }
3490
3491 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003492 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003493 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003494 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003495#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003496
Hanno Becker0defedb2018-08-10 12:35:02 +01003497#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3498 !defined(MBEDTLS_SSL_PROTO_DTLS)
3499 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003500#endif
3501
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003503}
3504
Gilles Peskine449bd832023-01-11 14:50:10 +01003505int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003506{
3507 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3508
3509#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3510 (void) ssl;
3511#endif
3512
3513#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003515
Gilles Peskine449bd832023-01-11 14:50:10 +01003516 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003517 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003519#endif
3520
Gilles Peskine449bd832023-01-11 14:50:10 +01003521 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003522}
3523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003525const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003526{
Gilles Peskine449bd832023-01-11 14:50:10 +01003527 if (ssl == NULL || ssl->session == NULL) {
3528 return NULL;
3529 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003530
Hanno Beckere6824572019-02-07 13:18:46 +00003531#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003532 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003533#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003534 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003535#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003536}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003540int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3541 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003542{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003543 int ret;
3544
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003546 dst == NULL ||
3547 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003548 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3549 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003550 }
3551
Hanno Beckere810bbc2021-05-14 16:01:05 +01003552 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3553 * idempotent: Each session can only be exported once.
3554 *
3555 * (This is in preparation for TLS 1.3 support where we will
3556 * need the ability to export multiple sessions (aka tickets),
3557 * which will be achieved by calling mbedtls_ssl_get_session()
3558 * multiple times until it fails.)
3559 *
3560 * Check whether we have already exported the current session,
3561 * and fail if so.
3562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003563 if (ssl->session->exported == 1) {
3564 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3565 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003566
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3568 if (ret != 0) {
3569 return ret;
3570 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003571
3572 /* Remember that we've exported the session. */
3573 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003574 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003575}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003577
Paul Bakker5121ce52009-01-03 21:22:43 +00003578/*
Hanno Beckera835da52019-05-16 12:39:07 +01003579 * Define ticket header determining Mbed TLS version
3580 * and structure of the ticket.
3581 */
3582
Hanno Becker94ef3b32019-05-16 12:50:45 +01003583/*
Hanno Becker50b59662019-05-28 14:30:45 +01003584 * Define bitflag determining compile-time settings influencing
3585 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003586 */
3587
Hanno Becker50b59662019-05-28 14:30:45 +01003588#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003589#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003590#else
Hanno Becker3e088662019-05-29 11:10:18 +01003591#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003592#endif /* MBEDTLS_HAVE_TIME */
3593
3594#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003595#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003596#else
Hanno Becker3e088662019-05-29 11:10:18 +01003597#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003598#endif /* MBEDTLS_X509_CRT_PARSE_C */
3599
3600#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003601#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003602#else
Hanno Becker3e088662019-05-29 11:10:18 +01003603#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003604#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3605
3606#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003607#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003608#else
Hanno Becker3e088662019-05-29 11:10:18 +01003609#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003610#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3611
Hanno Becker94ef3b32019-05-16 12:50:45 +01003612#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003613#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003614#else
Hanno Becker3e088662019-05-29 11:10:18 +01003615#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003616#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3617
Hanno Becker94ef3b32019-05-16 12:50:45 +01003618#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3619#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3620#else
3621#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3622#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3623
Hanno Becker3e088662019-05-29 11:10:18 +01003624#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3625#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3626#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3627#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003628#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3629#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003630
Hanno Becker50b59662019-05-28 14:30:45 +01003631#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003632 ((uint16_t) ( \
3633 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3634 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3635 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3636 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3637 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3638 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3639 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003640
Hanno Beckerf8787072019-05-16 12:41:07 +01003641static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003642 MBEDTLS_VERSION_MAJOR,
3643 MBEDTLS_VERSION_MINOR,
3644 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3646 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003647};
Hanno Beckera835da52019-05-16 12:39:07 +01003648
3649/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003650 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003651 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003652 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003653 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003654 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003655 * opaque mbedtls_version[3]; // library version: major, minor, patch
3656 * opaque session_format[2]; // library-version specific 16-bit field
3657 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003658 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003659 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003660 * Note: When updating the format, remember to keep
3661 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003662 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003663 * // In this version, `session_format` determines
3664 * // the setting of those compile-time
3665 * // configuration options which influence
3666 * // the structure of mbedtls_ssl_session.
3667 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003668 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003669 * // - TLS 1.2 (0x0303)
3670 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003671 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003672 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003673 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003674 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003675 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003676 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003677 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003678 *
3679 * };
3680 *
3681 * } serialized_session;
3682 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003683 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003684
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003685MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003686static int ssl_session_save(const mbedtls_ssl_session *session,
3687 unsigned char omit_header,
3688 unsigned char *buf,
3689 size_t buf_len,
3690 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003691{
3692 unsigned char *p = buf;
3693 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003694 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003695#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3696 size_t out_len;
3697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3698#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 if (session == NULL) {
3700 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3701 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003702
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003704 /*
3705 * Add Mbed TLS version identifier
3706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003708
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 if (used <= buf_len) {
3710 memcpy(p, ssl_serialized_session_header,
3711 sizeof(ssl_serialized_session_header));
3712 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003713 }
3714 }
3715
3716 /*
3717 * TLS version identifier
3718 */
3719 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003720 if (used <= buf_len) {
3721 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003722 }
3723
3724 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003725 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003727#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003728 case MBEDTLS_SSL_VERSION_TLS1_2:
3729 used += ssl_tls12_session_save(session, p, remaining_len);
3730 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003731#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3732
Jerry Yu251a12e2022-07-13 15:15:48 +08003733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 case MBEDTLS_SSL_VERSION_TLS1_3:
3735 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3736 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3737 return ret;
3738 }
3739 used += out_len;
3740 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003741#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3742
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 default:
3744 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003745 }
3746
3747 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 if (used > buf_len) {
3749 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3750 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003751
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003753}
3754
3755/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003756 * Public wrapper for ssl_session_save()
3757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003758int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3759 unsigned char *buf,
3760 size_t buf_len,
3761 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003762{
Gilles Peskine449bd832023-01-11 14:50:10 +01003763 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003764}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003765
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003766/*
3767 * Deserialize session, see mbedtls_ssl_session_save() for format.
3768 *
3769 * This internal version is wrapped by a public function that cleans up in
3770 * case of error, and has an extra option omit_header.
3771 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003772MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003773static int ssl_session_load(mbedtls_ssl_session *session,
3774 unsigned char omit_header,
3775 const unsigned char *buf,
3776 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003777{
3778 const unsigned char *p = buf;
3779 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003780 size_t remaining_len;
3781
3782
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 if (session == NULL) {
3784 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3785 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003786
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003788 /*
3789 * Check Mbed TLS version identifier
3790 */
3791
Gilles Peskine449bd832023-01-11 14:50:10 +01003792 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3793 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003794 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003795
3796 if (memcmp(p, ssl_serialized_session_header,
3797 sizeof(ssl_serialized_session_header)) != 0) {
3798 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3799 }
3800 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003801 }
3802
3803 /*
3804 * TLS version identifier
3805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 if (1 > (size_t) (end - p)) {
3807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3808 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003809 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003810
3811 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003812 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003813 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003814#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 case MBEDTLS_SSL_VERSION_TLS1_2:
3816 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003817#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3818
Jerry Yu438ddd82022-07-07 06:55:50 +00003819#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 case MBEDTLS_SSL_VERSION_TLS1_3:
3821 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003822#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3823
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 default:
3825 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003826 }
3827}
3828
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003829/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003830 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003832int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3833 const unsigned char *buf,
3834 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003835{
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003837
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 if (ret != 0) {
3839 mbedtls_ssl_session_free(session);
3840 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003843}
3844
3845/*
Paul Bakker1961b702013-01-25 14:49:24 +01003846 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003847 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003848MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003849static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003850{
3851 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3852
Ronald Cron66dbf912022-02-02 15:33:46 +01003853 /*
3854 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003855 * that were written into the output buffer by the previous handshake step,
3856 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003857 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3858 * We proceed to the next handshake step only when all data from the
3859 * previous one have been sent to the peer, thus we make sure that this is
3860 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3861 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3862 * we have to wait before to go ahead.
3863 * In the case of TLS 1.3, handshake step handlers do not send data to the
3864 * peer. Data are only sent here and through
3865 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003866 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3869 return ret;
3870 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003871
3872#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3874 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3875 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3876 return ret;
3877 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003878 }
3879#endif /* MBEDTLS_SSL_PROTO_DTLS */
3880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003882}
3883
Gilles Peskine449bd832023-01-11 14:50:10 +01003884int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003885{
Hanno Becker41934dd2021-08-07 19:13:43 +01003886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003887
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003889 ssl->conf == NULL ||
3890 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003893 }
3894
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 ret = ssl_prepare_handshake_step(ssl);
3896 if (ret != 0) {
3897 return ret;
3898 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003899
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 ret = mbedtls_ssl_handle_pending_alert(ssl);
3901 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003902 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 }
Jerry Yue7047812021-09-13 19:26:39 +08003904
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003905 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3906 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3907 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3911 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003912 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003913
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003915 case MBEDTLS_SSL_HELLO_REQUEST:
3916 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003917 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003918 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003919
Ronald Cron9f0fba32022-02-10 16:45:15 +01003920 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003922 break;
3923
3924 default:
3925#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3927 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3928 } else {
3929 ret = mbedtls_ssl_handshake_client_step(ssl);
3930 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003931#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003933#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003935#endif
3936 }
Jerry Yub9930e72021-08-06 17:11:51 +08003937 }
Ronald Cron6291b232023-03-08 15:51:25 +01003938#endif /* MBEDTLS_SSL_CLI_C */
3939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003940#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003942#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3943 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003945 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 ret = mbedtls_ssl_handshake_server_step(ssl);
3947 }
Ronald Cron6291b232023-03-08 15:51:25 +01003948#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3949 ret = mbedtls_ssl_handshake_server_step(ssl);
3950#else
3951 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003952#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003953 }
3954#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003955
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003957 /* handshake_step return error. And it is same
3958 * with alert_reason.
3959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 if (ssl->send_alert) {
3961 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003962 goto cleanup;
3963 }
3964 }
3965
3966cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003968}
3969
3970/*
3971 * Perform the SSL handshake
3972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003973int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003974{
3975 int ret = 0;
3976
Hanno Beckera817ea42020-10-20 15:20:23 +01003977 /* Sanity checks */
3978
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 if (ssl == NULL || ssl->conf == NULL) {
3980 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3981 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003982
Hanno Beckera817ea42020-10-20 15:20:23 +01003983#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3985 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3986 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3987 "mbedtls_ssl_set_timer_cb() for DTLS"));
3988 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003989 }
3990#endif /* MBEDTLS_SSL_PROTO_DTLS */
3991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003993
Hanno Beckera817ea42020-10-20 15:20:23 +01003994 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3996 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003997
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003999 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 }
Paul Bakker1961b702013-01-25 14:49:24 +01004001 }
4002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004006}
4007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004008#if defined(MBEDTLS_SSL_RENEGOTIATION)
4009#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004010/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004011 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004012 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004013MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004014static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004015{
Janos Follath865b3eb2019-12-16 11:46:15 +00004016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004019
4020 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004021 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4022 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4025 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4026 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027 }
4028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004030
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004032}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004033#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004034
4035/*
4036 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004037 * - any side: calling mbedtls_ssl_renegotiate(),
4038 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4039 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004040 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004041 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004042 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004044int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004045{
Janos Follath865b3eb2019-12-16 11:46:15 +00004046 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if ((ret = ssl_handshake_init(ssl)) != 0) {
4051 return ret;
4052 }
Paul Bakker48916f92012-09-16 19:57:18 +00004053
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004054 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4055 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4058 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4059 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004060 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004062 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004064 }
4065#endif
4066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004067 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4068 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004069
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4071 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4072 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004073 }
4074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004078}
4079
4080/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004081 * Renegotiate current connection on client,
4082 * or request renegotiation on server
4083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004084int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004085{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004086 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004087
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 if (ssl == NULL || ssl->conf == NULL) {
4089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4090 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004092#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004093 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4095 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4097 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004099 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004100
4101 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 if (ssl->out_left != 0) {
4103 return mbedtls_ssl_flush_output(ssl);
4104 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004107 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004108#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004110#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004111 /*
4112 * On client, either start the renegotiation process or,
4113 * if already in progress, continue the handshake
4114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4116 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004118 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004119
4120 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4121 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4122 return ret;
4123 }
4124 } else {
4125 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4126 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4127 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004128 }
4129 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004131
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004133}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004134#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004137{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004138 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004141 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004143
Valerio Setti6f0441d2023-07-03 12:11:36 +02004144#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004145#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (ssl->handshake->group_list_heap_allocated) {
4147 mbedtls_free((void *) handshake->group_list);
4148 }
Brett Warrene0edc842021-08-17 09:53:13 +01004149 handshake->group_list = NULL;
4150#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004151#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004152
Ronald Crone68ab4f2022-10-05 12:46:29 +02004153#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004154#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (ssl->handshake->sig_algs_heap_allocated) {
4156 mbedtls_free((void *) handshake->sig_algs);
4157 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004158 handshake->sig_algs = NULL;
4159#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004160#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (ssl->handshake->certificate_request_context) {
4162 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004163 }
4164#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004165#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004166
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004167#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4169 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004170 handshake->async_in_progress = 0;
4171 }
4172#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4173
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004174#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004175#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004177#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004178 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004179#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004180#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004181#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004182#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004184#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004185 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004186#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004187#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004189#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004191#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004192#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004193 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004195#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004196
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004197#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004198#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004200 /*
4201 * Opaque keys are not stored in the handshake's data and it's the user
4202 * responsibility to destroy them. Clear ones, instead, are created by
4203 * the TLS library and should be destroyed at the same level
4204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4206 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004207 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004208 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4209#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004211#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004212#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004214 handshake->ecjpake_cache = NULL;
4215 handshake->ecjpake_cache_len = 0;
4216#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004217#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004218
Valerio Setti7aeec542023-07-05 18:57:21 +02004219#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004220 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004221 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004222 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004224#endif
4225
Ronald Cron73fe8df2022-10-05 14:31:43 +02004226#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004227#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004229 /* The maintenance of the external PSK key slot is the
4230 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (ssl->handshake->psk_opaque_is_internal) {
4232 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004233 ssl->handshake->psk_opaque_is_internal = 0;
4234 }
4235 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4236 }
Neil Armstronge952a302022-05-03 10:22:14 +02004237#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004239 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004240 }
Neil Armstronge952a302022-05-03 10:22:14 +02004241#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004242#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004243
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004244#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4245 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004246 /*
4247 * Free only the linked list wrapper, not the keys themselves
4248 * since the belong to the SNI callback
4249 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004251#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004252
Gilles Peskineeccd8882020-03-10 12:19:08 +01004253#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4255 if (handshake->ecrs_peer_cert != NULL) {
4256 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4257 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004258 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004259#endif
4260
Hanno Becker75173122019-02-06 16:18:31 +00004261#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4262 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004264#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4265
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004266#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4268 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004269#endif /* MBEDTLS_SSL_CLI_C &&
4270 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004271
4272#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 mbedtls_ssl_flight_free(handshake->flight);
4274 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004275#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004276
Valerio Settiea59c432023-07-25 11:14:03 +02004277#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004278 if (handshake->xxdh_psa_privkey_is_external == 0) {
4279 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 }
Valerio Settiea59c432023-07-25 11:14:03 +02004281#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004282
Ronald Cron6f135e12021-12-08 16:57:54 +01004283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 mbedtls_ssl_transform_free(handshake->transform_handshake);
4285 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004286#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4288 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004289#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004290#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004291
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004292
4293#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4294 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4295 * processes datagrams and the fact that a datagram is allowed to have
4296 * several records in it, it is possible that the I/O buffers are not
4297 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4299 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004300#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004301
Jerry Yuba9c7272021-10-30 11:54:10 +08004302 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 mbedtls_platform_zeroize(handshake,
4304 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004305}
4306
Gilles Peskine449bd832023-01-11 14:50:10 +01004307void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004308{
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004310 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004313#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004315#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004316
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004317#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004318#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4319 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004321#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004323#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004326}
4327
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004328#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004329
4330#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4331#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4332#else
4333#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4334#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4335
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004336#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004337
4338#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4339#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4340#else
4341#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4342#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4343
4344#if defined(MBEDTLS_SSL_ALPN)
4345#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4346#else
4347#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4348#endif /* MBEDTLS_SSL_ALPN */
4349
4350#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4351#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4352#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4353#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4354
4355#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 ((uint32_t) ( \
4357 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4358 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4359 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4360 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4361 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4362 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4363 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4364 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004365
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004366static unsigned char ssl_serialized_context_header[] = {
4367 MBEDTLS_VERSION_MAJOR,
4368 MBEDTLS_VERSION_MINOR,
4369 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4371 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4372 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4373 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4374 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004375};
4376
Paul Bakker5121ce52009-01-03 21:22:43 +00004377/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004378 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004379 *
4380 * The format of the serialized data is:
4381 * (in the presentation language of TLS, RFC 8446 section 3)
4382 *
4383 * // header
4384 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004385 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004386 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004387 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004388 * Note: When updating the format, remember to keep these
4389 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004390 *
4391 * // session sub-structure
4392 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4393 * // transform sub-structure
4394 * uint8 random[64]; // ServerHello.random+ClientHello.random
4395 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4396 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4397 * // fields from ssl_context
4398 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4399 * uint64 in_window_top; // DTLS: last validated record seq_num
4400 * uint64 in_window; // DTLS: bitmask for replay protection
4401 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4402 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4403 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4404 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4405 *
4406 * Note that many fields of the ssl_context or sub-structures are not
4407 * serialized, as they fall in one of the following categories:
4408 *
4409 * 1. forced value (eg in_left must be 0)
4410 * 2. pointer to dynamically-allocated memory (eg session, transform)
4411 * 3. value can be re-derived from other data (eg session keys from MS)
4412 * 4. value was temporary (eg content of input buffer)
4413 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4416 unsigned char *buf,
4417 size_t buf_len,
4418 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004419{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004420 unsigned char *p = buf;
4421 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004422 size_t session_len;
4423 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004424
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004425 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004426 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4427 * this function's documentation.
4428 *
4429 * These are due to assumptions/limitations in the implementation. Some of
4430 * them are likely to stay (no handshake in progress) some might go away
4431 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004432 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004433 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4435 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004437 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (ssl->handshake != NULL) {
4439 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004441 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004442 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (ssl->transform == NULL || ssl->session == NULL) {
4444 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4445 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004446 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004447 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (mbedtls_ssl_check_pending(ssl) != 0) {
4449 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004451 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (ssl->out_left != 0) {
4453 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4454 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004455 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004456 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4458 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4459 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004460 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004461 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4463 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4464 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004465 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004466 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4468 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4469 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004470 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004471 /* Renegotiation must not be enabled */
4472#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4474 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004476 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004477#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004478
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004479 /*
4480 * Version and format identifier
4481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (used <= buf_len) {
4485 memcpy(p, ssl_serialized_context_header,
4486 sizeof(ssl_serialized_context_header));
4487 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004488 }
4489
4490 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004491 * Session (length + data)
4492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4494 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4495 return ret;
4496 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004497
4498 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (used <= buf_len) {
4500 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004501 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 ret = ssl_session_save(ssl->session, 1,
4504 p, session_len, &session_len);
4505 if (ret != 0) {
4506 return ret;
4507 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004508
4509 p += session_len;
4510 }
4511
4512 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004513 * Transform
4514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 used += sizeof(ssl->transform->randbytes);
4516 if (used <= buf_len) {
4517 memcpy(p, ssl->transform->randbytes,
4518 sizeof(ssl->transform->randbytes));
4519 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004520 }
4521
4522#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004523 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004525 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004527 p += ssl->transform->in_cid_len;
4528
4529 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004531 p += ssl->transform->out_cid_len;
4532 }
4533#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4534
4535 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004536 * Saved fields from top-level ssl_context structure
4537 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004538 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (used <= buf_len) {
4540 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004541 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004542 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004543
4544#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4545 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 if (used <= buf_len) {
4547 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004548 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004551 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004552 }
4553#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4554
4555#if defined(MBEDTLS_SSL_PROTO_DTLS)
4556 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004558 *p++ = ssl->disable_datagram_packing;
4559 }
4560#endif /* MBEDTLS_SSL_PROTO_DTLS */
4561
Jerry Yuae0b2e22021-10-08 15:21:19 +08004562 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 if (used <= buf_len) {
4564 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004565 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004566 }
4567
4568#if defined(MBEDTLS_SSL_PROTO_DTLS)
4569 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (used <= buf_len) {
4571 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004572 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004573 }
4574#endif /* MBEDTLS_SSL_PROTO_DTLS */
4575
4576#if defined(MBEDTLS_SSL_ALPN)
4577 {
4578 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004580 : 0;
4581
4582 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004584 *p++ = alpn_len;
4585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 if (ssl->alpn_chosen != NULL) {
4587 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004588 p += alpn_len;
4589 }
4590 }
4591 }
4592#endif /* MBEDTLS_SSL_ALPN */
4593
4594 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004595 * Done
4596 */
4597 *olen = used;
4598
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if (used > buf_len) {
4600 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4601 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004606}
4607
4608/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004609 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004610 *
4611 * This internal version is wrapped by a public function that cleans up in
4612 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004613 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004614MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004615static int ssl_context_load(mbedtls_ssl_context *ssl,
4616 const unsigned char *buf,
4617 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004618{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004619 const unsigned char *p = buf;
4620 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004621 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004622 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004623#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004624 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004625#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004626
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004627 /*
4628 * The context should have been freshly setup or reset.
4629 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004630 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004631 * renegotiating, or if the user mistakenly loaded a session first.)
4632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4634 ssl->session != NULL) {
4635 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004636 }
4637
4638 /*
4639 * We can't check that the config matches the initial one, but we can at
4640 * least check it matches the requirements for serializing.
4641 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004642 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004643#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004644 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004645#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004646 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4647 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4648 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4649 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004651 }
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004654
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004655 /*
4656 * Check version identifier
4657 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004660 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004661
4662 if (memcmp(p, ssl_serialized_context_header,
4663 sizeof(ssl_serialized_context_header)) != 0) {
4664 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4665 }
4666 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004667
4668 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004669 * Session
4670 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 if ((size_t) (end - p) < 4) {
4672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4673 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004674
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004675 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004676 p += 4;
4677
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004678 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004679 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004680 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004681 ssl->session_in = ssl->session;
4682 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004683 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004684
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 if ((size_t) (end - p) < session_len) {
4686 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4687 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 ret = ssl_session_load(ssl->session, 1, p, session_len);
4690 if (ret != 0) {
4691 mbedtls_ssl_session_free(ssl->session);
4692 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004693 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004694
4695 p += session_len;
4696
4697 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004698 * Transform
4699 */
4700
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004701 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004702 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004703#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004704 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004705 ssl->transform_in = ssl->transform;
4706 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004707 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004708#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004709
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004710#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4712 if (prf_func == NULL) {
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4714 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004715
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004716 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4719 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 ret = ssl_tls12_populate_transform(ssl->transform,
4722 ssl->session->ciphersuite,
4723 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004724#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004726#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 prf_func,
4728 p, /* currently pointing to randbytes */
4729 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4730 ssl->conf->endpoint,
4731 ssl);
4732 if (ret != 0) {
4733 return ret;
4734 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004735#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004737
4738#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4739 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if ((size_t) (end - p) < 1) {
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4742 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004743
4744 ssl->transform->in_cid_len = *p++;
4745
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4748 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004751 p += ssl->transform->in_cid_len;
4752
4753 ssl->transform->out_cid_len = *p++;
4754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4757 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004760 p += ssl->transform->out_cid_len;
4761#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4762
4763 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004764 * Saved fields from top-level ssl_context structure
4765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if ((size_t) (end - p) < 4) {
4767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4768 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004769
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004770 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004771 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004772
4773#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if ((size_t) (end - p) < 16) {
4775 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4776 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004777
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004778 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004779 p += 8;
4780
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004781 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004782 p += 8;
4783#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4784
4785#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if ((size_t) (end - p) < 1) {
4787 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4788 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004789
4790 ssl->disable_datagram_packing = *p++;
4791#endif /* MBEDTLS_SSL_PROTO_DTLS */
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4795 }
4796 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4797 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004798
4799#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if ((size_t) (end - p) < 2) {
4801 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4802 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004803
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004804 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004805 p += 2;
4806#endif /* MBEDTLS_SSL_PROTO_DTLS */
4807
4808#if defined(MBEDTLS_SSL_ALPN)
4809 {
4810 uint8_t alpn_len;
4811 const char **cur;
4812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if ((size_t) (end - p) < 1) {
4814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4815 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004816
4817 alpn_len = *p++;
4818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004820 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4822 if (strlen(*cur) == alpn_len &&
4823 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004824 ssl->alpn_chosen = *cur;
4825 break;
4826 }
4827 }
4828 }
4829
4830 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4832 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4833 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004834
4835 p += alpn_len;
4836 }
4837#endif /* MBEDTLS_SSL_ALPN */
4838
4839 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004840 * Forced fields from top-level ssl_context structure
4841 *
4842 * Most of them already set to the correct value by mbedtls_ssl_init() and
4843 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4844 */
4845 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004846 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004847
Hanno Becker361b10d2019-08-30 10:42:49 +01004848 /* Adjust pointers for header fields of outgoing records to
4849 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004851
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004852#if defined(MBEDTLS_SSL_PROTO_DTLS)
4853 ssl->in_epoch = 1;
4854#endif
4855
4856 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4857 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004858 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4859 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (ssl->handshake != NULL) {
4861 mbedtls_ssl_handshake_free(ssl);
4862 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004863 ssl->handshake = NULL;
4864 }
4865
4866 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004867 * Done - should have consumed entire buffer
4868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (p != end) {
4870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4871 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004874}
4875
4876/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004877 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004879int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4880 const unsigned char *buf,
4881 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004882{
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (ret != 0) {
4886 mbedtls_ssl_free(context);
4887 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004890}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004891#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004892
4893/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 * Free an SSL context
4895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004896void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004897{
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004899 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004905#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4906 size_t out_buf_len = ssl->out_buf_len;
4907#else
4908 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4909#endif
4910
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004911 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004912 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004913 }
4914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004916#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4917 size_t in_buf_len = ssl->in_buf_len;
4918#else
4919 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4920#endif
4921
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004922 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004923 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004924 }
4925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (ssl->transform) {
4927 mbedtls_ssl_transform_free(ssl->transform);
4928 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004929 }
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (ssl->handshake) {
4932 mbedtls_ssl_handshake_free(ssl);
4933 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004934
4935#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4937 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004938#endif
4939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 mbedtls_ssl_session_free(ssl->session_negotiate);
4941 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004942 }
4943
Ronald Cron6f135e12021-12-08 16:57:54 +01004944#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 mbedtls_ssl_transform_free(ssl->transform_application);
4946 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004947#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if (ssl->session) {
4950 mbedtls_ssl_session_free(ssl->session);
4951 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004952 }
4953
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004954#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004956 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004957 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004958#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004959
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004960#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004962#endif
4963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004965
Paul Bakker86f04f42013-02-14 11:20:09 +01004966 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004968}
4969
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004970/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004971 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004973void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004974{
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004976}
4977
Gilles Peskineae270bf2021-06-02 00:05:29 +02004978/* The selection should be the same as mbedtls_x509_crt_profile_default in
4979 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004980 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004981 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004982 * about this list.
4983 */
Brett Warrene0edc842021-08-17 09:53:13 +01004984static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004985#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004986 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004987#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004988#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004989 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004990#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004991#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004992 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004993#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004994#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004995 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004996#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004997#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004998 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004999#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005000#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005001 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005002#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005003#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005004 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005005#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005006#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005007 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005008#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005009#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005010 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5011 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5012 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5013 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5014 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5015#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005016 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005017};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005018
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005019static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005020 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5021 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5022 0
5023};
5024
Ronald Crone68ab4f2022-10-05 12:46:29 +02005025#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005026
Jerry Yu909df7b2022-01-22 11:56:27 +08005027/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005028 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005029 * rules SHOULD be upheld.
5030 * - No duplicate entries.
5031 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005032 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005033 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005034 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005035static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005036
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005037#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005038 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005039 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005040 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005041 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5042#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005043
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005044#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005045 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005046 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005047 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005048 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5049#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005050
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005051#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005053 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005054 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005055 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5056#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005059 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005060 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005061#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005062 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005065 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005066 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005067#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005068 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005071 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005072 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005073#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005074 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005075
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005076#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005077 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005078#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005079
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005080#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005081 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005083
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005084#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005085 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005087
Gabor Mezei15b95a62022-05-09 16:37:58 +02005088 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005089};
5090
5091/* NOTICE: see above */
5092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5093static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005094#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005095#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005097#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005098#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5099 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5100#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005101#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005103#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005104#endif /* MBEDTLS_MD_CAN_SHA512*/
5105#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005106#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005108#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005109#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5110 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5111#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005112#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005114#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005115#endif /* MBEDTLS_MD_CAN_SHA384*/
5116#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005117#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005119#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005120#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5121 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5122#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005123#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005125#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005126#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005127 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005128};
5129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5130/* NOTICE: see above */
5131static uint16_t ssl_preset_suiteb_sig_algs[] = {
5132
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005133#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005134 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005135 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005136 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005137 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5138#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005139
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005140#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005141 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005142 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005143 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005144 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5145#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005148 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005149 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005150#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005151 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005152
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005153#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005154 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005155#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005156
Gabor Mezei15b95a62022-05-09 16:37:58 +02005157 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005158};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005159
Jerry Yu909df7b2022-01-22 11:56:27 +08005160/* NOTICE: see above */
5161#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5162static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005163#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005164#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005166#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005167#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005169#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005170#endif /* MBEDTLS_MD_CAN_SHA256*/
5171#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005172#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005174#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005175#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005177#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005178#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005179 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005180};
Jerry Yu909df7b2022-01-22 11:56:27 +08005181#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5182
Ronald Crone68ab4f2022-10-05 12:46:29 +02005183#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005184
Brett Warrene0edc842021-08-17 09:53:13 +01005185static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005186#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005187 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005188#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005189#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005190 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005191#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005192 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005193};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005194
Ronald Crone68ab4f2022-10-05 12:46:29 +02005195#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005196/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005197 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005198MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005199static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005200{
5201 size_t i, j;
5202 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5205 for (j = 0; j < i; j++) {
5206 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005207 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 }
5209 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5210 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5211 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005212 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005213 }
5214 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005216}
5217
Ronald Crone68ab4f2022-10-05 12:46:29 +02005218#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005219
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005220/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005221 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005222 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005223int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5224 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005225{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005226#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005228#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005229
Ronald Crone68ab4f2022-10-05 12:46:29 +02005230#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5232 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5233 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005234 }
5235
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5237 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5238 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005239 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005240
5241#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5243 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5244 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005245 }
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5248 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5249 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005250 }
5251#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005252#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005253
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005254 /* Use the functions here so that they are covered in tests,
5255 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 mbedtls_ssl_conf_endpoint(conf, endpoint);
5257 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005258
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005259 /*
5260 * Things that are common to all presets
5261 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005262#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005264 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5265#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5266 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5267#endif
5268 }
5269#endif
5270
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5272 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5273#endif
5274
5275#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5276 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5277#endif
5278
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005279#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005280 conf->f_cookie_write = ssl_cookie_write_dummy;
5281 conf->f_cookie_check = ssl_cookie_check_dummy;
5282#endif
5283
5284#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5285 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5286#endif
5287
Janos Follath088ce432017-04-10 12:42:31 +01005288#if defined(MBEDTLS_SSL_SRV_C)
5289 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005290 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005291#endif
5292
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005293#if defined(MBEDTLS_SSL_PROTO_DTLS)
5294 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5295 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5296#endif
5297
5298#if defined(MBEDTLS_SSL_RENEGOTIATION)
5299 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 memset(conf->renego_period, 0x00, 2);
5301 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005302#endif
5303
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005304#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005306 const unsigned char dhm_p[] =
5307 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5308 const unsigned char dhm_g[] =
5309 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005310
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5312 dhm_p, sizeof(dhm_p),
5313 dhm_g, sizeof(dhm_g))) != 0) {
5314 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005315 }
5316 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005317#endif
5318
Ronald Cron6f135e12021-12-08 16:57:54 +01005319#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005320
5321#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005322 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005323#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005324 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005325#endif
5326#endif /* MBEDTLS_SSL_EARLY_DATA */
5327
Jerry Yud0766ec2022-09-22 10:46:57 +08005328#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005329 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005331#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005332 /*
5333 * Allow all TLS 1.3 key exchange modes by default.
5334 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005335 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005336#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005337
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005340 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005341 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005342#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005344#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005346#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005347 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5348 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005349#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5350 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5351 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5352#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5353 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5354 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5355#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005357#endif
5358 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005359
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005360 /*
5361 * Preset-specific defaults
5362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364 /*
5365 * NSA Suite B
5366 */
5367 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005368
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005369 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005370
5371#if defined(MBEDTLS_X509_CRT_PARSE_C)
5372 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005373#endif
5374
Ronald Crone68ab4f2022-10-05 12:46:29 +02005375#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005376#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005378 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005380#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005382#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005383
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005384#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005385 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005386#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005387 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005388 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005389
5390 /*
5391 * Default
5392 */
5393 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005394
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005395 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005396
5397#if defined(MBEDTLS_X509_CRT_PARSE_C)
5398 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5399#endif
5400
Ronald Crone68ab4f2022-10-05 12:46:29 +02005401#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005402#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005404 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005406#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005408#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005409
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005410#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005411 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005412#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005413 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005414
5415#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5416 conf->dhm_min_bitlen = 1024;
5417#endif
5418 }
5419
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005421}
5422
5423/*
5424 * Free mbedtls_ssl_config
5425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005426void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005427{
5428#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 mbedtls_mpi_free(&conf->dhm_P);
5430 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005431#endif
5432
Ronald Cron73fe8df2022-10-05 14:31:43 +02005433#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005434#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005436 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5437 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005438#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005440 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005441 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005442 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005443 }
5444
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005446 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005447 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005448 conf->psk_identity_len = 0;
5449 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005450#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005451
5452#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005454#endif
5455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005457}
5458
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005459#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005460 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005461/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005464unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005465{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5468 return MBEDTLS_SSL_SIG_RSA;
5469 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005470#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005471#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5473 return MBEDTLS_SSL_SIG_ECDSA;
5474 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005475#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005477}
5478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005480{
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005482 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005484 case MBEDTLS_PK_ECDSA:
5485 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005487 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005489 }
5490}
5491
Gilles Peskine449bd832023-01-11 14:50:10 +01005492mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005493{
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495#if defined(MBEDTLS_RSA_C)
5496 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005498#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005499#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005502#endif
5503 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005505 }
5506}
Valerio Settie9646ec2023-08-02 20:02:28 +02005507#endif /* MBEDTLS_PK_C &&
5508 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005509
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005510/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005511 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005513mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005514{
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005516#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005519#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005520#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005523#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005524#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005527#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005528#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005531#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005532#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005535#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005536#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005539#endif
5540 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005542 }
5543}
5544
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005545/*
5546 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005548unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005549{
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005551#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005552 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005554#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005555#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005556 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005558#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005559#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005560 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005562#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005563#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005564 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005566#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005567#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005568 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005570#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005571#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005572 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005574#endif
5575 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005577 }
5578}
5579
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005580/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005581 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005582 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005584int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005585{
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005587
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 if (group_list == NULL) {
5589 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005590 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005591
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 for (; *group_list != 0; group_list++) {
5593 if (*group_list == tls_id) {
5594 return 0;
5595 }
5596 }
5597
5598 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005599}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005600
Valerio Setti49e69072023-06-27 17:27:51 +02005601#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005602/*
5603 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005605int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005606{
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005608
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005610 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005612
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005614}
Valerio Setti49e69072023-06-27 17:27:51 +02005615#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005616
Valerio Setti18c9fed2022-12-30 17:44:24 +01005617static const struct {
5618 uint16_t tls_id;
5619 mbedtls_ecp_group_id ecp_group_id;
5620 psa_ecc_family_t psa_family;
5621 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622} tls_id_match_table[] =
5623{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005624#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005625 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005626#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005627#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005628 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005629#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005630#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005631 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005633#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005634 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005636#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005637 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005638#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005639#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005640 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005641#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005642#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005643 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005645#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005646 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005648#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005649 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005651#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005652 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005653#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005654#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005655 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005658 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005659#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005660#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005661 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005662#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005663 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664};
5665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005667 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005669{
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5671 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005672 if (type != NULL) {
5673 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 }
5675 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005676 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678 return PSA_SUCCESS;
5679 }
5680 }
5681
5682 return PSA_ERROR_NOT_SUPPORTED;
5683}
5684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005686{
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5688 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005689 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005691 }
5692
5693 return MBEDTLS_ECP_DP_NONE;
5694}
5695
Gilles Peskine449bd832023-01-11 14:50:10 +01005696uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005697{
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5699 i++) {
5700 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005701 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005703 }
5704
5705 return 0;
5706}
5707
Valerio Setti67419f02023-01-04 16:12:42 +01005708#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005709static const struct {
5710 uint16_t tls_id;
5711 const char *name;
5712} tls_id_curve_name_table[] =
5713{
Valerio Setti54e23792023-07-07 10:49:27 +02005714 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5715 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5716 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5717 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5718 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5719 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5720 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5721 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5722 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5723 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5724 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5725 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5726 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005727 { 0, NULL },
5728};
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005731{
Valerio Settiacd32c02023-06-29 18:06:29 +02005732 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5733 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5734 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005736 }
5737
5738 return NULL;
5739}
Valerio Setti67419f02023-01-04 16:12:42 +01005740#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005742#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005743int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5744 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5745 int cert_endpoint,
5746 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005747{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005748 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005749 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005750 const char *ext_oid;
5751 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005754 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756 case MBEDTLS_KEY_EXCHANGE_RSA:
5757 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005758 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005759 break;
5760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5762 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5763 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5764 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005765 break;
5766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005767 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5768 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005769 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005770 break;
5771
5772 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773 case MBEDTLS_KEY_EXCHANGE_NONE:
5774 case MBEDTLS_KEY_EXCHANGE_PSK:
5775 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5776 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005777 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005778 usage = 0;
5779 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005781 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5782 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005783 }
5784
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005786 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005787 ret = -1;
5788 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005789
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5793 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005794 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005796 }
5797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005799 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005800 ret = -1;
5801 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005802
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005804}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005805#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005806
Jerry Yu148165c2021-09-24 23:20:59 +08005807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005808int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5809 const mbedtls_md_type_t md,
5810 unsigned char *dst,
5811 size_t dst_len,
5812 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005813{
Ronald Cronf6893e12022-01-07 22:09:01 +01005814 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5815 psa_hash_operation_t *hash_operation_to_clone;
5816 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5817
Jerry Yu148165c2021-09-24 23:20:59 +08005818 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005819
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005821#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 case MBEDTLS_MD_SHA384:
5823 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5824 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005825#endif
5826
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005827#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 case MBEDTLS_MD_SHA256:
5829 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5830 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005831#endif
5832
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 default:
5834 goto exit;
5835 }
5836
5837 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5838 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005839 goto exit;
5840 }
5841
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5843 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005844 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005846
5847exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005848#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5849 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005850 (void) ssl;
5851#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005852 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005853}
5854#else /* MBEDTLS_USE_PSA_CRYPTO */
5855
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005856#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005857MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005858static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5859 unsigned char *dst,
5860 size_t dst_len,
5861 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005863 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005864 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005865
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 if (dst_len < 48) {
5867 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5868 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005869
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005870 mbedtls_md_init(&sha384);
5871 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005872 if (ret != 0) {
5873 goto exit;
5874 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005875 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005876 if (ret != 0) {
5877 goto exit;
5878 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005880 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005881 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005882 goto exit;
5883 }
5884
5885 *olen = 48;
5886
5887exit:
5888
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005889 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005891}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005892#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005893
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005894#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005895MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005896static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5897 unsigned char *dst,
5898 size_t dst_len,
5899 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005900{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005901 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005902 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005903
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 if (dst_len < 32) {
5905 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5906 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005907
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005908 mbedtls_md_init(&sha256);
5909 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5910 if (ret != 0) {
5911 goto exit;
5912 }
5913 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5914 if (ret != 0) {
5915 goto exit;
5916 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005917
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005918 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5919 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005920 goto exit;
5921 }
5922
5923 *olen = 32;
5924
5925exit:
5926
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005927 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005929}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005930#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5933 const mbedtls_md_type_t md,
5934 unsigned char *dst,
5935 size_t dst_len,
5936 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005937{
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005940#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 case MBEDTLS_MD_SHA384:
5942 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005943#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005944
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005945#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 case MBEDTLS_MD_SHA256:
5947 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005948#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005951#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5952 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 (void) ssl;
5954 (void) dst;
5955 (void) dst_len;
5956 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005957#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005959 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005961}
XiaokangQian647719a2021-12-07 09:16:29 +00005962
Jerry Yu148165c2021-09-24 23:20:59 +08005963#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005964
Ronald Crone68ab4f2022-10-05 12:46:29 +02005965#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005966/* mbedtls_ssl_parse_sig_alg_ext()
5967 *
5968 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5969 * value (TLS 1.3 RFC8446):
5970 * enum {
5971 * ....
5972 * ecdsa_secp256r1_sha256( 0x0403 ),
5973 * ecdsa_secp384r1_sha384( 0x0503 ),
5974 * ecdsa_secp521r1_sha512( 0x0603 ),
5975 * ....
5976 * } SignatureScheme;
5977 *
5978 * struct {
5979 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5980 * } SignatureSchemeList;
5981 *
5982 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5983 * value (TLS 1.2 RFC5246):
5984 * enum {
5985 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5986 * sha512(6), (255)
5987 * } HashAlgorithm;
5988 *
5989 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5990 * SignatureAlgorithm;
5991 *
5992 * struct {
5993 * HashAlgorithm hash;
5994 * SignatureAlgorithm signature;
5995 * } SignatureAndHashAlgorithm;
5996 *
5997 * SignatureAndHashAlgorithm
5998 * supported_signature_algorithms<2..2^16-2>;
5999 *
6000 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6001 * generalization of the TLS 1.2 signature algorithm extension.
6002 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6003 * `SignatureScheme` field of TLS 1.3
6004 *
6005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006006int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6007 const unsigned char *buf,
6008 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006009{
6010 const unsigned char *p = buf;
6011 size_t supported_sig_algs_len = 0;
6012 const unsigned char *supported_sig_algs_end;
6013 uint16_t sig_alg;
6014 uint32_t common_idx = 0;
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6017 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006018 p += 2;
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 memset(ssl->handshake->received_sig_algs, 0,
6021 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006024 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 while (p < supported_sig_algs_end) {
6026 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6027 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006028 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6030 sig_alg,
6031 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006032#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6034 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6035 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006036 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006037 }
6038#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6041 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006044 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6045 common_idx += 1;
6046 }
6047 }
6048 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 if (p != end) {
6050 MBEDTLS_SSL_DEBUG_MSG(1,
6051 ("Signature algorithms extension length misaligned"));
6052 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6053 MBEDTLS_ERR_SSL_DECODE_ERROR);
6054 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006055 }
6056
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (common_idx == 0) {
6058 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6059 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6060 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6061 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006062 }
6063
Gabor Mezei15b95a62022-05-09 16:37:58 +02006064 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006066}
6067
Ronald Crone68ab4f2022-10-05 12:46:29 +02006068#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006069
Jerry Yudc7bd172022-02-17 13:44:15 +08006070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6071
6072#if defined(MBEDTLS_USE_PSA_CRYPTO)
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6075 mbedtls_svc_key_id_t key,
6076 psa_algorithm_t alg,
6077 const unsigned char *raw_psk, size_t raw_psk_length,
6078 const unsigned char *seed, size_t seed_length,
6079 const unsigned char *label, size_t label_length,
6080 const unsigned char *other_secret,
6081 size_t other_secret_length,
6082 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006083{
6084 psa_status_t status;
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 status = psa_key_derivation_setup(derivation, alg);
6087 if (status != PSA_SUCCESS) {
6088 return status;
6089 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006090
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6092 status = psa_key_derivation_input_bytes(derivation,
6093 PSA_KEY_DERIVATION_INPUT_SEED,
6094 seed, seed_length);
6095 if (status != PSA_SUCCESS) {
6096 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006097 }
6098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (other_secret != NULL) {
6100 status = psa_key_derivation_input_bytes(derivation,
6101 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6102 other_secret, other_secret_length);
6103 if (status != PSA_SUCCESS) {
6104 return status;
6105 }
6106 }
6107
6108 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 status = psa_key_derivation_input_bytes(
6110 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 raw_psk, raw_psk_length);
6112 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (status != PSA_SUCCESS) {
6117 return status;
6118 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 status = psa_key_derivation_input_bytes(derivation,
6121 PSA_KEY_DERIVATION_INPUT_LABEL,
6122 label, label_length);
6123 if (status != PSA_SUCCESS) {
6124 return status;
6125 }
6126 } else {
6127 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006128 }
6129
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 status = psa_key_derivation_set_capacity(derivation, capacity);
6131 if (status != PSA_SUCCESS) {
6132 return status;
6133 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006134
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006136}
6137
Andrzej Kurek57d10632022-10-24 10:32:01 -04006138#if defined(PSA_WANT_ALG_SHA_384) || \
6139 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006141static int tls_prf_generic(mbedtls_md_type_t md_type,
6142 const unsigned char *secret, size_t slen,
6143 const char *label,
6144 const unsigned char *random, size_t rlen,
6145 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006146{
6147 psa_status_t status;
6148 psa_algorithm_t alg;
6149 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6150 psa_key_derivation_operation_t derivation =
6151 PSA_KEY_DERIVATION_OPERATION_INIT;
6152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006154 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006156 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006158
6159 /* Normally a "secret" should be long enough to be impossible to
6160 * find by brute force, and in particular should not be empty. But
6161 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6162 * and for this use case it makes sense to have a 0-length "secret".
6163 * Since the key API doesn't allow importing a key of length 0,
6164 * keep master_key=0, which setup_psa_key_derivation() understands
6165 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006167 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6169 psa_set_key_algorithm(&key_attributes, alg);
6170 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6173 if (status != PSA_SUCCESS) {
6174 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6175 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006176 }
6177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 status = setup_psa_key_derivation(&derivation,
6179 master_key, alg,
6180 NULL, 0,
6181 random, rlen,
6182 (unsigned char const *) label,
6183 (size_t) strlen(label),
6184 NULL, 0,
6185 dlen);
6186 if (status != PSA_SUCCESS) {
6187 psa_key_derivation_abort(&derivation);
6188 psa_destroy_key(master_key);
6189 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006190 }
6191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6193 if (status != PSA_SUCCESS) {
6194 psa_key_derivation_abort(&derivation);
6195 psa_destroy_key(master_key);
6196 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006197 }
6198
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 status = psa_key_derivation_abort(&derivation);
6200 if (status != PSA_SUCCESS) {
6201 psa_destroy_key(master_key);
6202 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006203 }
6204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if (!mbedtls_svc_key_id_is_null(master_key)) {
6206 status = psa_destroy_key(master_key);
6207 }
6208 if (status != PSA_SUCCESS) {
6209 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6210 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006213}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006214#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006215#else /* MBEDTLS_USE_PSA_CRYPTO */
6216
Andrzej Kurek57d10632022-10-24 10:32:01 -04006217#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006218 (defined(MBEDTLS_MD_CAN_SHA256) || \
6219 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006220MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006221static int tls_prf_generic(mbedtls_md_type_t md_type,
6222 const unsigned char *secret, size_t slen,
6223 const char *label,
6224 const unsigned char *random, size_t rlen,
6225 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006226{
6227 size_t nb;
6228 size_t i, j, k, md_len;
6229 unsigned char *tmp;
6230 size_t tmp_len = 0;
6231 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6232 const mbedtls_md_info_t *md_info;
6233 mbedtls_md_context_t md_ctx;
6234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006237
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6239 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6240 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 tmp_len = md_len + strlen(label) + rlen;
6245 tmp = mbedtls_calloc(1, tmp_len);
6246 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6248 goto exit;
6249 }
6250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 nb = strlen(label);
6252 memcpy(tmp + md_len, label, nb);
6253 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 nb += rlen;
6255
6256 /*
6257 * Compute P_<hash>(secret, label + random)[0..dlen]
6258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6264 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006265 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 }
6267 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6268 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006269 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 }
6271 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6272 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 for (i = 0; i < dlen; i += md_len) {
6277 ret = mbedtls_md_hmac_reset(&md_ctx);
6278 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006279 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 }
6281 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6282 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
6285 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6286 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006287 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 ret = mbedtls_md_hmac_reset(&md_ctx);
6291 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006292 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
6294 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6295 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006296 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 }
6298 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6299 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006302
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006304
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006306 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006308 }
6309
6310exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006312
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (tmp != NULL) {
6314 mbedtls_platform_zeroize(tmp, tmp_len);
6315 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006318
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006322}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006323#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006324#endif /* MBEDTLS_USE_PSA_CRYPTO */
6325
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006326#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006327MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006328static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6329 const char *label,
6330 const unsigned char *random, size_t rlen,
6331 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006332{
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6334 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006335}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006336#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006337
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006338#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006339MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006340static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6341 const char *label,
6342 const unsigned char *random, size_t rlen,
6343 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006344{
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6346 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006347}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006348#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006349
Jerry Yuf009d862022-02-17 14:01:37 +08006350/*
6351 * Set appropriate PRF function and other SSL / TLS1.2 functions
6352 *
6353 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006354 * - hash associated with the ciphersuite (only used by TLS 1.2)
6355 *
6356 * Outputs:
6357 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6358 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006359MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006360static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6361 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006362{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006363#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006365 handshake->tls_prf = tls_prf_sha384;
6366 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6367 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006369#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006370#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006371 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006372 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006373 handshake->tls_prf = tls_prf_sha256;
6374 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6375 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6376 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006377#else
Jerry Yuf009d862022-02-17 14:01:37 +08006378 {
Jerry Yuf009d862022-02-17 14:01:37 +08006379 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006380 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006382 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006383#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006384
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006386}
Jerry Yud6ab2352022-02-17 14:03:43 +08006387
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006388/*
6389 * Compute master secret if needed
6390 *
6391 * Parameters:
6392 * [in/out] handshake
6393 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6394 * (PSA-PSK) ciphersuite_info, psk_opaque
6395 * [out] premaster (cleared)
6396 * [out] master
6397 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6398 * debug: conf->f_dbg, conf->p_dbg
6399 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006400 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006402MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006403static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6404 unsigned char *master,
6405 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006406{
6407 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6408
6409 /* cf. RFC 5246, Section 8.1:
6410 * "The master secret is always exactly 48 bytes in length." */
6411 size_t const master_secret_len = 48;
6412
6413#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6414 unsigned char session_hash[48];
6415#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6416
6417 /* The label for the KDF used for key expansion.
6418 * This is either "master secret" or "extended master secret"
6419 * depending on whether the Extended Master Secret extension
6420 * is used. */
6421 char const *lbl = "master secret";
6422
Przemek Stekielae4ed302022-04-05 17:15:55 +02006423 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424 * - If the Extended Master Secret extension is not used,
6425 * this is ClientHello.Random + ServerHello.Random
6426 * (see Sect. 8.1 in RFC 5246).
6427 * - If the Extended Master Secret extension is used,
6428 * this is the transcript of the handshake so far.
6429 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006430 unsigned char const *seed = handshake->randbytes;
6431 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006432
6433#if !defined(MBEDTLS_DEBUG_C) && \
6434 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6435 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437 ssl = NULL; /* make sure we don't use it except for those cases */
6438 (void) ssl;
6439#endif
6440
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (handshake->resume != 0) {
6442 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6443 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006444 }
6445
6446#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006449 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006450 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6451 if (ret != 0) {
6452 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6453 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6456 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006457 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006458#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459
Przemek Stekiel99114f32022-04-22 11:20:09 +02006460#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006461 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006463 /* Perform PSK-to-MS expansion in a single step. */
6464 psa_status_t status;
6465 psa_algorithm_t alg;
6466 mbedtls_svc_key_id_t psk;
6467 psa_key_derivation_operation_t derivation =
6468 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006469 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006472
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006476 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006480
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006481 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006485 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006486 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006487 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006488 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006489 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006490 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006491 other_secret_len = 48;
6492 other_secret = handshake->premaster + 2;
6493 break;
6494 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006495 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006496 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6497 other_secret = handshake->premaster + 2;
6498 break;
6499 default:
6500 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006501 }
6502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 status = setup_psa_key_derivation(&derivation, psk, alg,
6504 ssl->conf->psk, ssl->conf->psk_len,
6505 seed, seed_len,
6506 (unsigned char const *) lbl,
6507 (size_t) strlen(lbl),
6508 other_secret, other_secret_len,
6509 master_secret_len);
6510 if (status != PSA_SUCCESS) {
6511 psa_key_derivation_abort(&derivation);
6512 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513 }
6514
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 status = psa_key_derivation_output_bytes(&derivation,
6516 master,
6517 master_secret_len);
6518 if (status != PSA_SUCCESS) {
6519 psa_key_derivation_abort(&derivation);
6520 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521 }
6522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 status = psa_key_derivation_abort(&derivation);
6524 if (status != PSA_SUCCESS) {
6525 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6526 }
6527 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528#endif
6529 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006530#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6532 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006533 psa_status_t status;
6534 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6535 psa_key_derivation_operation_t derivation =
6536 PSA_KEY_DERIVATION_OPERATION_INIT;
6537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006539
6540 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 status = psa_key_derivation_setup(&derivation, alg);
6543 if (status != PSA_SUCCESS) {
6544 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006545 }
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 status = psa_key_derivation_set_capacity(&derivation,
6548 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6549 if (status != PSA_SUCCESS) {
6550 psa_key_derivation_abort(&derivation);
6551 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006552 }
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6555 &derivation);
6556 if (status != PSA_SUCCESS) {
6557 psa_key_derivation_abort(&derivation);
6558 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006559 }
6560
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 status = psa_key_derivation_output_bytes(&derivation,
6562 handshake->premaster,
6563 handshake->pmslen);
6564 if (status != PSA_SUCCESS) {
6565 psa_key_derivation_abort(&derivation);
6566 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6567 }
6568
6569 status = psa_key_derivation_abort(&derivation);
6570 if (status != PSA_SUCCESS) {
6571 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006572 }
6573 }
6574#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6576 lbl, seed, seed_len,
6577 master,
6578 master_secret_len);
6579 if (ret != 0) {
6580 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6581 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006582 }
6583
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6585 handshake->premaster,
6586 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006587
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 mbedtls_platform_zeroize(handshake->premaster,
6589 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006590 }
6591
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006593}
6594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006596{
6597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6598 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6599 ssl->handshake->ciphersuite_info;
6600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006602
6603 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006605 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 if (ret != 0) {
6607 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6608 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006609 }
6610
6611 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 ret = ssl_compute_master(ssl->handshake,
6613 ssl->session_negotiate->master,
6614 ssl);
6615 if (ret != 0) {
6616 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6617 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006618 }
6619
6620 /* Swap the client and server random values:
6621 * - MS derivation wanted client+server (RFC 5246 8.1)
6622 * - key derivation wants server+client (RFC 5246 6.3) */
6623 {
6624 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006625 memcpy(tmp, ssl->handshake->randbytes, 64);
6626 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6627 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6628 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006629 }
6630
6631 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6633 ssl->session_negotiate->ciphersuite,
6634 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006635#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006637#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 ssl->handshake->tls_prf,
6639 ssl->handshake->randbytes,
6640 ssl->tls_version,
6641 ssl->conf->endpoint,
6642 ssl);
6643 if (ret != 0) {
6644 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6645 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006646 }
6647
6648 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6650 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006653
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006655}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006656
Gilles Peskine449bd832023-01-11 14:50:10 +01006657int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006658{
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006660#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006661 case MBEDTLS_SSL_HASH_SHA384:
6662 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6663 break;
6664#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006665#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006666 case MBEDTLS_SSL_HASH_SHA256:
6667 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6668 break;
6669#endif
6670 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006672 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006673#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6674 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006675 (void) ssl;
6676#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006678}
6679
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006680#if defined(MBEDTLS_USE_PSA_CRYPTO)
6681static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6682 const psa_hash_operation_t *hs_op,
6683 size_t buffer_size,
6684 unsigned char *hash,
6685 size_t *hlen)
6686{
6687 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006688 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006689
6690#if !defined(MBEDTLS_DEBUG_C)
6691 (void) ssl;
6692#endif
6693 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006694 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006695 if (status != PSA_SUCCESS) {
6696 goto exit;
6697 }
6698
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006699 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006700 if (status != PSA_SUCCESS) {
6701 goto exit;
6702 }
6703
6704 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6705 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6706
6707exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006708 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006709 return mbedtls_md_error_from_psa(status);
6710}
6711#else
6712static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6713 const mbedtls_md_context_t *hs_ctx,
6714 unsigned char *hash,
6715 size_t *hlen)
6716{
6717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006718 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006719
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006720 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006721
6722#if !defined(MBEDTLS_DEBUG_C)
6723 (void) ssl;
6724#endif
6725 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6726
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006727 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006728 if (ret != 0) {
6729 goto exit;
6730 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006731 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006732 if (ret != 0) {
6733 goto exit;
6734 }
6735
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006736 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006737 if (ret != 0) {
6738 goto exit;
6739 }
6740
6741 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6742
6743 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6744 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6745
6746exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006747 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006748 return ret;
6749}
6750#endif /* MBEDTLS_USE_PSA_CRYPTO */
6751
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006752#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006753int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6754 unsigned char *hash,
6755 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006756{
6757#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6759 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006760#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006761 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6762 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006763#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006764}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006765#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006766
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006767#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006768int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6769 unsigned char *hash,
6770 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006771{
6772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006773 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6774 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006775#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006776 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6777 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006778#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006779}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006780#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006781
Neil Armstrong80f6f322022-05-03 17:56:38 +02006782#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6783 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006784int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006785{
6786 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006788 const unsigned char *psk = NULL;
6789 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006793 /*
6794 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006795 * checked before calling this function.
6796 *
6797 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006798 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006799 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6801 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6802 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006803 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006804 }
6805
6806 /*
6807 * PMS = struct {
6808 * opaque other_secret<0..2^16-1>;
6809 * opaque psk<0..2^16-1>;
6810 * };
6811 * with "other_secret" depending on the particular key exchange
6812 */
6813#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6815 if (end - p < 2) {
6816 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6817 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006820 p += 2;
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if (end < p || (size_t) (end - p) < psk_len) {
6823 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6824 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006827 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006829#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6830#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006832 /*
6833 * other_secret already set by the ClientKeyExchange message,
6834 * and is 48 bytes long
6835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 if (end - p < 2) {
6837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6838 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006839
6840 *p++ = 0;
6841 *p++ = 48;
6842 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006844#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6845#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6848 size_t len;
6849
6850 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006852 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6854 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6855 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006856 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006858 p += 2 + len;
6859
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6861 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006862#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006863#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6866 size_t zlen;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006869 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6871 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6872 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006873 }
6874
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006876 p += 2 + zlen;
6877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6879 MBEDTLS_DEBUG_ECDH_Z);
6880 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006881#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006882 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6884 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006885 }
6886
6887 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 if (end - p < 2) {
6889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6890 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006893 p += 2;
6894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (end < p || (size_t) (end - p) < psk_len) {
6896 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6897 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006900 p += psk_len;
6901
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006902 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006905}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006906#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006907
6908#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006909MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006910static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006911
6912#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006913int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006914{
6915 /* If renegotiation is not enforced, retransmit until we would reach max
6916 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006918 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6919 unsigned char doublings = 1;
6920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006922 ++doublings;
6923 ratio >>= 1;
6924 }
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (++ssl->renego_records_seen > doublings) {
6927 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6928 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006929 }
6930 }
6931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006933}
6934#endif
6935#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006936
Jerry Yud9526692022-02-17 14:23:47 +08006937/*
6938 * Handshake functions
6939 */
6940#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6941/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006942int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006943{
6944 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6945 ssl->handshake->ciphersuite_info;
6946
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006948
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6950 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006951 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006953 }
6954
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6956 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006957}
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006960{
6961 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6962 ssl->handshake->ciphersuite_info;
6963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6967 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006968 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006970 }
6971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6973 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006974}
6975
6976#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6977/* Some certificate support -> implement write and parse */
6978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006980{
6981 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6982 size_t i, n;
6983 const mbedtls_x509_crt *crt;
6984 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6985 ssl->handshake->ciphersuite_info;
6986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6990 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006991 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006993 }
6994
6995#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6997 if (ssl->handshake->client_auth == 0) {
6998 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006999 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007001 }
7002 }
7003#endif /* MBEDTLS_SSL_CLI_C */
7004#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7006 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007007 /* Should never happen because we shouldn't have picked the
7008 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007010 }
7011 }
7012#endif
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007015
7016 /*
7017 * 0 . 0 handshake type
7018 * 1 . 3 handshake length
7019 * 4 . 6 length of all certs
7020 * 7 . 9 length of cert. 1
7021 * 10 . n-1 peer certificate
7022 * n . n+2 length of cert. 2
7023 * n+3 . ... upper level cert, etc.
7024 */
7025 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007027
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007029 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7031 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7032 " > %" MBEDTLS_PRINTF_SIZET,
7033 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7034 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007035 }
7036
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7038 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7039 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007040
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007042 i += n; crt = crt->next;
7043 }
7044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7046 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7047 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007048
7049 ssl->out_msglen = i;
7050 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7051 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7052
7053 ssl->state++;
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7056 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7057 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007058 }
7059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007063}
7064
7065#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7066
7067#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007068MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007069static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7070 unsigned char *crt_buf,
7071 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007072{
7073 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7074
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 if (peer_crt == NULL) {
7076 return -1;
7077 }
Jerry Yud9526692022-02-17 14:23:47 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (peer_crt->raw.len != crt_buf_len) {
7080 return -1;
7081 }
Jerry Yud9526692022-02-17 14:23:47 +08007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007084}
7085#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007087static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7088 unsigned char *crt_buf,
7089 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007090{
7091 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7092 unsigned char const * const peer_cert_digest =
7093 ssl->session->peer_cert_digest;
7094 mbedtls_md_type_t const peer_cert_digest_type =
7095 ssl->session->peer_cert_digest_type;
7096 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007098 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7099 size_t digest_len;
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 if (peer_cert_digest == NULL || digest_info == NULL) {
7102 return -1;
7103 }
Jerry Yud9526692022-02-17 14:23:47 +08007104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 digest_len = mbedtls_md_get_size(digest_info);
7106 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7107 return -1;
7108 }
Jerry Yud9526692022-02-17 14:23:47 +08007109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7111 if (ret != 0) {
7112 return -1;
7113 }
Jerry Yud9526692022-02-17 14:23:47 +08007114
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007116}
7117#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7118#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7119
7120/*
7121 * Once the certificate message is read, parse it into a cert chain and
7122 * perform basic checks, but leave actual verification to the caller
7123 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007124MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007125static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7126 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007127{
7128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7129#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007131#endif
7132 size_t i, n;
7133 uint8_t alert;
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7136 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7137 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7138 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7139 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007140 }
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7143 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7144 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7145 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7149 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7150 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7151 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7152 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007153 }
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007156
7157 /*
7158 * Same message structure as in mbedtls_ssl_write_certificate()
7159 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007160 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007161
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 if (ssl->in_msg[i] != 0 ||
7163 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7164 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7165 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7166 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7167 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007168 }
7169
7170 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7171 i += 3;
7172
7173 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007175 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (i + 3 > ssl->in_hslen) {
7177 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7178 mbedtls_ssl_send_alert_message(ssl,
7179 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7180 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7181 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007182 }
7183 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7184 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 if (ssl->in_msg[i] != 0) {
7186 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7187 mbedtls_ssl_send_alert_message(ssl,
7188 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7189 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7190 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007191 }
7192
7193 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007194 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007195 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{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007722 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007723 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{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007922 int ret;
7923 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007924
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007926
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007928
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007929 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7930 if (ret != 0) {
7931 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7932 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933
7934 /*
7935 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7936 * may define some other value. Currently (early 2016), no defined
7937 * ciphersuite does this (and this is unlikely to change as activity has
7938 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7939 */
7940 hash_len = 12;
7941
7942#if defined(MBEDTLS_SSL_RENEGOTIATION)
7943 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945#endif
7946
7947 ssl->out_msglen = 4 + hash_len;
7948 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7949 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7950
7951 /*
7952 * In case of session resuming, invert the client and server
7953 * ChangeCipherSpec messages order.
7954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007956#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007958 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960#endif
7961#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007963 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007965#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007967 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007969
7970 /*
7971 * Switch to our negotiated transform and session parameters for outbound
7972 * data.
7973 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975
7976#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007978 unsigned char i;
7979
7980 /* Remember current epoch settings for resending */
7981 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7983 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984
7985 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007987
7988
7989 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 for (i = 2; i > 0; i--) {
7991 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007992 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 }
7994 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995
7996 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 if (i == 0) {
7998 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7999 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008002#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004
8005 ssl->transform_out = ssl->transform_negotiate;
8006 ssl->session_out = ssl->session_negotiate;
8007
8008#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8010 mbedtls_ssl_send_flight_completed(ssl);
8011 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012#endif
8013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8015 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8016 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008017 }
8018
8019#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8021 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8022 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8023 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008024 }
8025#endif
8026
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008028
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008030}
8031
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008032#define SSL_MAX_HASH_LEN 12
8033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008035{
8036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8037 unsigned int hash_len = 12;
8038 unsigned char buf[SSL_MAX_HASH_LEN];
8039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008041
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008042 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8043 if (ret != 0) {
8044 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8045 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8048 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049 goto exit;
8050 }
8051
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8053 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8054 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8055 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008056 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8057 goto exit;
8058 }
8059
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8061 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8062 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008063 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8064 goto exit;
8065 }
8066
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8068 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8069 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8070 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008071 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8072 goto exit;
8073 }
8074
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8076 buf, hash_len) != 0) {
8077 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8078 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8079 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008080 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8081 goto exit;
8082 }
8083
8084#if defined(MBEDTLS_SSL_RENEGOTIATION)
8085 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008087#endif
8088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008090#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008092 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008094#endif
8095#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008097 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008099#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008101 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008103
8104#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8106 mbedtls_ssl_recv_flight_completed(ssl);
8107 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008108#endif
8109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008111
8112exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 mbedtls_platform_zeroize(buf, hash_len);
8114 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008115}
8116
Jerry Yu392112c2022-02-17 14:34:10 +08008117#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8118/*
8119 * Helper to get TLS 1.2 PRF from ciphersuite
8120 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008122static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008123{
Jerry Yu392112c2022-02-17 14:34:10 +08008124 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008126#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8128 return tls_prf_sha384;
8129 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008130#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008131#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008132 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8134 return tls_prf_sha256;
8135 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008136 }
8137#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008138#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8139 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008140 (void) ciphersuite_info;
8141#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008142
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008144}
8145#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008148{
8149 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008150#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 if (tls_prf == tls_prf_sha384) {
8152 return MBEDTLS_SSL_TLS_PRF_SHA384;
8153 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008154#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008155#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 if (tls_prf == tls_prf_sha256) {
8157 return MBEDTLS_SSL_TLS_PRF_SHA256;
8158 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008159#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008161}
8162
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008163/*
8164 * Populate a transform structure with session keys and all the other
8165 * necessary information.
8166 *
8167 * Parameters:
8168 * - [in/out]: transform: structure to populate
8169 * [in] must be just initialised with mbedtls_ssl_transform_init()
8170 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8171 * - [in] ciphersuite
8172 * - [in] master
8173 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008174 * - [in] tls_prf: pointer to PRF to use for key derivation
8175 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008176 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008177 * - [in] endpoint: client or server
8178 * - [in] ssl: used for:
8179 * - ssl->conf->{f,p}_export_keys
8180 * [in] optionally used for:
8181 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8182 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008183MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008184static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8185 int ciphersuite,
8186 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008187#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008189#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 ssl_tls_prf_t tls_prf,
8191 const unsigned char randbytes[64],
8192 mbedtls_ssl_protocol_version tls_version,
8193 unsigned endpoint,
8194 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008195{
8196 int ret = 0;
8197 unsigned char keyblk[256];
8198 unsigned char *key1;
8199 unsigned char *key2;
8200 unsigned char *mac_enc;
8201 unsigned char *mac_dec;
8202 size_t mac_key_len = 0;
8203 size_t iv_copy_len;
8204 size_t keylen;
8205 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008206 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008207#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008208 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008209 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008210#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008211
8212#if defined(MBEDTLS_USE_PSA_CRYPTO)
8213 psa_key_type_t key_type;
8214 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8215 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008216 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008217 size_t key_bits;
8218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8219#endif
8220
8221#if !defined(MBEDTLS_DEBUG_C) && \
8222 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224 ssl = NULL; /* make sure we don't use it except for these cases */
8225 (void) ssl;
8226 }
8227#endif
8228
8229 /*
8230 * Some data just needs copying into the structure
8231 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008232#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008233 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008234#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008235 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008236
8237#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008239#endif
8240
8241#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8244 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008246 }
8247#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8248
8249 /*
8250 * Get various info structures
8251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8253 if (ciphersuite_info == NULL) {
8254 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8255 ciphersuite));
8256 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008257 }
8258
Neil Armstrongab555e02022-04-04 11:07:59 +02008259 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008260#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008262#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008264
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008266 transform->taglen =
8267 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008269
8270#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008271 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 transform->taglen,
8273 &alg,
8274 &key_type,
8275 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008276 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008278 goto end;
8279 }
8280#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008281 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 if (cipher_info == NULL) {
8283 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8284 ciphersuite_info->cipher));
8285 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008286 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008287#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288
Neil Armstronge4512952022-03-08 09:08:22 +01008289#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008290 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008292 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 (unsigned) ciphersuite_info->mac));
8294 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008295 }
8296#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008297 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 if (md_info == NULL) {
8299 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8300 (unsigned) ciphersuite_info->mac));
8301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008302 }
Neil Armstronge4512952022-03-08 09:08:22 +01008303#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008304
8305#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8306 /* Copy own and peer's CID if the use of the CID
8307 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8309 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008310
8311 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8313 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8314 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008315
8316 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8318 ssl->handshake->peer_cid_len);
8319 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8320 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008321 }
8322#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8323
8324 /*
8325 * Compute key block using the PRF
8326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8328 if (ret != 0) {
8329 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8330 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008331 }
8332
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8334 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8335 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8336 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8337 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338
8339 /*
8340 * Determine the appropriate key, IV and MAC length.
8341 */
8342
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008343#if defined(MBEDTLS_USE_PSA_CRYPTO)
8344 keylen = PSA_BITS_TO_BYTES(key_bits);
8345#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008347#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008348
Valerio Settie5707042023-10-11 11:54:42 +02008349#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008351 size_t explicit_ivlen;
8352
8353 transform->maclen = 0;
8354 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355
8356 /* All modes haves 96-bit IVs, but the length of the static parts vary
8357 * with mode and version:
8358 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8359 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8360 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8361 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8362 * sequence number).
8363 */
8364 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008365
8366 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008367#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008369#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8371 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008372#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008373
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008375 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008377 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379
8380 /* Minimum length of encrypted record */
8381 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8382 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 } else
Valerio Settie5707042023-10-11 11:54:42 +02008384#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008385#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008387 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008389#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008391#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008392 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008393#endif /* MBEDTLS_USE_PSA_CRYPTO */
8394
8395#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008396 /* Get MAC length */
8397 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8398#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008399 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8401 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8402 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 goto end;
8404 }
8405
8406 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008408#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008409 transform->maclen = mac_key_len;
8410
8411 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008414#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008415 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008416#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008417
8418 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422 /*
8423 * GenericBlockCipher:
8424 * 1. if EtM is in use: one block plus MAC
8425 * otherwise: * first multiple of blocklen greater than maclen
8426 * 2. IV
8427 */
8428#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 + block_size;
8432 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008433#endif
8434 {
8435 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 + block_size
8437 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438 }
8439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 } else {
8443 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008444 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8445 goto end;
8446 }
8447 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008449#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8450 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8452 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453 }
8454
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8456 (unsigned) keylen,
8457 (unsigned) transform->minlen,
8458 (unsigned) transform->ivlen,
8459 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008460
8461 /*
8462 * Finally setup the cipher contexts, IVs and MAC secrets.
8463 */
8464#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008466 key1 = keyblk + mac_key_len * 2;
8467 key2 = keyblk + mac_key_len * 2 + keylen;
8468
8469 mac_enc = keyblk;
8470 mac_dec = keyblk + mac_key_len;
8471
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 iv_copy_len = (transform->fixed_ivlen) ?
8473 transform->fixed_ivlen : transform->ivlen;
8474 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8475 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8476 iv_copy_len);
8477 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008478#endif /* MBEDTLS_SSL_CLI_C */
8479#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 key1 = keyblk + mac_key_len * 2 + keylen;
8482 key2 = keyblk + mac_key_len * 2;
8483
8484 mac_enc = keyblk + mac_key_len;
8485 mac_dec = keyblk;
8486
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 iv_copy_len = (transform->fixed_ivlen) ?
8488 transform->fixed_ivlen : transform->ivlen;
8489 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8490 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8491 iv_copy_len);
8492 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008493#endif /* MBEDTLS_SSL_SRV_C */
8494 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8497 goto end;
8498 }
8499
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 if (ssl != NULL && ssl->f_export_keys != NULL) {
8501 ssl->f_export_keys(ssl->p_export_keys,
8502 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8503 master, 48,
8504 randbytes + 32,
8505 randbytes,
8506 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008507 }
8508
8509#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008510 transform->psa_alg = alg;
8511
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8513 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8514 psa_set_key_algorithm(&attributes, alg);
8515 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008516
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if ((status = psa_import_key(&attributes,
8518 key1,
8519 PSA_BITS_TO_BYTES(key_bits),
8520 &transform->psa_key_enc)) != PSA_SUCCESS) {
8521 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008522 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 goto end;
8525 }
8526
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 if ((status = psa_import_key(&attributes,
8530 key2,
8531 PSA_BITS_TO_BYTES(key_bits),
8532 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008533 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535 goto end;
8536 }
8537 }
8538#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8540 cipher_info)) != 0) {
8541 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008542 goto end;
8543 }
8544
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8546 cipher_info)) != 0) {
8547 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008548 goto end;
8549 }
8550
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8552 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8553 MBEDTLS_ENCRYPT)) != 0) {
8554 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008555 goto end;
8556 }
8557
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8559 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8560 MBEDTLS_DECRYPT)) != 0) {
8561 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008562 goto end;
8563 }
8564
8565#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8567 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8568 MBEDTLS_PADDING_NONE)) != 0) {
8569 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570 goto end;
8571 }
8572
Gilles Peskine449bd832023-01-11 14:50:10 +01008573 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8574 MBEDTLS_PADDING_NONE)) != 0) {
8575 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578 }
8579#endif /* MBEDTLS_CIPHER_MODE_CBC */
8580#endif /* MBEDTLS_USE_PSA_CRYPTO */
8581
Neil Armstrong29c0c042022-03-17 17:47:28 +01008582#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8583 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8584 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008586#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008588
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8590 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8591 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008592
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 if ((status = psa_import_key(&attributes,
8594 mac_enc, mac_key_len,
8595 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008596 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008598 goto end;
8599 }
8600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8602 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008603#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008605#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008607 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8609 PSA_KEY_USAGE_VERIFY_HASH);
8610 } else {
8611 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8612 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if ((status = psa_import_key(&attributes,
8615 mac_dec, mac_key_len,
8616 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008617 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008619 goto end;
8620 }
8621#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8623 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008624 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 }
8626 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8627 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008628 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008630#endif /* MBEDTLS_USE_PSA_CRYPTO */
8631 }
8632#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8633
8634 ((void) mac_dec);
8635 ((void) mac_enc);
8636
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008637end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8639 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008640}
8641
Valerio Settia08b1a42022-11-17 15:10:02 +01008642#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8643 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008644int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 psa_pake_operation_t *pake_ctx,
8646 const unsigned char *buf,
8647 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008648{
8649 psa_status_t status;
8650 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008651 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008652 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8653 * At round two perform a single cycle
8654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008656
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 for (; remaining_steps > 0; remaining_steps--) {
8658 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008659 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008661 /* Length is stored at the first byte */
8662 size_t length = buf[input_offset];
8663 input_offset += 1;
8664
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008666 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8667 }
8668
Gilles Peskine449bd832023-01-11 14:50:10 +01008669 status = psa_pake_input(pake_ctx, step,
8670 buf + input_offset, length);
8671 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008672 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008673 }
8674
8675 input_offset += length;
8676 }
8677 }
8678
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008680 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008682
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008684}
8685
Valerio Setti6b3dab02022-11-17 17:14:54 +01008686int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 psa_pake_operation_t *pake_ctx,
8688 unsigned char *buf,
8689 size_t len, size_t *olen,
8690 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008691{
8692 psa_status_t status;
8693 size_t output_offset = 0;
8694 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008695 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008696 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8697 * At round two perform a single cycle
8698 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008700
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 for (; remaining_steps > 0; remaining_steps--) {
8702 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8703 step <= PSA_PAKE_STEP_ZK_PROOF;
8704 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008705 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008706 * For each step, prepend 1 byte with the length of the data as
8707 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 status = psa_pake_output(pake_ctx, step,
8710 buf + output_offset + 1,
8711 len - output_offset - 1,
8712 &output_len);
8713 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008714 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008715 }
8716
Valerio Setti99d88c12022-11-22 16:03:43 +01008717 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008718
8719 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008720 }
8721 }
8722
8723 *olen = output_offset;
8724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008726}
Valerio Settia08b1a42022-11-17 15:10:02 +01008727#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8728
Jerry Yuee40f9d2022-02-17 14:55:16 +08008729#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008730int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8731 unsigned char *hash, size_t *hashlen,
8732 unsigned char *data, size_t data_len,
8733 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008734{
8735 psa_status_t status;
8736 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008737 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008740
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 if ((status = psa_hash_setup(&hash_operation,
8742 hash_alg)) != PSA_SUCCESS) {
8743 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008744 goto exit;
8745 }
8746
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8748 64)) != PSA_SUCCESS) {
8749 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750 goto exit;
8751 }
8752
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 if ((status = psa_hash_update(&hash_operation,
8754 data, data_len)) != PSA_SUCCESS) {
8755 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008756 goto exit;
8757 }
8758
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8760 hashlen)) != PSA_SUCCESS) {
8761 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8762 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763 }
8764
8765exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 if (status != PSA_SUCCESS) {
8767 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8768 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8769 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008771 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008772 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8773 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008775 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008777 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779 }
8780 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008781 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008782}
8783
8784#else
8785
Gilles Peskine449bd832023-01-11 14:50:10 +01008786int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8787 unsigned char *hash, size_t *hashlen,
8788 unsigned char *data, size_t data_len,
8789 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008790{
8791 int ret = 0;
8792 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8794 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008795
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008797
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799
8800 /*
8801 * digitally-signed struct {
8802 * opaque client_random[32];
8803 * opaque server_random[32];
8804 * ServerDHParams params;
8805 * };
8806 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8808 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008809 goto exit;
8810 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008811 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8812 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813 goto exit;
8814 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8816 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008817 goto exit;
8818 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8820 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008821 goto exit;
8822 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008823 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8824 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008825 goto exit;
8826 }
8827
8828exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008830
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 if (ret != 0) {
8832 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8833 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8834 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008835
Gilles Peskine449bd832023-01-11 14:50:10 +01008836 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008837}
8838#endif /* MBEDTLS_USE_PSA_CRYPTO */
8839
Jerry Yud9d91da2022-02-17 14:57:06 +08008840#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8841
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008842/* Find the preferred hash for a given signature algorithm. */
8843unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008844 mbedtls_ssl_context *ssl,
8845 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008846{
Gabor Mezei078e8032022-04-27 21:17:56 +02008847 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008848 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008849
Gilles Peskine449bd832023-01-11 14:50:10 +01008850 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8851 return MBEDTLS_SSL_HASH_NONE;
8852 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008853
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008855 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8857 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008858 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8860 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008861
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008862 mbedtls_md_type_t md_alg =
8863 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8864 if (md_alg == MBEDTLS_MD_NONE) {
8865 continue;
8866 }
8867
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008871 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008872 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008873
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8875 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8876 PSA_ALG_ECDSA(psa_hash_alg),
8877 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008878 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008880
Gilles Peskine449bd832023-01-11 14:50:10 +01008881 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8882 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8883 PSA_ALG_RSA_PKCS1V15_SIGN(
8884 psa_hash_alg),
8885 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008886 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008887 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008888 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008889#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008890
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008892 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008893 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008894
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008896}
8897
8898#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8899
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008900/* Serialization of TLS 1.2 sessions:
8901 *
8902 * struct {
8903 * uint64 start_time;
8904 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008905 * uint8 session_id_len; // at most 32
8906 * opaque session_id[32];
8907 * opaque master[48]; // fixed length in the standard
8908 * uint32 verify_result;
8909 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8910 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8911 * uint32 ticket_lifetime;
8912 * uint8 mfl_code; // up to 255 according to standard
8913 * uint8 encrypt_then_mac; // 0 or 1
8914 * } serialized_session_tls12;
8915 *
8916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008917static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8918 unsigned char *buf,
8919 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008920{
8921 unsigned char *p = buf;
8922 size_t used = 0;
8923
8924#if defined(MBEDTLS_HAVE_TIME)
8925 uint64_t start;
8926#endif
8927#if defined(MBEDTLS_X509_CRT_PARSE_C)
8928#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8929 size_t cert_len;
8930#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8931#endif /* MBEDTLS_X509_CRT_PARSE_C */
8932
8933 /*
8934 * Time
8935 */
8936#if defined(MBEDTLS_HAVE_TIME)
8937 used += 8;
8938
Gilles Peskine449bd832023-01-11 14:50:10 +01008939 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 start = (uint64_t) session->start;
8941
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943 p += 8;
8944 }
8945#endif /* MBEDTLS_HAVE_TIME */
8946
8947 /*
8948 * Basic mandatory fields
8949 */
8950 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008951 + 1 /* id_len */
8952 + sizeof(session->id)
8953 + sizeof(session->master)
8954 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008955
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 if (used <= buf_len) {
8957 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008958 p += 2;
8959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 *p++ = MBEDTLS_BYTE_0(session->id_len);
8961 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962 p += 32;
8963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008965 p += 48;
8966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008968 p += 4;
8969 }
8970
8971 /*
8972 * Peer's end-entity certificate
8973 */
8974#if defined(MBEDTLS_X509_CRT_PARSE_C)
8975#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008979 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008981
8982 used += 3 + cert_len;
8983
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 if (used <= buf_len) {
8985 *p++ = MBEDTLS_BYTE_2(cert_len);
8986 *p++ = MBEDTLS_BYTE_1(cert_len);
8987 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 if (session->peer_cert != NULL) {
8990 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008991 p += cert_len;
8992 }
8993 }
8994#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008996 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998 *p++ = (unsigned char) session->peer_cert_digest_type;
8999 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 memcpy(p, session->peer_cert_digest,
9001 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002 p += session->peer_cert_digest_len;
9003 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009005 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9008 *p++ = 0;
9009 }
9010 }
9011#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9012#endif /* MBEDTLS_X509_CRT_PARSE_C */
9013
9014 /*
9015 * Session ticket if any, plus associated data
9016 */
9017#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9018 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9019
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 if (used <= buf_len) {
9021 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9022 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9023 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009024
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 if (session->ticket != NULL) {
9026 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027 p += session->ticket_len;
9028 }
9029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031 p += 4;
9032 }
9033#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9034
9035 /*
9036 * Misc extension-related info
9037 */
9038#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9039 used += 1;
9040
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044#endif
9045
9046#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9047 used += 1;
9048
Gilles Peskine449bd832023-01-11 14:50:10 +01009049 if (used <= buf_len) {
9050 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9051 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009052#endif
9053
Gilles Peskine449bd832023-01-11 14:50:10 +01009054 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009055}
9056
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009057MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009058static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9059 const unsigned char *buf,
9060 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061{
9062#if defined(MBEDTLS_HAVE_TIME)
9063 uint64_t start;
9064#endif
9065#if defined(MBEDTLS_X509_CRT_PARSE_C)
9066#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9067 size_t cert_len;
9068#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9069#endif /* MBEDTLS_X509_CRT_PARSE_C */
9070
9071 const unsigned char *p = buf;
9072 const unsigned char * const end = buf + len;
9073
9074 /*
9075 * Time
9076 */
9077#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 if (8 > (size_t) (end - p)) {
9079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9080 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009082 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083 p += 8;
9084
9085 session->start = (time_t) start;
9086#endif /* MBEDTLS_HAVE_TIME */
9087
9088 /*
9089 * Basic mandatory fields
9090 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9093 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009095 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009096 p += 2;
9097
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009098 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009100 p += 32;
9101
Gilles Peskine449bd832023-01-11 14:50:10 +01009102 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009103 p += 48;
9104
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009105 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009106 p += 4;
9107
9108 /* Immediately clear invalid pointer values that have been read, in case
9109 * we exit early before we replaced them with valid ones. */
9110#if defined(MBEDTLS_X509_CRT_PARSE_C)
9111#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9112 session->peer_cert = NULL;
9113#else
9114 session->peer_cert_digest = NULL;
9115#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9116#endif /* MBEDTLS_X509_CRT_PARSE_C */
9117#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9118 session->ticket = NULL;
9119#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9120
9121 /*
9122 * Peer certificate
9123 */
9124#if defined(MBEDTLS_X509_CRT_PARSE_C)
9125#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9126 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 if (3 > (size_t) (end - p)) {
9128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9129 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009130
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009131 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009132 p += 3;
9133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9136
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 if (cert_len > (size_t) (end - p)) {
9138 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9139 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142
Gilles Peskine449bd832023-01-11 14:50:10 +01009143 if (session->peer_cert == NULL) {
9144 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9145 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9150 p, cert_len)) != 0) {
9151 mbedtls_x509_crt_free(session->peer_cert);
9152 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009155 }
9156
9157 p += cert_len;
9158 }
9159#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9160 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 if (2 > (size_t) (end - p)) {
9162 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9163 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164
9165 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9166 session->peer_cert_digest_len = (size_t) *p++;
9167
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009169 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9171 if (md_info == NULL) {
9172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9173 }
9174 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9176 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009177
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9180 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009181
9182 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009183 mbedtls_calloc(1, session->peer_cert_digest_len);
9184 if (session->peer_cert_digest == NULL) {
9185 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9186 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009187
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 memcpy(session->peer_cert_digest, p,
9189 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009190 p += session->peer_cert_digest_len;
9191 }
9192#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9193#endif /* MBEDTLS_X509_CRT_PARSE_C */
9194
9195 /*
9196 * Session ticket and associated data
9197 */
9198#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 if (3 > (size_t) (end - p)) {
9200 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9201 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009202
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009203 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204 p += 3;
9205
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 if (session->ticket_len != 0) {
9207 if (session->ticket_len > (size_t) (end - p)) {
9208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9209 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009210
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 session->ticket = mbedtls_calloc(1, session->ticket_len);
9212 if (session->ticket == NULL) {
9213 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9214 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009215
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009217 p += session->ticket_len;
9218 }
9219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 if (4 > (size_t) (end - p)) {
9221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9222 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009223
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009224 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009225 p += 4;
9226#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9227
9228 /*
9229 * Misc extension-related info
9230 */
9231#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 if (1 > (size_t) (end - p)) {
9233 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9234 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009235
9236 session->mfl_code = *p++;
9237#endif
9238
9239#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 if (1 > (size_t) (end - p)) {
9241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9242 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009243
9244 session->encrypt_then_mac = *p++;
9245#endif
9246
9247 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 if (p != end) {
9249 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9250 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009253}
Jerry Yudc7bd172022-02-17 13:44:15 +08009254#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9255
XiaokangQian75d40ef2022-04-20 11:05:24 +00009256int mbedtls_ssl_validate_ciphersuite(
9257 const mbedtls_ssl_context *ssl,
9258 const mbedtls_ssl_ciphersuite_t *suite_info,
9259 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009261{
9262 (void) ssl;
9263
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 if (suite_info == NULL) {
9265 return -1;
9266 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009267
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 if ((suite_info->min_tls_version > max_tls_version) ||
9269 (suite_info->max_tls_version < min_tls_version)) {
9270 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009271 }
9272
XiaokangQian060d8672022-04-21 09:24:56 +00009273#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009274#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009275#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9277 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9280 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009281#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009282 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009284 }
9285#endif
9286
9287 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9288#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9290 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9291 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009292 }
9293#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9294#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9295
Gilles Peskine449bd832023-01-11 14:50:10 +01009296 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009297}
9298
Ronald Crone68ab4f2022-10-05 12:46:29 +02009299#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009300/*
9301 * Function for writing a signature algorithm extension.
9302 *
9303 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9304 * value (TLS 1.3 RFC8446):
9305 * enum {
9306 * ....
9307 * ecdsa_secp256r1_sha256( 0x0403 ),
9308 * ecdsa_secp384r1_sha384( 0x0503 ),
9309 * ecdsa_secp521r1_sha512( 0x0603 ),
9310 * ....
9311 * } SignatureScheme;
9312 *
9313 * struct {
9314 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9315 * } SignatureSchemeList;
9316 *
9317 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9318 * value (TLS 1.2 RFC5246):
9319 * enum {
9320 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9321 * sha512(6), (255)
9322 * } HashAlgorithm;
9323 *
9324 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9325 * SignatureAlgorithm;
9326 *
9327 * struct {
9328 * HashAlgorithm hash;
9329 * SignatureAlgorithm signature;
9330 * } SignatureAndHashAlgorithm;
9331 *
9332 * SignatureAndHashAlgorithm
9333 * supported_signature_algorithms<2..2^16-2>;
9334 *
9335 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9336 * generalization of the TLS 1.2 signature algorithm extension.
9337 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9338 * `SignatureScheme` field of TLS 1.3
9339 *
9340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009341int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9342 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009343{
9344 unsigned char *p = buf;
9345 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9346 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9347
9348 *out_len = 0;
9349
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009351
9352 /* Check if we have space for header and length field:
9353 * - extension_type (2 bytes)
9354 * - extension_data_length (2 bytes)
9355 * - supported_signature_algorithms_length (2 bytes)
9356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009358 p += 6;
9359
9360 /*
9361 * Write supported_signature_algorithms
9362 */
9363 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9365 if (sig_alg == NULL) {
9366 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9367 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9370 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9371 *sig_alg,
9372 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9373 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009374 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 }
9376 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9377 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009378 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9380 *sig_alg,
9381 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009382 }
9383
9384 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009385 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009386 if (supported_sig_alg_len == 0) {
9387 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9388 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009389 }
9390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9392 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9393 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009394
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009395 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009396
9397#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009398 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009399#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009400
Gilles Peskine449bd832023-01-11 14:50:10 +01009401 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009402}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009403#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009404
XiaokangQian40a35232022-05-07 09:02:40 +00009405#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009406/*
9407 * mbedtls_ssl_parse_server_name_ext
9408 *
9409 * Structure of server_name extension:
9410 *
9411 * enum {
9412 * host_name(0), (255)
9413 * } NameType;
9414 * opaque HostName<1..2^16-1>;
9415 *
9416 * struct {
9417 * NameType name_type;
9418 * select (name_type) {
9419 * case host_name: HostName;
9420 * } name;
9421 * } ServerName;
9422 * struct {
9423 * ServerName server_name_list<1..2^16-1>
9424 * } ServerNameList;
9425 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009427int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9428 const unsigned char *buf,
9429 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009430{
9431 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9432 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009433 size_t server_name_list_len, hostname_len;
9434 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009435
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009437
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9439 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009440 p += 2;
9441
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009443 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009444 while (p < server_name_list_end) {
9445 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9446 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9447 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9448 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009449
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009451 /* sni_name is intended to be used only during the parsing of the
9452 * ClientHello message (it is reset to NULL before the end of
9453 * the message parsing). Thus it is ok to just point to the
9454 * reception buffer and not make a copy of it.
9455 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009456 ssl->handshake->sni_name = p + 3;
9457 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009458 if (ssl->conf->f_sni == NULL) {
9459 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9462 ssl, p + 3, hostname_len);
9463 if (ret != 0) {
9464 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9465 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9466 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9467 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9468 }
9469 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009470 }
9471
9472 p += hostname_len + 3;
9473 }
9474
Gilles Peskine449bd832023-01-11 14:50:10 +01009475 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009476}
9477#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9478
XiaokangQianacb39922022-06-17 10:18:48 +00009479#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009481int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9482 const unsigned char *buf,
9483 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009484{
9485 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009486 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009487 const unsigned char *protocol_name_list;
9488 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009489 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009490
9491 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 if (ssl->conf->alpn_list == NULL) {
9493 return 0;
9494 }
XiaokangQianacb39922022-06-17 10:18:48 +00009495
9496 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009497 * RFC7301, section 3.1
9498 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009499 *
XiaokangQianc7403452022-06-23 03:24:12 +00009500 * struct {
9501 * ProtocolName protocol_name_list<2..2^16-1>
9502 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009503 */
9504
XiaokangQianc7403452022-06-23 03:24:12 +00009505 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009506 * protocol_name_list_len 2 bytes
9507 * protocol_name_len 1 bytes
9508 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009511
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009513 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009515 protocol_name_list = p;
9516 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009517
9518 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009520 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9522 protocol_name_len);
9523 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009524 MBEDTLS_SSL_PEND_FATAL_ALERT(
9525 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9527 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009528 }
9529
9530 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009531 }
9532
9533 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009534 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9535 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009536 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009537 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009538 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009539 if (protocol_name_len == alpn_len &&
9540 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009541 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009543 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009544
9545 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009546 }
9547 }
9548
XiaokangQian95d5f542022-06-24 02:29:26 +00009549 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009550 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009551 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9552 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9553 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009554}
9555
Gilles Peskine449bd832023-01-11 14:50:10 +01009556int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9557 unsigned char *buf,
9558 unsigned char *end,
9559 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009560{
9561 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009562 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009563 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009564
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 if (ssl->alpn_chosen == NULL) {
9566 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009567 }
9568
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 protocol_name_len = strlen(ssl->alpn_chosen);
9570 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009571
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009573 /*
9574 * 0 . 1 ext identifier
9575 * 2 . 3 ext length
9576 * 4 . 5 protocol list length
9577 * 6 . 6 protocol name length
9578 * 7 . 7+n protocol name
9579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009581
XiaokangQian95d5f542022-06-24 02:29:26 +00009582 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009583
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9585 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009586 /* Note: the length of the chosen protocol has been checked to be less
9587 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9588 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009590
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009592
9593#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009595#endif
9596
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009598}
9599#endif /* MBEDTLS_SSL_ALPN */
9600
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009601#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009602 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009603 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009604 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009605int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9606 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009607{
9608 /* Initialize to suppress unnecessary compiler warning */
9609 size_t hostname_len = 0;
9610
9611 /* Check if new hostname is valid before
9612 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009613 if (hostname != NULL) {
9614 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009615
Gilles Peskine449bd832023-01-11 14:50:10 +01009616 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9618 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009619 }
9620
9621 /* Now it's clear that we will overwrite the old hostname,
9622 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009623 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009624 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009625 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009626 }
9627
9628 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009629 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009630 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009631 } else {
9632 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9633 if (session->hostname == NULL) {
9634 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9635 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009636
Gilles Peskine449bd832023-01-11 14:50:10 +01009637 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009638 }
9639
Gilles Peskine449bd832023-01-11 14:50:10 +01009640 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009641}
Xiaokang Qian03409292022-10-12 02:49:52 +00009642#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9643 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009644 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009645 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009647#endif /* MBEDTLS_SSL_TLS_C */