blob: 28be8a6fba0c642fac057d2df64521b1bb07b9f5 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500309 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Yanray Wangb422cab2023-12-01 16:18:10 +08001358 if (ssl->conf->f_rng == NULL) {
1359 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1360 return MBEDTLS_ERR_SSL_NO_RNG;
1361 }
1362
Jerry Yu60835a82021-08-04 10:13:52 +08001363 /* Space for further checks */
1364
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001366}
1367
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001368/*
1369 * Setup an SSL context
1370 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1373 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001374{
Janos Follath865b3eb2019-12-16 11:46:15 +00001375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001376 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1377 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001378
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001379 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001380
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if ((ret = ssl_conf_check(ssl)) != 0) {
1382 return ret;
1383 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001384 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001385
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001387 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001388 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001389
1390 /* Set to NULL in case of an error condition */
1391 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001392
Darryl Greenb33cc762019-11-28 14:29:44 +00001393#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1394 ssl->in_buf_len = in_buf_len;
1395#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1397 if (ssl->in_buf == NULL) {
1398 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001399 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001400 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001401 }
1402
Darryl Greenb33cc762019-11-28 14:29:44 +00001403#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1404 ssl->out_buf_len = out_buf_len;
1405#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1407 if (ssl->out_buf == NULL) {
1408 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001409 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001410 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001411 }
1412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001414
Johan Pascalb62bb512015-12-03 21:56:45 +01001415#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001417#endif
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001420 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001422
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001424
1425error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 mbedtls_free(ssl->in_buf);
1427 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001428
1429 ssl->conf = NULL;
1430
Darryl Greenb33cc762019-11-28 14:29:44 +00001431#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1432 ssl->in_buf_len = 0;
1433 ssl->out_buf_len = 0;
1434#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001435 ssl->in_buf = NULL;
1436 ssl->out_buf = NULL;
1437
1438 ssl->in_hdr = NULL;
1439 ssl->in_ctr = NULL;
1440 ssl->in_len = NULL;
1441 ssl->in_iv = NULL;
1442 ssl->in_msg = NULL;
1443
1444 ssl->out_hdr = NULL;
1445 ssl->out_ctr = NULL;
1446 ssl->out_len = NULL;
1447 ssl->out_iv = NULL;
1448 ssl->out_msg = NULL;
1449
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001451}
1452
1453/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 * Reset an initialized and used SSL context for re-use while retaining
1455 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001456 *
1457 * If partial is non-zero, keep data in the input buffer and client ID.
1458 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001460void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1461 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001462{
Darryl Greenb33cc762019-11-28 14:29:44 +00001463#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1464 size_t in_buf_len = ssl->in_buf_len;
1465 size_t out_buf_len = ssl->out_buf_len;
1466#else
1467 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1468 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1469#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001470
Hanno Beckerb0302c42021-08-03 09:39:42 +01001471#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1472 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001473#endif
1474
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001475 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001479
1480 /* Reset incoming message parsing */
1481 ssl->in_offt = NULL;
1482 ssl->nb_zero = 0;
1483 ssl->in_msgtype = 0;
1484 ssl->in_msglen = 0;
1485 ssl->in_hslen = 0;
1486 ssl->keep_current_message = 0;
1487 ssl->transform_in = NULL;
1488
1489#if defined(MBEDTLS_SSL_PROTO_DTLS)
1490 ssl->next_record_offset = 0;
1491 ssl->in_epoch = 0;
1492#endif
1493
1494 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001496 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001498 }
1499
Ronald Cronad8c17b2022-06-10 17:18:09 +02001500 ssl->send_alert = 0;
1501
Hanno Beckerb0302c42021-08-03 09:39:42 +01001502 /* Reset outgoing message writing */
1503 ssl->out_msgtype = 0;
1504 ssl->out_msglen = 0;
1505 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 memset(ssl->out_buf, 0, out_buf_len);
1507 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001508 ssl->transform_out = NULL;
1509
1510#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001512#endif
1513
XiaokangQian2b01dc32022-01-21 02:53:13 +00001514#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 if (ssl->transform) {
1516 mbedtls_ssl_transform_free(ssl->transform);
1517 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518 ssl->transform = NULL;
1519 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1521
XiaokangQian2b01dc32022-01-21 02:53:13 +00001522#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 mbedtls_ssl_transform_free(ssl->transform_application);
1524 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525 ssl->transform_application = NULL;
1526
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001528#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1530 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001532#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1535 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->handshake->transform_handshake = NULL;
1537 }
1538
XiaokangQian2b01dc32022-01-21 02:53:13 +00001539#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001540}
1541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001543{
1544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1545
1546 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549
1550 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_RENEGOTIATION)
1552 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001554
1555 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1557 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
Hanno Beckerb0302c42021-08-03 09:39:42 +01001561 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001562 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (ssl->session) {
1564 mbedtls_ssl_session_free(ssl->session);
1565 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001566 ssl->session = NULL;
1567 }
1568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001570 ssl->alpn_chosen = NULL;
1571#endif
1572
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001573#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001574 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001575#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001577#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (free_cli_id) {
1579 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001580 ssl->cli_id = NULL;
1581 ssl->cli_id_len = 0;
1582 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001583#endif
1584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if ((ret = ssl_handshake_init(ssl)) != 0) {
1586 return ret;
1587 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001590}
1591
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001592/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001593 * Reset an initialized and used SSL context for re-use while retaining
1594 * all application-set variables, function pointers and data.
1595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001596int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001597{
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599}
1600
1601/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 * SSL set accessors
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001607}
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001612}
1613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001618}
1619#endif
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001624}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1629 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001630{
1631 ssl->disable_datagram_packing = !allow_packing;
1632}
1633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1635 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001636{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001637 conf->hs_timeout_min = min;
1638 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001639}
1640#endif
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
1646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1649 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1650 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->f_vrfy = f_vrfy;
1653 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1658 int (*f_rng)(void *, unsigned char *, size_t),
1659 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001660{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001661 conf->f_rng = f_rng;
1662 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001663}
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1666 void (*f_dbg)(void *, int, const char *, int, const char *),
1667 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001669 conf->f_dbg = f_dbg;
1670 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1674 void *p_bio,
1675 mbedtls_ssl_send_t *f_send,
1676 mbedtls_ssl_recv_t *f_recv,
1677 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001678{
1679 ssl->p_bio = p_bio;
1680 ssl->f_send = f_send;
1681 ssl->f_recv = f_recv;
1682 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001683}
1684
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001686void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001687{
1688 ssl->mtu = mtu;
1689}
1690#endif
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001693{
1694 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001695}
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1698 void *p_timer,
1699 mbedtls_ssl_set_timer_t *f_set_timer,
1700 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001701{
1702 ssl->p_timer = p_timer;
1703 ssl->f_set_timer = f_set_timer;
1704 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001705
1706 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708}
1709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001711void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1712 void *p_cache,
1713 mbedtls_ssl_cache_get_t *f_get_cache,
1714 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001715{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001716 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001717 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001719}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001724{
Janos Follath865b3eb2019-12-16 11:46:15 +00001725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001728 session == NULL ||
1729 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732 }
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl->handshake->resume == 1) {
1735 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1736 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001737
Jerry Yu21092062022-10-10 21:21:31 +08001738#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001740 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001744 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1746 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1747 session->ciphersuite));
1748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001749 }
Jerry Yu40afab62022-10-08 10:42:13 +08001750 }
Jerry Yu21092062022-10-10 21:21:31 +08001751#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1754 session)) != 0) {
1755 return ret;
1756 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001757
Paul Bakker0a597072012-09-25 21:55:46 +00001758 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001761}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1765 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001766{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001767 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001768}
1769
Ronald Cron6f135e12021-12-08 16:57:54 +01001770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001771void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1772 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001773{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001774 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001775}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001776
1777#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001778void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1779 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001780{
1781 conf->early_data_enabled = early_data_enabled;
1782}
Jerry Yucc4e0072022-11-22 17:22:22 +08001783
1784#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001785void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001787{
Jerry Yu39da9852022-12-06 16:58:36 +08001788 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001789}
1790#endif /* MBEDTLS_SSL_SRV_C */
1791
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001792#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001793#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001794
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001796void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1797 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001798{
1799 conf->cert_profile = profile;
1800}
1801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001803{
1804 mbedtls_ssl_key_cert *cur = key_cert, *next;
1805
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001807 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001809 cur = next;
1810 }
1811}
1812
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001813/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001814MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001815static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1816 mbedtls_x509_crt *cert,
1817 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001818{
niisato8ee24222018-06-25 19:05:48 +09001819 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001822 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001824 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001826 }
1827
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1829 if (new_cert == NULL) {
1830 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1831 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001832
niisato8ee24222018-06-25 19:05:48 +09001833 new_cert->cert = cert;
1834 new_cert->key = key;
1835 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001836
Glenn Strauss36872db2022-01-22 05:06:31 -05001837 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001839 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001841 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001843 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 }
niisato8ee24222018-06-25 19:05:48 +09001845 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001846 }
1847
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849}
1850
Gilles Peskine449bd832023-01-11 14:50:10 +01001851int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001854{
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001856}
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001859 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001861{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001862 conf->ca_chain = ca_chain;
1863 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001864
1865#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1866 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1867 * cannot be used together. */
1868 conf->f_ca_cb = NULL;
1869 conf->p_ca_cb = NULL;
1870#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001871}
Hanno Becker5adaad92019-03-27 16:54:37 +00001872
1873#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001874void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1875 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1876 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001877{
1878 conf->f_ca_cb = f_ca_cb;
1879 conf->p_ca_cb = p_ca_cb;
1880
1881 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1882 * cannot be used together. */
1883 conf->ca_chain = NULL;
1884 conf->ca_crl = NULL;
1885}
1886#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001888
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001889#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001890const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1891 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001892{
1893 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001895}
1896
Gilles Peskine449bd832023-01-11 14:50:10 +01001897int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1898 mbedtls_x509_crt *own_cert,
1899 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001900{
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1902 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001903}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1906 mbedtls_x509_crt *ca_chain,
1907 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001908{
1909 ssl->handshake->sni_ca_chain = ca_chain;
1910 ssl->handshake->sni_ca_crl = ca_crl;
1911}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001912
Glenn Strauss999ef702022-03-11 01:37:23 -05001913#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001914void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1915 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001916{
1917 ssl->handshake->dn_hints = crt;
1918}
1919#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1922 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001923{
1924 ssl->handshake->sni_authmode = authmode;
1925}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001926#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1927
Hanno Becker8927c832019-04-03 12:52:50 +01001928#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001929void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1930 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1931 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001932{
1933 ssl->f_vrfy = f_vrfy;
1934 ssl->p_vrfy = p_vrfy;
1935}
1936#endif
1937
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001938#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001939
Valerio Setti016f6822022-12-09 14:17:50 +01001940#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001941static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1942static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1943
Valerio Setti016f6822022-12-09 14:17:50 +01001944static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 mbedtls_ssl_context *ssl,
1946 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001947{
1948 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001949 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001950 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001951 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001952 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001953 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1955 psa_pake_cs_set_primitive(&cipher_suite,
1956 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1957 PSA_ECC_FAMILY_SECP_R1,
1958 256));
1959 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1962 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001963 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_server_id;
1968 user_len = sizeof(jpake_server_id);
1969 peer = jpake_client_id;
1970 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001972 user = jpake_client_id;
1973 user_len = sizeof(jpake_client_id);
1974 peer = jpake_server_id;
1975 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001977
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001978 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1979 if (status != PSA_SUCCESS) {
1980 return status;
1981 }
1982
1983 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1989 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001990 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 }
Valerio Setti016f6822022-12-09 14:17:50 +01001992
1993 ssl->handshake->psa_pake_ctx_is_ok = 1;
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001996}
1997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1999 const unsigned char *pw,
2000 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002001{
2002 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2003 psa_status_t status;
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 if (ssl->handshake == NULL || ssl->conf == NULL) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002007 }
2008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 /* Empty password is not valid */
2010 if ((pw == NULL) || (pw_len == 0)) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2012 }
2013
2014 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2015 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2016 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2017
2018 status = psa_import_key(&attributes, pw, pw_len,
2019 &ssl->handshake->psa_pake_password);
2020 if (status != PSA_SUCCESS) {
2021 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2022 }
2023
2024 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2025 ssl->handshake->psa_pake_password);
2026 if (status != PSA_SUCCESS) {
2027 psa_destroy_key(ssl->handshake->psa_pake_password);
2028 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002033}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2036 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002037{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002038 psa_status_t status;
2039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 if (ssl->handshake == NULL || ssl->conf == NULL) {
2041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002042 }
2043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 if (mbedtls_svc_key_id_is_null(pwd)) {
2045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2046 }
2047
2048 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2049 if (status != PSA_SUCCESS) {
2050 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2051 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2052 }
2053
2054 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002055}
2056#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2058 const unsigned char *pw,
2059 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002060{
2061 mbedtls_ecjpake_role role;
2062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (ssl->handshake == NULL || ssl->conf == NULL) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002066
Valerio Settic689ed82022-12-07 14:40:38 +01002067 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 if ((pw == NULL) || (pw_len == 0)) {
2069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2070 }
Valerio Settic689ed82022-12-07 14:40:38 +01002071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002073 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2079 role,
2080 MBEDTLS_MD_SHA256,
2081 MBEDTLS_ECP_DP_SECP256R1,
2082 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083}
Valerio Setti02c25b52022-11-15 14:08:42 +01002084#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002085#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086
Ronald Cron73fe8df2022-10-05 14:31:43 +02002087#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002088int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002089{
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if (conf->psk_identity == NULL ||
2091 conf->psk_identity_len == 0) {
2092 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002093 }
2094
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002095#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (conf->psk != NULL && conf->psk_len != 0) {
2102 return 1;
2103 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106}
2107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002109{
2110 /* Remove reference to existing PSK, if any. */
2111#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002113 /* The maintenance of the PSK key slot is the
2114 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002115 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002116 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002119 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002120 conf->psk = NULL;
2121 conf->psk_len = 0;
2122 }
2123
2124 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (conf->psk_identity != NULL) {
2126 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002127 conf->psk_identity = NULL;
2128 conf->psk_identity_len = 0;
2129 }
2130}
2131
Hanno Becker7390c712018-11-15 13:33:04 +00002132/* This function assumes that PSK identity in the SSL config is unset.
2133 * It checks that the provided identity is well-formed and attempts
2134 * to make a copy of it in the SSL config.
2135 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002136MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002137static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2138 unsigned char const *psk_identity,
2139 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002140{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002141 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002143 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 (psk_identity_len >> 16) != 0 ||
2145 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2146 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002147 }
2148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2150 if (conf->psk_identity == NULL) {
2151 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2152 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002153
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002154 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002158}
2159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2161 const unsigned char *psk, size_t psk_len,
2162 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002163{
Janos Follath865b3eb2019-12-16 11:46:15 +00002164 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002165
2166 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2168 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2169 }
Hanno Becker7390c712018-11-15 13:33:04 +00002170
2171 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 if (psk == NULL) {
2173 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2174 }
2175 if (psk_len == 0) {
2176 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2177 }
2178 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2180 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2183 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2184 }
Hanno Becker7390c712018-11-15 13:33:04 +00002185 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002187
2188 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2190 if (ret != 0) {
2191 ssl_conf_remove_psk(conf);
2192 }
Hanno Becker7390c712018-11-15 13:33:04 +00002193
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002195}
2196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002198{
2199#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002201 /* The maintenance of the external PSK key slot is the
2202 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if (ssl->handshake->psk_opaque_is_internal) {
2204 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002205 ssl->handshake->psk_opaque_is_internal = 0;
2206 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002207 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 }
Neil Armstronge952a302022-05-03 10:22:14 +02002209#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002211 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002213 ssl->handshake->psk_len = 0;
2214 }
Neil Armstronge952a302022-05-03 10:22:14 +02002215#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002216}
2217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2219 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002220{
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#if defined(MBEDTLS_USE_PSA_CRYPTO)
2222 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002223 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002224 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002225 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002226#endif /* MBEDTLS_USE_PSA_CRYPTO */
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (psk == NULL || ssl->handshake == NULL) {
2229 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2230 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2233 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2234 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002237
Neil Armstrong501c9322022-05-03 09:35:09 +02002238#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002239#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2241 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2242 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2243 } else {
2244 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2245 }
2246 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002247 }
2248#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002249
Jerry Yu568ec252022-07-22 21:27:34 +08002250#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2252 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2253 psa_set_key_usage_flags(&key_attributes,
2254 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002255 }
2256#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 psa_set_key_algorithm(&key_attributes, alg);
2259 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2262 if (status != PSA_SUCCESS) {
2263 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2264 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002265
2266 /* Allow calling psa_destroy_key() on psk remove */
2267 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002269#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2272 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002273
2274 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002278#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002279}
2280
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002282int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2283 mbedtls_svc_key_id_t psk,
2284 const unsigned char *psk_identity,
2285 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002286{
Janos Follath865b3eb2019-12-16 11:46:15 +00002287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002288
2289 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2291 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2292 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002293
Hanno Becker7390c712018-11-15 13:33:04 +00002294 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 if (mbedtls_svc_key_id_is_null(psk)) {
2296 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2297 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002298 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002299
2300 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2302 psk_identity_len);
2303 if (ret != 0) {
2304 ssl_conf_remove_psk(conf);
2305 }
Hanno Becker7390c712018-11-15 13:33:04 +00002306
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002308}
2309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2311 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312{
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if ((mbedtls_svc_key_id_is_null(psk)) ||
2314 (ssl->handshake == NULL)) {
2315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2316 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002319 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002321}
2322#endif /* MBEDTLS_USE_PSA_CRYPTO */
2323
Jerry Yu8897c072022-08-12 13:56:53 +08002324#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002325void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2326 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2327 size_t),
2328 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329{
2330 conf->f_psk = f_psk;
2331 conf->p_psk = p_psk;
2332}
Jerry Yu8897c072022-08-12 13:56:53 +08002333#endif /* MBEDTLS_SSL_SRV_C */
2334
Ronald Cron73fe8df2022-10-05 14:31:43 +02002335#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002336
2337#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002338static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002341#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if (alg == PSA_ALG_CBC_NO_PADDING) {
2343 return MBEDTLS_SSL_MODE_CBC;
2344 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002345#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (PSA_ALG_IS_AEAD(alg)) {
2347 return MBEDTLS_SSL_MODE_AEAD;
2348 }
2349 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002350}
2351
2352#else /* MBEDTLS_USE_PSA_CRYPTO */
2353
2354static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002356{
2357#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 if (mode == MBEDTLS_MODE_CBC) {
2359 return MBEDTLS_SSL_MODE_CBC;
2360 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002361#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2362
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002363#if defined(MBEDTLS_GCM_C) || \
2364 defined(MBEDTLS_CCM_C) || \
2365 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 mode == MBEDTLS_MODE_CHACHAPOLY) {
2369 return MBEDTLS_SSL_MODE_AEAD;
2370 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374}
Gilles Peskine301711e2022-04-26 16:57:05 +02002375#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002376
Gilles Peskinee108d982022-04-26 16:50:40 +02002377static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2378 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002380{
2381#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2383 base_mode == MBEDTLS_SSL_MODE_CBC) {
2384 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385 }
2386#else
2387 (void) encrypt_then_mac;
2388#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002390}
2391
Neil Armstrongab555e02022-04-04 11:07:59 +02002392mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002394{
Gilles Peskinee108d982022-04-26 16:50:40 +02002395 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002396#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002397 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002398#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400#endif
2401 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002402
Gilles Peskinee108d982022-04-26 16:50:40 +02002403 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002404#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002405 encrypt_then_mac = transform->encrypt_then_mac;
2406#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408}
2409
Neil Armstrongab555e02022-04-04 11:07:59 +02002410mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002411#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002413#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002415{
Gilles Peskinee108d982022-04-26 16:50:40 +02002416 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2417
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418#if defined(MBEDTLS_USE_PSA_CRYPTO)
2419 psa_status_t status;
2420 psa_algorithm_t alg;
2421 psa_key_type_t type;
2422 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002423 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2424 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 if (status == PSA_SUCCESS) {
2426 base_mode = mbedtls_ssl_get_base_mode(alg);
2427 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#else
2429 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002430 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002432 base_mode =
2433 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002435 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002436#endif /* MBEDTLS_USE_PSA_CRYPTO */
2437
Gilles Peskinee108d982022-04-26 16:50:40 +02002438#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2439 int encrypt_then_mac = 0;
2440#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002442}
2443
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002444#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002445
2446#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002447/* Serialization of TLS 1.3 sessions:
2448 *
2449 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002450 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002451 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002452 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002453 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002454 * } ClientOnlyData;
2455 *
2456 * struct {
2457 * uint8 endpoint;
2458 * uint8 ciphersuite[2];
2459 * uint32 ticket_age_add;
2460 * uint8 ticket_flags;
2461 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002462 * uint32 max_early_data_size;
Jerry Yu438ddd82022-07-07 06:55:50 +00002463 * select ( endpoint ) {
2464 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002465 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002466 * };
2467 * } serialized_session_tls13;
2468 *
2469 */
2470#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002472static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2473 unsigned char *buf,
2474 size_t buf_len,
2475 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002476{
2477 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002478#if defined(MBEDTLS_SSL_CLI_C) && \
2479 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 size_t hostname_len = (session->hostname == NULL) ?
2481 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002482#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002483 size_t needed = 1 /* endpoint */
2484 + 2 /* ciphersuite */
2485 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002486 + 1 /* ticket_flags */
2487 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002488 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2491 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2492 }
Jerry Yu34191072022-08-18 10:32:09 +08002493 needed += session->resumption_key_len; /* resumption_key */
2494
Jerry Yu02e3a072022-12-12 15:13:20 +08002495#if defined(MBEDTLS_SSL_EARLY_DATA)
2496 needed += 4; /* max_early_data_size */
2497#endif
2498
Jerry Yu438ddd82022-07-07 06:55:50 +00002499#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002500 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002501#endif
2502
2503#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002505#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002506 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002508#endif
2509
Jerry Yu438ddd82022-07-07 06:55:50 +00002510 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002511 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002512
2513 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (session->ticket_len > SIZE_MAX - needed) {
2515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2516 }
Jerry Yu34191072022-08-18 10:32:09 +08002517
Jerry Yue28d9742022-08-18 15:44:03 +08002518 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002519 }
2520#endif /* MBEDTLS_SSL_CLI_C */
2521
Jerry Yue36fdd62022-08-17 21:31:36 +08002522 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 if (needed > buf_len) {
2524 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2525 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002526
2527 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2529 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002530 p[7] = session->ticket_flags;
2531
2532 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002533 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002534 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002536 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002537
Jerry Yu02e3a072022-12-12 15:13:20 +08002538#if defined(MBEDTLS_SSL_EARLY_DATA)
2539 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2540 p += 4;
2541#endif
2542
Jerry Yu438ddd82022-07-07 06:55:50 +00002543#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002545 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002546 p += 8;
2547 }
2548#endif /* MBEDTLS_HAVE_TIME */
2549
2550#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002552#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002554 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002556 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002558 p += hostname_len;
2559 }
2560#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2561
Jerry Yu438ddd82022-07-07 06:55:50 +00002562#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002563 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002564 p += 8;
2565#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 4;
2568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (session->ticket != NULL && session->ticket_len > 0) {
2573 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002574 p += session->ticket_len;
2575 }
2576 }
2577#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002579}
2580
2581MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002582static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2583 const unsigned char *buf,
2584 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002585{
2586 const unsigned char *p = buf;
2587 const unsigned char *end = buf + len;
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 if (end - p < 9) {
2590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2591 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002592 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2594 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->ticket_flags = p[7];
2596
2597 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002598 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002599 p += 9;
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (end - p < session->resumption_key_len) {
2602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2603 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2607 }
2608 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002609 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002610
Jerry Yu02e3a072022-12-12 15:13:20 +08002611#if defined(MBEDTLS_SSL_EARLY_DATA)
2612 if (end - p < 4) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2616 p += 4;
2617#endif
2618
Jerry Yu438ddd82022-07-07 06:55:50 +00002619#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2621 if (end - p < 8) {
2622 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2623 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002624 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002625 p += 8;
2626 }
2627#endif /* MBEDTLS_HAVE_TIME */
2628
2629#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002631#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002633 size_t hostname_len;
2634 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 if (end - p < 2) {
2636 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2637 }
2638 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002639 p += 2;
2640
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 if (end - p < (long int) hostname_len) {
2642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2643 }
2644 if (hostname_len > 0) {
2645 session->hostname = mbedtls_calloc(1, hostname_len);
2646 if (session->hostname == NULL) {
2647 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2648 }
2649 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002650 p += hostname_len;
2651 }
2652#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2653 MBEDTLS_SSL_SESSION_TICKETS */
2654
Jerry Yu438ddd82022-07-07 06:55:50 +00002655#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 if (end - p < 8) {
2657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2658 }
Jerry Yu342a5552023-11-10 14:23:39 +08002659 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002660 p += 8;
2661#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002662 if (end - p < 4) {
2663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2664 }
2665 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002666 p += 4;
2667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (end - p < 2) {
2669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2670 }
2671 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002672 p += 2;
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 if (end - p < (long int) session->ticket_len) {
2675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2676 }
2677 if (session->ticket_len > 0) {
2678 session->ticket = mbedtls_calloc(1, session->ticket_len);
2679 if (session->ticket == NULL) {
2680 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2681 }
2682 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002683 p += session->ticket_len;
2684 }
2685 }
2686#endif /* MBEDTLS_SSL_CLI_C */
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002689
2690}
2691#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002692MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002693static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2694 unsigned char *buf,
2695 size_t buf_len,
2696 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002697{
2698 ((void) session);
2699 ((void) buf);
2700 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002701 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002703}
Jerry Yu438ddd82022-07-07 06:55:50 +00002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2706 unsigned char *buf,
2707 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002708{
2709 ((void) session);
2710 ((void) buf);
2711 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002713}
2714#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002715#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2718 size_t taglen,
2719 psa_algorithm_t *alg,
2720 psa_key_type_t *key_type,
2721 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002722{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002723#if !defined(MBEDTLS_SSL_HAVE_CCM)
2724 (void) taglen;
2725#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002727#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002728 case MBEDTLS_CIPHER_AES_128_CBC:
2729 *alg = PSA_ALG_CBC_NO_PADDING;
2730 *key_type = PSA_KEY_TYPE_AES;
2731 *key_size = 128;
2732 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002733#endif
2734#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002735 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002737 *key_type = PSA_KEY_TYPE_AES;
2738 *key_size = 128;
2739 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002740#endif
2741#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002742 case MBEDTLS_CIPHER_AES_128_GCM:
2743 *alg = PSA_ALG_GCM;
2744 *key_type = PSA_KEY_TYPE_AES;
2745 *key_size = 128;
2746 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002747#endif
2748#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002749 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 *key_type = PSA_KEY_TYPE_AES;
2752 *key_size = 192;
2753 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002754#endif
2755#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002756 case MBEDTLS_CIPHER_AES_192_GCM:
2757 *alg = PSA_ALG_GCM;
2758 *key_type = PSA_KEY_TYPE_AES;
2759 *key_size = 192;
2760 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002761#endif
2762#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002763 case MBEDTLS_CIPHER_AES_256_CBC:
2764 *alg = PSA_ALG_CBC_NO_PADDING;
2765 *key_type = PSA_KEY_TYPE_AES;
2766 *key_size = 256;
2767 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002768#endif
2769#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002770 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002772 *key_type = PSA_KEY_TYPE_AES;
2773 *key_size = 256;
2774 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002775#endif
2776#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002777 case MBEDTLS_CIPHER_AES_256_GCM:
2778 *alg = PSA_ALG_GCM;
2779 *key_type = PSA_KEY_TYPE_AES;
2780 *key_size = 256;
2781 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002782#endif
2783#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002784 case MBEDTLS_CIPHER_ARIA_128_CBC:
2785 *alg = PSA_ALG_CBC_NO_PADDING;
2786 *key_type = PSA_KEY_TYPE_ARIA;
2787 *key_size = 128;
2788 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002789#endif
2790#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002791 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002793 *key_type = PSA_KEY_TYPE_ARIA;
2794 *key_size = 128;
2795 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002796#endif
2797#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002798 case MBEDTLS_CIPHER_ARIA_128_GCM:
2799 *alg = PSA_ALG_GCM;
2800 *key_type = PSA_KEY_TYPE_ARIA;
2801 *key_size = 128;
2802 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002803#endif
2804#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002805 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002807 *key_type = PSA_KEY_TYPE_ARIA;
2808 *key_size = 192;
2809 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002810#endif
2811#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002812 case MBEDTLS_CIPHER_ARIA_192_GCM:
2813 *alg = PSA_ALG_GCM;
2814 *key_type = PSA_KEY_TYPE_ARIA;
2815 *key_size = 192;
2816 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002817#endif
2818#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002819 case MBEDTLS_CIPHER_ARIA_256_CBC:
2820 *alg = PSA_ALG_CBC_NO_PADDING;
2821 *key_type = PSA_KEY_TYPE_ARIA;
2822 *key_size = 256;
2823 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002824#endif
2825#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002826 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 *key_type = PSA_KEY_TYPE_ARIA;
2829 *key_size = 256;
2830 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002831#endif
2832#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002833 case MBEDTLS_CIPHER_ARIA_256_GCM:
2834 *alg = PSA_ALG_GCM;
2835 *key_type = PSA_KEY_TYPE_ARIA;
2836 *key_size = 256;
2837 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002838#endif
2839#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002840 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2841 *alg = PSA_ALG_CBC_NO_PADDING;
2842 *key_type = PSA_KEY_TYPE_CAMELLIA;
2843 *key_size = 128;
2844 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002845#endif
2846#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002847 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002849 *key_type = PSA_KEY_TYPE_CAMELLIA;
2850 *key_size = 128;
2851 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002852#endif
2853#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002854 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2855 *alg = PSA_ALG_GCM;
2856 *key_type = PSA_KEY_TYPE_CAMELLIA;
2857 *key_size = 128;
2858 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002859#endif
2860#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002861 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002863 *key_type = PSA_KEY_TYPE_CAMELLIA;
2864 *key_size = 192;
2865 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002866#endif
2867#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002868 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2869 *alg = PSA_ALG_GCM;
2870 *key_type = PSA_KEY_TYPE_CAMELLIA;
2871 *key_size = 192;
2872 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002873#endif
2874#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002875 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2876 *alg = PSA_ALG_CBC_NO_PADDING;
2877 *key_type = PSA_KEY_TYPE_CAMELLIA;
2878 *key_size = 256;
2879 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002880#endif
2881#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002882 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002884 *key_type = PSA_KEY_TYPE_CAMELLIA;
2885 *key_size = 256;
2886 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002887#endif
2888#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002889 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2890 *alg = PSA_ALG_GCM;
2891 *key_type = PSA_KEY_TYPE_CAMELLIA;
2892 *key_size = 256;
2893 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002894#endif
2895#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002896 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2897 *alg = PSA_ALG_CHACHA20_POLY1305;
2898 *key_type = PSA_KEY_TYPE_CHACHA20;
2899 *key_size = 256;
2900 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002901#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002902 case MBEDTLS_CIPHER_NULL:
2903 *alg = MBEDTLS_SSL_NULL_CIPHER;
2904 *key_type = 0;
2905 *key_size = 0;
2906 break;
2907 default:
2908 return PSA_ERROR_NOT_SUPPORTED;
2909 }
2910
2911 return PSA_SUCCESS;
2912}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002913#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002914
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002915#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002916int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2917 const unsigned char *dhm_P, size_t P_len,
2918 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002919{
Janos Follath865b3eb2019-12-16 11:46:15 +00002920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 mbedtls_mpi_free(&conf->dhm_P);
2923 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2926 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2927 mbedtls_mpi_free(&conf->dhm_P);
2928 mbedtls_mpi_free(&conf->dhm_G);
2929 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002930 }
2931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002933}
Paul Bakker5121ce52009-01-03 21:22:43 +00002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002936{
Janos Follath865b3eb2019-12-16 11:46:15 +00002937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 mbedtls_mpi_free(&conf->dhm_P);
2940 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2943 &conf->dhm_P)) != 0 ||
2944 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2945 &conf->dhm_G)) != 0) {
2946 mbedtls_mpi_free(&conf->dhm_P);
2947 mbedtls_mpi_free(&conf->dhm_G);
2948 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002949 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002952}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002953#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002954
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002955#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2956/*
2957 * Set the minimum length for Diffie-Hellman parameters
2958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002959void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2960 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002961{
2962 conf->dhm_min_bitlen = bitlen;
2963}
2964#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2965
Ronald Crone68ab4f2022-10-05 12:46:29 +02002966#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002967#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002968/*
2969 * Set allowed/preferred hashes for handshake signatures
2970 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002971void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2972 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002973{
2974 conf->sig_hashes = hashes;
2975}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002976#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002977
Jerry Yuf017ee42022-01-12 15:49:48 +08002978/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002979void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2980 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002981{
Jerry Yuf017ee42022-01-12 15:49:48 +08002982#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2983 conf->sig_hashes = NULL;
2984#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2985 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002986}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002987#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002988
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002989#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002990#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002991/*
2992 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002993 *
2994 * mbedtls_ssl_setup() takes the provided list
2995 * and translates it to a list of IANA TLS group identifiers,
2996 * stored in ssl->handshake->group_list.
2997 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002998 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002999void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3000 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003001{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003002 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003003 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003004}
Brett Warrene0edc842021-08-17 09:53:13 +01003005#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003006#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003007
Brett Warrene0edc842021-08-17 09:53:13 +01003008/*
3009 * Set the allowed groups
3010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003011void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3012 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003013{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003014#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003015 conf->curve_list = NULL;
3016#endif
3017 conf->group_list = group_list;
3018}
3019
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003020#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003021int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003022{
Hanno Becker947194e2017-04-07 13:25:49 +01003023 /* Initialize to suppress unnecessary compiler warning */
3024 size_t hostname_len = 0;
3025
3026 /* Check if new hostname is valid before
3027 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (hostname != NULL) {
3029 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3033 }
Hanno Becker947194e2017-04-07 13:25:49 +01003034 }
3035
3036 /* Now it's clear that we will overwrite the old hostname,
3037 * so we can free it safely */
3038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003040 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003041 }
3042
3043 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003046 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 } else {
3048 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3049 if (ssl->hostname == NULL) {
3050 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3051 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003054
Hanno Becker947194e2017-04-07 13:25:49 +01003055 ssl->hostname[hostname_len] = '\0';
3056 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003059}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003060#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003061
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003062#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003063void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3064 int (*f_sni)(void *, mbedtls_ssl_context *,
3065 const unsigned char *, size_t),
3066 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003067{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003068 conf->f_sni = f_sni;
3069 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003070}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003074int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003075{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003076 size_t cur_len, tot_len;
3077 const char **p;
3078
3079 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003080 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3081 * MUST NOT be truncated."
3082 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003083 */
3084 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 for (p = protos; *p != NULL; p++) {
3086 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003087 tot_len += cur_len;
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if ((cur_len == 0) ||
3090 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3091 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3093 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003094 }
3095
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003096 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003099}
3100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003102{
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003104}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003105#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003106
Johan Pascalb62bb512015-12-03 21:56:45 +01003107#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003108void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3109 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003110{
3111 conf->dtls_srtp_mki_support = support_mki_value;
3112}
3113
Gilles Peskine449bd832023-01-11 14:50:10 +01003114int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3115 unsigned char *mki_value,
3116 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003117{
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3119 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003120 }
Ron Eldor591f1622018-01-22 12:30:04 +02003121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3123 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003124 }
Ron Eldor591f1622018-01-22 12:30:04 +02003125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003127 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003129}
3130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3132 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003133{
Johan Pascal253d0262020-09-22 13:04:45 +02003134 const mbedtls_ssl_srtp_profile *p;
3135 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003136
Johan Pascal253d0262020-09-22 13:04:45 +02003137 /* check the profiles list: all entry must be valid,
3138 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3140 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3141 p++) {
3142 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003143 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003145 /* unsupported value, stop parsing and set the size to an error value */
3146 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003147 }
3148 }
3149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3151 conf->dtls_srtp_profile_list = NULL;
3152 conf->dtls_srtp_profile_list_len = 0;
3153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003154 }
3155
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003156 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003157 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003160}
3161
Gilles Peskine449bd832023-01-11 14:50:10 +01003162void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3163 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003164{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003165 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3166 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003168 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003170 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3172 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003173 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003174}
Johan Pascalb62bb512015-12-03 21:56:45 +01003175#endif /* MBEDTLS_SSL_DTLS_SRTP */
3176
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303177#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003178void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003179{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003180 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003181}
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003184{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003185 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003186}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303187#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003188
Janos Follath088ce432017-04-10 12:42:31 +01003189#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003190void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3191 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003192{
3193 conf->cert_req_ca_list = cert_req_ca_list;
3194}
3195#endif
3196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003199{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003200 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003201}
3202#endif
3203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003205void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003206{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003207 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003208}
3209#endif
3210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003212int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003213{
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3215 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3216 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003217 }
3218
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003219 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003222}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003226{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003227 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003228}
3229
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003231void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003232{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003233 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003234}
3235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003237{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003238 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003239}
3240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3242 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003243{
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003245}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003249#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003250void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003251{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003252 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003253}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003254#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003255
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003256#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003257
Jerry Yud0766ec2022-09-22 10:46:57 +08003258#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003259void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3260 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003261{
Jerry Yud0766ec2022-09-22 10:46:57 +08003262 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003263}
3264#endif
3265
Gilles Peskine449bd832023-01-11 14:50:10 +01003266void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3267 mbedtls_ssl_ticket_write_t *f_ticket_write,
3268 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3269 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003270{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003271 conf->f_ticket_write = f_ticket_write;
3272 conf->f_ticket_parse = f_ticket_parse;
3273 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003274}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003275#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003276#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3279 mbedtls_ssl_export_keys_t *f_export_keys,
3280 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003281{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003282 ssl->f_export_keys = f_export_keys;
3283 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003284}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003285
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003286#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003287void mbedtls_ssl_conf_async_private_cb(
3288 mbedtls_ssl_config *conf,
3289 mbedtls_ssl_async_sign_t *f_async_sign,
3290 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3291 mbedtls_ssl_async_resume_t *f_async_resume,
3292 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003294{
3295 conf->f_async_sign_start = f_async_sign;
3296 conf->f_async_decrypt_start = f_async_decrypt;
3297 conf->f_async_resume = f_async_resume;
3298 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003299 conf->p_async_config_data = async_config_data;
3300}
3301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003303{
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003305}
3306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003308{
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (ssl->handshake == NULL) {
3310 return NULL;
3311 } else {
3312 return ssl->handshake->user_async_ctx;
3313 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003314}
3315
Gilles Peskine449bd832023-01-11 14:50:10 +01003316void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3317 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003318{
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003320 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003322}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003323#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003324
Paul Bakker5121ce52009-01-03 21:22:43 +00003325/*
3326 * SSL get accessors
3327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003328uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003329{
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 if (ssl->session != NULL) {
3331 return ssl->session->verify_result;
3332 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003333
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 if (ssl->session_negotiate != NULL) {
3335 return ssl->session_negotiate->verify_result;
3336 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003339}
3340
Gilles Peskine449bd832023-01-11 14:50:10 +01003341int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003342{
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 if (ssl == NULL || ssl->session == NULL) {
3344 return 0;
3345 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003346
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003348}
3349
Gilles Peskine449bd832023-01-11 14:50:10 +01003350const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003351{
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 if (ssl == NULL || ssl->session == NULL) {
3353 return NULL;
3354 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003355
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003357}
3358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003360{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3363 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003364 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003366 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003368 }
3369 }
3370#endif
3371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003373 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003375 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003377 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003379 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003380}
3381
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003382#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003383size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003384{
David Horstmann95d516f2021-05-04 18:36:56 +01003385 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003386 size_t read_mfl;
3387
Jerry Yuddda0502022-12-01 19:43:12 +08003388#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003389 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3391 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3392 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003393 }
Jerry Yuddda0502022-12-01 19:43:12 +08003394#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003395
3396 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 if (ssl->session_out != NULL) {
3398 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3399 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003400 max_len = read_mfl;
3401 }
3402 }
3403
Jerry Yuddda0502022-12-01 19:43:12 +08003404 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 if (ssl->session_negotiate != NULL) {
3406 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3407 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003408 max_len = read_mfl;
3409 }
3410 }
3411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003413}
3414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003416{
3417 size_t max_len;
3418
3419 /*
3420 * Assume mfl_code is correct since it was checked when set
3421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003423
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003424 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (ssl->session_out != NULL &&
3426 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3427 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003428 }
3429
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003430 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (ssl->session_negotiate != NULL &&
3432 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3433 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003434 }
3435
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003437}
3438#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3439
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003440#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003441size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003442{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003443 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3445 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3446 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3447 return 0;
3448 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3451 return ssl->mtu;
3452 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003453
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 if (ssl->mtu == 0) {
3455 return ssl->handshake->mtu;
3456 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003457
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 return ssl->mtu < ssl->handshake->mtu ?
3459 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003460}
3461#endif /* MBEDTLS_SSL_PROTO_DTLS */
3462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003464{
3465 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3466
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003467#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3468 !defined(MBEDTLS_SSL_PROTO_DTLS)
3469 (void) ssl;
3470#endif
3471
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003472#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003474
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003476 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003478#endif
3479
3480#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003481 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3482 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3483 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003484 const size_t overhead = (size_t) ret;
3485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 if (ret < 0) {
3487 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003488 }
3489
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 if (mtu <= overhead) {
3491 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3492 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3493 }
3494
3495 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003496 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003498 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003499#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003500
Hanno Becker0defedb2018-08-10 12:35:02 +01003501#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3502 !defined(MBEDTLS_SSL_PROTO_DTLS)
3503 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003504#endif
3505
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003507}
3508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003510{
3511 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3512
3513#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3514 (void) ssl;
3515#endif
3516
3517#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003519
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003521 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003522 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003523#endif
3524
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003526}
3527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003528#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003529const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003530{
Gilles Peskine449bd832023-01-11 14:50:10 +01003531 if (ssl == NULL || ssl->session == NULL) {
3532 return NULL;
3533 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003534
Hanno Beckere6824572019-02-07 13:18:46 +00003535#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003536 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003537#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003539#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003540}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003544int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3545 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003546{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003547 int ret;
3548
Gilles Peskine449bd832023-01-11 14:50:10 +01003549 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003550 dst == NULL ||
3551 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003552 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3553 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003554 }
3555
Hanno Beckere810bbc2021-05-14 16:01:05 +01003556 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3557 * idempotent: Each session can only be exported once.
3558 *
3559 * (This is in preparation for TLS 1.3 support where we will
3560 * need the ability to export multiple sessions (aka tickets),
3561 * which will be achieved by calling mbedtls_ssl_get_session()
3562 * multiple times until it fails.)
3563 *
3564 * Check whether we have already exported the current session,
3565 * and fail if so.
3566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003567 if (ssl->session->exported == 1) {
3568 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3569 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003570
Gilles Peskine449bd832023-01-11 14:50:10 +01003571 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3572 if (ret != 0) {
3573 return ret;
3574 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003575
3576 /* Remember that we've exported the session. */
3577 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003578 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003579}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003581
Paul Bakker5121ce52009-01-03 21:22:43 +00003582/*
Hanno Beckera835da52019-05-16 12:39:07 +01003583 * Define ticket header determining Mbed TLS version
3584 * and structure of the ticket.
3585 */
3586
Hanno Becker94ef3b32019-05-16 12:50:45 +01003587/*
Hanno Becker50b59662019-05-28 14:30:45 +01003588 * Define bitflag determining compile-time settings influencing
3589 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003590 */
3591
Hanno Becker50b59662019-05-28 14:30:45 +01003592#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003593#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003594#else
Hanno Becker3e088662019-05-29 11:10:18 +01003595#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003596#endif /* MBEDTLS_HAVE_TIME */
3597
3598#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003599#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003600#else
Hanno Becker3e088662019-05-29 11:10:18 +01003601#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003602#endif /* MBEDTLS_X509_CRT_PARSE_C */
3603
3604#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003605#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003606#else
Hanno Becker3e088662019-05-29 11:10:18 +01003607#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003608#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3609
3610#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003611#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003612#else
Hanno Becker3e088662019-05-29 11:10:18 +01003613#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003614#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3615
Hanno Becker94ef3b32019-05-16 12:50:45 +01003616#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003617#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003618#else
Hanno Becker3e088662019-05-29 11:10:18 +01003619#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003620#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3621
Hanno Becker94ef3b32019-05-16 12:50:45 +01003622#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3623#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3624#else
3625#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3626#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3627
Hanno Becker3e088662019-05-29 11:10:18 +01003628#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3629#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3630#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3631#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003632#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3633#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003634
Hanno Becker50b59662019-05-28 14:30:45 +01003635#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003636 ((uint16_t) ( \
3637 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3638 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3639 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3640 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3641 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3642 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3643 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003644
Hanno Beckerf8787072019-05-16 12:41:07 +01003645static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003646 MBEDTLS_VERSION_MAJOR,
3647 MBEDTLS_VERSION_MINOR,
3648 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3650 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003651};
Hanno Beckera835da52019-05-16 12:39:07 +01003652
3653/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003654 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003655 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003656 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003657 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003658 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003659 * opaque mbedtls_version[3]; // library version: major, minor, patch
3660 * opaque session_format[2]; // library-version specific 16-bit field
3661 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003662 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003663 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003664 * Note: When updating the format, remember to keep
3665 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003666 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003667 * // In this version, `session_format` determines
3668 * // the setting of those compile-time
3669 * // configuration options which influence
3670 * // the structure of mbedtls_ssl_session.
3671 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003672 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003673 * // - TLS 1.2 (0x0303)
3674 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003675 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003676 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003677 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003678 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003679 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003680 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003681 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003682 *
3683 * };
3684 *
3685 * } serialized_session;
3686 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003687 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003688
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003689MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003690static int ssl_session_save(const mbedtls_ssl_session *session,
3691 unsigned char omit_header,
3692 unsigned char *buf,
3693 size_t buf_len,
3694 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003695{
3696 unsigned char *p = buf;
3697 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003698 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003699#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3700 size_t out_len;
3701 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3702#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 if (session == NULL) {
3704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3705 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003706
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003708 /*
3709 * Add Mbed TLS version identifier
3710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003711 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003712
Gilles Peskine449bd832023-01-11 14:50:10 +01003713 if (used <= buf_len) {
3714 memcpy(p, ssl_serialized_session_header,
3715 sizeof(ssl_serialized_session_header));
3716 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003717 }
3718 }
3719
3720 /*
3721 * TLS version identifier
3722 */
3723 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (used <= buf_len) {
3725 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 }
3727
3728 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003729 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003731#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003732 case MBEDTLS_SSL_VERSION_TLS1_2:
3733 used += ssl_tls12_session_save(session, p, remaining_len);
3734 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003735#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3736
Jerry Yu251a12e2022-07-13 15:15:48 +08003737#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003738 case MBEDTLS_SSL_VERSION_TLS1_3:
3739 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3740 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3741 return ret;
3742 }
3743 used += out_len;
3744 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003745#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3746
Gilles Peskine449bd832023-01-11 14:50:10 +01003747 default:
3748 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003749 }
3750
3751 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 if (used > buf_len) {
3753 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3754 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003755
Gilles Peskine449bd832023-01-11 14:50:10 +01003756 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003757}
3758
3759/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003760 * Public wrapper for ssl_session_save()
3761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003762int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3763 unsigned char *buf,
3764 size_t buf_len,
3765 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003766{
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003768}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003769
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003770/*
3771 * Deserialize session, see mbedtls_ssl_session_save() for format.
3772 *
3773 * This internal version is wrapped by a public function that cleans up in
3774 * case of error, and has an extra option omit_header.
3775 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003776MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003777static int ssl_session_load(mbedtls_ssl_session *session,
3778 unsigned char omit_header,
3779 const unsigned char *buf,
3780 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003781{
3782 const unsigned char *p = buf;
3783 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003784 size_t remaining_len;
3785
3786
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 if (session == NULL) {
3788 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3789 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003790
Gilles Peskine449bd832023-01-11 14:50:10 +01003791 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003792 /*
3793 * Check Mbed TLS version identifier
3794 */
3795
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3797 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003798 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003799
3800 if (memcmp(p, ssl_serialized_session_header,
3801 sizeof(ssl_serialized_session_header)) != 0) {
3802 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3803 }
3804 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003805 }
3806
3807 /*
3808 * TLS version identifier
3809 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003810 if (1 > (size_t) (end - p)) {
3811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3812 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003813 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003814
3815 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003816 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003818#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 case MBEDTLS_SSL_VERSION_TLS1_2:
3820 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003821#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3822
Jerry Yu438ddd82022-07-07 06:55:50 +00003823#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 case MBEDTLS_SSL_VERSION_TLS1_3:
3825 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003826#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 default:
3829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003830 }
3831}
3832
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003833/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003834 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003836int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3837 const unsigned char *buf,
3838 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003839{
Gilles Peskine449bd832023-01-11 14:50:10 +01003840 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 if (ret != 0) {
3843 mbedtls_ssl_session_free(session);
3844 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003847}
3848
3849/*
Paul Bakker1961b702013-01-25 14:49:24 +01003850 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003851 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003852MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003853static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003854{
3855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3856
Ronald Cron66dbf912022-02-02 15:33:46 +01003857 /*
3858 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003859 * that were written into the output buffer by the previous handshake step,
3860 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003861 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3862 * We proceed to the next handshake step only when all data from the
3863 * previous one have been sent to the peer, thus we make sure that this is
3864 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3865 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3866 * we have to wait before to go ahead.
3867 * In the case of TLS 1.3, handshake step handlers do not send data to the
3868 * peer. Data are only sent here and through
3869 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003870 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3873 return ret;
3874 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003875
3876#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3878 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3879 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3880 return ret;
3881 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003882 }
3883#endif /* MBEDTLS_SSL_PROTO_DTLS */
3884
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003886}
3887
Gilles Peskine449bd832023-01-11 14:50:10 +01003888int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003889{
Hanno Becker41934dd2021-08-07 19:13:43 +01003890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003891
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003893 ssl->conf == NULL ||
3894 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3896 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003897 }
3898
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 ret = ssl_prepare_handshake_step(ssl);
3900 if (ret != 0) {
3901 return ret;
3902 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003903
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 ret = mbedtls_ssl_handle_pending_alert(ssl);
3905 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003906 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 }
Jerry Yue7047812021-09-13 19:26:39 +08003908
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003909 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3910 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3911 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003913#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3915 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003916 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003917
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003919 case MBEDTLS_SSL_HELLO_REQUEST:
3920 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003921 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003922 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003923
Ronald Cron9f0fba32022-02-10 16:45:15 +01003924 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003926 break;
3927
3928 default:
3929#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3931 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3932 } else {
3933 ret = mbedtls_ssl_handshake_client_step(ssl);
3934 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003935#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003937#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003939#endif
3940 }
Jerry Yub9930e72021-08-06 17:11:51 +08003941 }
Ronald Cron6291b232023-03-08 15:51:25 +01003942#endif /* MBEDTLS_SSL_CLI_C */
3943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003944#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003946#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3947 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003949 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 ret = mbedtls_ssl_handshake_server_step(ssl);
3951 }
Ronald Cron6291b232023-03-08 15:51:25 +01003952#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3953 ret = mbedtls_ssl_handshake_server_step(ssl);
3954#else
3955 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003956#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003957 }
3958#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003959
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003961 /* handshake_step return error. And it is same
3962 * with alert_reason.
3963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 if (ssl->send_alert) {
3965 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003966 goto cleanup;
3967 }
3968 }
3969
3970cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003971 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003972}
3973
3974/*
3975 * Perform the SSL handshake
3976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003977int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003978{
3979 int ret = 0;
3980
Hanno Beckera817ea42020-10-20 15:20:23 +01003981 /* Sanity checks */
3982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 if (ssl == NULL || ssl->conf == NULL) {
3984 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3985 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003986
Hanno Beckera817ea42020-10-20 15:20:23 +01003987#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3989 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3990 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3991 "mbedtls_ssl_set_timer_cb() for DTLS"));
3992 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003993 }
3994#endif /* MBEDTLS_SSL_PROTO_DTLS */
3995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003997
Hanno Beckera817ea42020-10-20 15:20:23 +01003998 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4000 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004003 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 }
Paul Bakker1961b702013-01-25 14:49:24 +01004005 }
4006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004008
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004010}
4011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004012#if defined(MBEDTLS_SSL_RENEGOTIATION)
4013#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004014/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004015 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004016 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004017MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004018static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004019{
Janos Follath865b3eb2019-12-16 11:46:15 +00004020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004021
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004023
4024 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4026 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4029 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4030 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004031 }
4032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004034
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004036}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004037#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004038
4039/*
4040 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004041 * - any side: calling mbedtls_ssl_renegotiate(),
4042 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4043 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004044 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004045 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004046 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004047 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004048int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004049{
Janos Follath865b3eb2019-12-16 11:46:15 +00004050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 if ((ret = ssl_handshake_init(ssl)) != 0) {
4055 return ret;
4056 }
Paul Bakker48916f92012-09-16 19:57:18 +00004057
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004058 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4059 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004060#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4062 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4063 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004064 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004066 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004068 }
4069#endif
4070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004071 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4072 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4075 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4076 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004077 }
4078
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004082}
4083
4084/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004085 * Renegotiate current connection on client,
4086 * or request renegotiation on server
4087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004088int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004089{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004090 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (ssl == NULL || ssl->conf == NULL) {
4093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4094 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004096#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004097 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004098 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4099 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4101 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004103 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004104
4105 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (ssl->out_left != 0) {
4107 return mbedtls_ssl_flush_output(ssl);
4108 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004111 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004112#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004114#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004115 /*
4116 * On client, either start the renegotiation process or,
4117 * if already in progress, continue the handshake
4118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4120 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004122 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004123
4124 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4125 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4126 return ret;
4127 }
4128 } else {
4129 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4130 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4131 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004132 }
4133 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004134#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004137}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004138#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004141{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004142 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004145 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004147
Valerio Setti6f0441d2023-07-03 12:11:36 +02004148#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004149#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if (ssl->handshake->group_list_heap_allocated) {
4151 mbedtls_free((void *) handshake->group_list);
4152 }
Brett Warrene0edc842021-08-17 09:53:13 +01004153 handshake->group_list = NULL;
4154#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004155#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004156
Ronald Crone68ab4f2022-10-05 12:46:29 +02004157#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004158#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (ssl->handshake->sig_algs_heap_allocated) {
4160 mbedtls_free((void *) handshake->sig_algs);
4161 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004162 handshake->sig_algs = NULL;
4163#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004164#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (ssl->handshake->certificate_request_context) {
4166 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004167 }
4168#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004169#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004170
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004171#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4173 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004174 handshake->async_in_progress = 0;
4175 }
4176#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4177
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004178#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004179#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004181#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004182 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004183#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004184#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004185#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004186#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004188#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004189 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004190#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004191#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004195#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004196#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004197 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004199#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004200
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004201#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004202#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004204 /*
4205 * Opaque keys are not stored in the handshake's data and it's the user
4206 * responsibility to destroy them. Clear ones, instead, are created by
4207 * the TLS library and should be destroyed at the same level
4208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4210 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004211 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004212 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4213#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004215#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004216#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004218 handshake->ecjpake_cache = NULL;
4219 handshake->ecjpake_cache_len = 0;
4220#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004221#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004222
Valerio Setti7aeec542023-07-05 18:57:21 +02004223#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004224 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004225 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004226 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004228#endif
4229
Ronald Cron73fe8df2022-10-05 14:31:43 +02004230#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004231#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004233 /* The maintenance of the external PSK key slot is the
4234 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (ssl->handshake->psk_opaque_is_internal) {
4236 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004237 ssl->handshake->psk_opaque_is_internal = 0;
4238 }
4239 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4240 }
Neil Armstronge952a302022-05-03 10:22:14 +02004241#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004243 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004244 }
Neil Armstronge952a302022-05-03 10:22:14 +02004245#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004246#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4249 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004250 /*
4251 * Free only the linked list wrapper, not the keys themselves
4252 * since the belong to the SNI callback
4253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004255#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004256
Gilles Peskineeccd8882020-03-10 12:19:08 +01004257#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4259 if (handshake->ecrs_peer_cert != NULL) {
4260 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4261 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004262 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004263#endif
4264
Hanno Becker75173122019-02-06 16:18:31 +00004265#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4266 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004268#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4269
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004270#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4272 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004273#endif /* MBEDTLS_SSL_CLI_C &&
4274 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004275
4276#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 mbedtls_ssl_flight_free(handshake->flight);
4278 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004279#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004280
Valerio Settiea59c432023-07-25 11:14:03 +02004281#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004282 if (handshake->xxdh_psa_privkey_is_external == 0) {
4283 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 }
Valerio Settiea59c432023-07-25 11:14:03 +02004285#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004286
Ronald Cron6f135e12021-12-08 16:57:54 +01004287#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 mbedtls_ssl_transform_free(handshake->transform_handshake);
4289 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004290#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4292 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004293#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004294#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004295
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004296
4297#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4298 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4299 * processes datagrams and the fact that a datagram is allowed to have
4300 * several records in it, it is possible that the I/O buffers are not
4301 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4303 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004304#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004305
Jerry Yuba9c7272021-10-30 11:54:10 +08004306 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 mbedtls_platform_zeroize(handshake,
4308 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004309}
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004312{
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004314 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004317#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004319#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004320
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004321#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004322#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4323 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004325#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004327#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004330}
4331
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004332#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004333
4334#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4335#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4336#else
4337#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4338#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4339
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004340#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004341
4342#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4343#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4344#else
4345#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4346#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4347
4348#if defined(MBEDTLS_SSL_ALPN)
4349#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4350#else
4351#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4352#endif /* MBEDTLS_SSL_ALPN */
4353
4354#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4355#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4356#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4357#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4358
4359#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 ((uint32_t) ( \
4361 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4362 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4363 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4364 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4365 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4366 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4367 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4368 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004369
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004370static unsigned char ssl_serialized_context_header[] = {
4371 MBEDTLS_VERSION_MAJOR,
4372 MBEDTLS_VERSION_MINOR,
4373 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4375 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4376 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4377 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4378 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004379};
4380
Paul Bakker5121ce52009-01-03 21:22:43 +00004381/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004382 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004383 *
4384 * The format of the serialized data is:
4385 * (in the presentation language of TLS, RFC 8446 section 3)
4386 *
4387 * // header
4388 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004389 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004390 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004391 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004392 * Note: When updating the format, remember to keep these
4393 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004394 *
4395 * // session sub-structure
4396 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4397 * // transform sub-structure
4398 * uint8 random[64]; // ServerHello.random+ClientHello.random
4399 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4400 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4401 * // fields from ssl_context
4402 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4403 * uint64 in_window_top; // DTLS: last validated record seq_num
4404 * uint64 in_window; // DTLS: bitmask for replay protection
4405 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4406 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4407 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4408 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4409 *
4410 * Note that many fields of the ssl_context or sub-structures are not
4411 * serialized, as they fall in one of the following categories:
4412 *
4413 * 1. forced value (eg in_left must be 0)
4414 * 2. pointer to dynamically-allocated memory (eg session, transform)
4415 * 3. value can be re-derived from other data (eg session keys from MS)
4416 * 4. value was temporary (eg content of input buffer)
4417 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004419int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4420 unsigned char *buf,
4421 size_t buf_len,
4422 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004423{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004424 unsigned char *p = buf;
4425 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004426 size_t session_len;
4427 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004428
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004429 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004430 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4431 * this function's documentation.
4432 *
4433 * These are due to assumptions/limitations in the implementation. Some of
4434 * them are likely to stay (no handshake in progress) some might go away
4435 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004436 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004437 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4439 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004441 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (ssl->handshake != NULL) {
4443 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4444 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004445 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004446 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (ssl->transform == NULL || ssl->session == NULL) {
4448 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004450 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004451 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (mbedtls_ssl_check_pending(ssl) != 0) {
4453 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4454 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004455 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (ssl->out_left != 0) {
4457 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4458 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004459 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004460 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4462 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4463 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004464 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004465 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4467 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4468 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004469 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004470 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4472 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004474 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004475 /* Renegotiation must not be enabled */
4476#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4478 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4479 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004480 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004481#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004482
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004483 /*
4484 * Version and format identifier
4485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (used <= buf_len) {
4489 memcpy(p, ssl_serialized_context_header,
4490 sizeof(ssl_serialized_context_header));
4491 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004492 }
4493
4494 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004495 * Session (length + data)
4496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4498 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4499 return ret;
4500 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004501
4502 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (used <= buf_len) {
4504 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004505 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004506
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 ret = ssl_session_save(ssl->session, 1,
4508 p, session_len, &session_len);
4509 if (ret != 0) {
4510 return ret;
4511 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004512
4513 p += session_len;
4514 }
4515
4516 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004517 * Transform
4518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 used += sizeof(ssl->transform->randbytes);
4520 if (used <= buf_len) {
4521 memcpy(p, ssl->transform->randbytes,
4522 sizeof(ssl->transform->randbytes));
4523 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004524 }
4525
4526#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004527 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004529 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004531 p += ssl->transform->in_cid_len;
4532
4533 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004535 p += ssl->transform->out_cid_len;
4536 }
4537#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4538
4539 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004540 * Saved fields from top-level ssl_context structure
4541 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004542 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (used <= buf_len) {
4544 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004545 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004546 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004547
4548#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4549 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (used <= buf_len) {
4551 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004552 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004553
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004555 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004556 }
4557#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4558
4559#if defined(MBEDTLS_SSL_PROTO_DTLS)
4560 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004562 *p++ = ssl->disable_datagram_packing;
4563 }
4564#endif /* MBEDTLS_SSL_PROTO_DTLS */
4565
Jerry Yuae0b2e22021-10-08 15:21:19 +08004566 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (used <= buf_len) {
4568 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004569 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004570 }
4571
4572#if defined(MBEDTLS_SSL_PROTO_DTLS)
4573 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (used <= buf_len) {
4575 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004576 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004577 }
4578#endif /* MBEDTLS_SSL_PROTO_DTLS */
4579
4580#if defined(MBEDTLS_SSL_ALPN)
4581 {
4582 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004584 : 0;
4585
4586 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004588 *p++ = alpn_len;
4589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 if (ssl->alpn_chosen != NULL) {
4591 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004592 p += alpn_len;
4593 }
4594 }
4595 }
4596#endif /* MBEDTLS_SSL_ALPN */
4597
4598 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004599 * Done
4600 */
4601 *olen = used;
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (used > buf_len) {
4604 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4605 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004610}
4611
4612/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004613 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004614 *
4615 * This internal version is wrapped by a public function that cleans up in
4616 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004617 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004618MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004619static int ssl_context_load(mbedtls_ssl_context *ssl,
4620 const unsigned char *buf,
4621 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004622{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004623 const unsigned char *p = buf;
4624 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004625 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004628 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004629#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004630
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004631 /*
4632 * The context should have been freshly setup or reset.
4633 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004634 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004635 * renegotiating, or if the user mistakenly loaded a session first.)
4636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4638 ssl->session != NULL) {
4639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004640 }
4641
4642 /*
4643 * We can't check that the config matches the initial one, but we can at
4644 * least check it matches the requirements for serializing.
4645 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004646 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004647#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004648 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004649#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004650 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4651 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4652 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4653 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004655 }
4656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004658
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004659 /*
4660 * Check version identifier
4661 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004664 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004665
4666 if (memcmp(p, ssl_serialized_context_header,
4667 sizeof(ssl_serialized_context_header)) != 0) {
4668 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4669 }
4670 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004671
4672 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004673 * Session
4674 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if ((size_t) (end - p) < 4) {
4676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4677 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004678
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004679 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004680 p += 4;
4681
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004682 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004683 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004684 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004685 ssl->session_in = ssl->session;
4686 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004687 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if ((size_t) (end - p) < session_len) {
4690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4691 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 ret = ssl_session_load(ssl->session, 1, p, session_len);
4694 if (ret != 0) {
4695 mbedtls_ssl_session_free(ssl->session);
4696 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004697 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004698
4699 p += session_len;
4700
4701 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004702 * Transform
4703 */
4704
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004705 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004706 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004707#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004708 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004709 ssl->transform_in = ssl->transform;
4710 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004711 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004712#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004713
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004714#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4716 if (prf_func == NULL) {
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4718 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004719
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004720 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4723 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 ret = ssl_tls12_populate_transform(ssl->transform,
4726 ssl->session->ciphersuite,
4727 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004728#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004730#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 prf_func,
4732 p, /* currently pointing to randbytes */
4733 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4734 ssl->conf->endpoint,
4735 ssl);
4736 if (ret != 0) {
4737 return ret;
4738 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004739#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004741
4742#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4743 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if ((size_t) (end - p) < 1) {
4745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4746 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004747
4748 ssl->transform->in_cid_len = *p++;
4749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4752 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004755 p += ssl->transform->in_cid_len;
4756
4757 ssl->transform->out_cid_len = *p++;
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4761 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004764 p += ssl->transform->out_cid_len;
4765#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4766
4767 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004768 * Saved fields from top-level ssl_context structure
4769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if ((size_t) (end - p) < 4) {
4771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4772 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004773
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004774 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004775 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004776
4777#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if ((size_t) (end - p) < 16) {
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4780 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004781
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004782 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004783 p += 8;
4784
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004785 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004786 p += 8;
4787#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4788
4789#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if ((size_t) (end - p) < 1) {
4791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4792 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004793
4794 ssl->disable_datagram_packing = *p++;
4795#endif /* MBEDTLS_SSL_PROTO_DTLS */
4796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4798 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4799 }
4800 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4801 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004802
4803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if ((size_t) (end - p) < 2) {
4805 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4806 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004807
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004808 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004809 p += 2;
4810#endif /* MBEDTLS_SSL_PROTO_DTLS */
4811
4812#if defined(MBEDTLS_SSL_ALPN)
4813 {
4814 uint8_t alpn_len;
4815 const char **cur;
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if ((size_t) (end - p) < 1) {
4818 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4819 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004820
4821 alpn_len = *p++;
4822
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004824 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4826 if (strlen(*cur) == alpn_len &&
4827 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004828 ssl->alpn_chosen = *cur;
4829 break;
4830 }
4831 }
4832 }
4833
4834 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4836 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4837 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004838
4839 p += alpn_len;
4840 }
4841#endif /* MBEDTLS_SSL_ALPN */
4842
4843 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004844 * Forced fields from top-level ssl_context structure
4845 *
4846 * Most of them already set to the correct value by mbedtls_ssl_init() and
4847 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4848 */
4849 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004850 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004851
Hanno Becker361b10d2019-08-30 10:42:49 +01004852 /* Adjust pointers for header fields of outgoing records to
4853 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004855
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004856#if defined(MBEDTLS_SSL_PROTO_DTLS)
4857 ssl->in_epoch = 1;
4858#endif
4859
4860 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4861 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004862 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4863 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (ssl->handshake != NULL) {
4865 mbedtls_ssl_handshake_free(ssl);
4866 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004867 ssl->handshake = NULL;
4868 }
4869
4870 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004871 * Done - should have consumed entire buffer
4872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (p != end) {
4874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4875 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004878}
4879
4880/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004881 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004883int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4884 const unsigned char *buf,
4885 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004886{
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ret != 0) {
4890 mbedtls_ssl_free(context);
4891 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004894}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004895#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004896
4897/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004898 * Free an SSL context
4899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004901{
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004903 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004909#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4910 size_t out_buf_len = ssl->out_buf_len;
4911#else
4912 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4913#endif
4914
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004915 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004916 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004917 }
4918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004920#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4921 size_t in_buf_len = ssl->in_buf_len;
4922#else
4923 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4924#endif
4925
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004926 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004927 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004928 }
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (ssl->transform) {
4931 mbedtls_ssl_transform_free(ssl->transform);
4932 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004933 }
4934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (ssl->handshake) {
4936 mbedtls_ssl_handshake_free(ssl);
4937 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004938
4939#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4941 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004942#endif
4943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 mbedtls_ssl_session_free(ssl->session_negotiate);
4945 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004946 }
4947
Ronald Cron6f135e12021-12-08 16:57:54 +01004948#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 mbedtls_ssl_transform_free(ssl->transform_application);
4950 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004951#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (ssl->session) {
4954 mbedtls_ssl_session_free(ssl->session);
4955 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004956 }
4957
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004958#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004960 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004961 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004962#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004963
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004964#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004966#endif
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004969
Paul Bakker86f04f42013-02-14 11:20:09 +01004970 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004972}
4973
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004974/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004975 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004977void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004978{
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004980}
4981
Gilles Peskineae270bf2021-06-02 00:05:29 +02004982/* The selection should be the same as mbedtls_x509_crt_profile_default in
4983 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004984 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004985 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004986 * about this list.
4987 */
Brett Warrene0edc842021-08-17 09:53:13 +01004988static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004989#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004990 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004991#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004992#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004993 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004994#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004995#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004996 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004997#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004998#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004999 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005000#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005001#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005002 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005003#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005004#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005005 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005006#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005007#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005008 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005009#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005010#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005011 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005012#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005013#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005014 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5015 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5016 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5017 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5018 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5019#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005020 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005021};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005022
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005023static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005024 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5025 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5026 0
5027};
5028
Ronald Crone68ab4f2022-10-05 12:46:29 +02005029#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005030
Jerry Yu909df7b2022-01-22 11:56:27 +08005031/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005032 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005033 * rules SHOULD be upheld.
5034 * - No duplicate entries.
5035 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005036 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005037 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005038 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005039static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005040
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005041#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005042 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005043 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005044 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005045 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5046#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005047
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005048#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005049 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005050 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005051 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005052 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5053#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005054
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005055#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005056 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005057 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005058 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005059 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5060#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005063 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005064 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005065#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005066 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005067
Gilles Peskine449bd832023-01-11 14:50:10 +01005068#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005069 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005070 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005071#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005072 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005073
Gilles Peskine449bd832023-01-11 14:50:10 +01005074#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005075 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005076 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005077#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005078 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005079
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005080#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005081 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
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_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005085 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005086#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005087
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005088#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005089 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005090#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005091
Gabor Mezei15b95a62022-05-09 16:37:58 +02005092 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005093};
5094
5095/* NOTICE: see above */
5096#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5097static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005099#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005101#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005102#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5103 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5104#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005105#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005107#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005108#endif /* MBEDTLS_MD_CAN_SHA512*/
5109#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005110#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005112#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005113#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5114 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5115#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005116#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005118#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005119#endif /* MBEDTLS_MD_CAN_SHA384*/
5120#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005121#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005123#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005124#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5125 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5126#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005127#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005129#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005130#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005131 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005132};
5133#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5134/* NOTICE: see above */
5135static uint16_t ssl_preset_suiteb_sig_algs[] = {
5136
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005137#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005138 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005139 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005140 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005141 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5142#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005143
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005144#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005145 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005146 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005147 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005148 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5149#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005152 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005153 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005154#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005155 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005156
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005157#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005158 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005159#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005160
Gabor Mezei15b95a62022-05-09 16:37:58 +02005161 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005162};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005163
Jerry Yu909df7b2022-01-22 11:56:27 +08005164/* NOTICE: see above */
5165#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5166static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005167#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005168#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005170#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005171#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005173#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005174#endif /* MBEDTLS_MD_CAN_SHA256*/
5175#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005176#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005178#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005179#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005181#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005182#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005183 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005184};
Jerry Yu909df7b2022-01-22 11:56:27 +08005185#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5186
Ronald Crone68ab4f2022-10-05 12:46:29 +02005187#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005188
Brett Warrene0edc842021-08-17 09:53:13 +01005189static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005190#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005191 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005192#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005193#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005194 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005195#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005196 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005197};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005198
Ronald Crone68ab4f2022-10-05 12:46:29 +02005199#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005200/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005201 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005202MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005203static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005204{
5205 size_t i, j;
5206 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5209 for (j = 0; j < i; j++) {
5210 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005211 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 }
5213 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5214 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5215 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005216 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005217 }
5218 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005220}
5221
Ronald Crone68ab4f2022-10-05 12:46:29 +02005222#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005223
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005224/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005225 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005227int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5228 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005229{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005230#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005232#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005233
Ronald Crone68ab4f2022-10-05 12:46:29 +02005234#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5236 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5237 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005238 }
5239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5241 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5242 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005243 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005244
5245#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5247 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5248 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005249 }
5250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5252 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5253 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005254 }
5255#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005256#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005257
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005258 /* Use the functions here so that they are covered in tests,
5259 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 mbedtls_ssl_conf_endpoint(conf, endpoint);
5261 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005262
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005263 /*
5264 * Things that are common to all presets
5265 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005266#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005268 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5269#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5270 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5271#endif
5272 }
5273#endif
5274
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005275#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5276 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5277#endif
5278
5279#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5280 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5281#endif
5282
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005283#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005284 conf->f_cookie_write = ssl_cookie_write_dummy;
5285 conf->f_cookie_check = ssl_cookie_check_dummy;
5286#endif
5287
5288#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5289 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5290#endif
5291
Janos Follath088ce432017-04-10 12:42:31 +01005292#if defined(MBEDTLS_SSL_SRV_C)
5293 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005294 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005295#endif
5296
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005297#if defined(MBEDTLS_SSL_PROTO_DTLS)
5298 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5299 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5300#endif
5301
5302#if defined(MBEDTLS_SSL_RENEGOTIATION)
5303 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 memset(conf->renego_period, 0x00, 2);
5305 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005306#endif
5307
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005308#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005310 const unsigned char dhm_p[] =
5311 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5312 const unsigned char dhm_g[] =
5313 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005314
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5316 dhm_p, sizeof(dhm_p),
5317 dhm_g, sizeof(dhm_g))) != 0) {
5318 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005319 }
5320 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005321#endif
5322
Ronald Cron6f135e12021-12-08 16:57:54 +01005323#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005324
5325#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005326 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005327#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005328 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005329#endif
5330#endif /* MBEDTLS_SSL_EARLY_DATA */
5331
Jerry Yud0766ec2022-09-22 10:46:57 +08005332#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005333 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005335#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005336 /*
5337 * Allow all TLS 1.3 key exchange modes by default.
5338 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005339 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005340#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005343#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005344 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005345 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005346#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005348#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005350#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005351 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5352 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005353#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5354 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5355 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5356#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5357 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5358 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5359#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005361#endif
5362 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005363
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364 /*
5365 * Preset-specific defaults
5366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005368 /*
5369 * NSA Suite B
5370 */
5371 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005372
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005373 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005374
5375#if defined(MBEDTLS_X509_CRT_PARSE_C)
5376 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005377#endif
5378
Ronald Crone68ab4f2022-10-05 12:46:29 +02005379#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005380#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005382 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005384#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005386#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005387
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005388#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005389 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005390#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005391 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005392 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005393
5394 /*
5395 * Default
5396 */
5397 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005398
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005399 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005400
5401#if defined(MBEDTLS_X509_CRT_PARSE_C)
5402 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5403#endif
5404
Ronald Crone68ab4f2022-10-05 12:46:29 +02005405#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005406#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005408 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005410#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005412#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005413
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005414#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005415 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005416#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005417 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005418
5419#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5420 conf->dhm_min_bitlen = 1024;
5421#endif
5422 }
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005425}
5426
5427/*
5428 * Free mbedtls_ssl_config
5429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005431{
5432#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 mbedtls_mpi_free(&conf->dhm_P);
5434 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005435#endif
5436
Ronald Cron73fe8df2022-10-05 14:31:43 +02005437#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005438#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005440 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5441 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005442#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005444 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005445 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005446 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005447 }
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005450 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005451 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005452 conf->psk_identity_len = 0;
5453 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005454#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005455
5456#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005458#endif
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005461}
5462
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005463#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005464 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005465/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005468unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005469{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5472 return MBEDTLS_SSL_SIG_RSA;
5473 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005474#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005475#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5477 return MBEDTLS_SSL_SIG_ECDSA;
5478 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005479#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005481}
5482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005484{
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005486 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005488 case MBEDTLS_PK_ECDSA:
5489 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005491 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005493 }
5494}
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005497{
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005499#if defined(MBEDTLS_RSA_C)
5500 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005502#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005503#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005504 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005506#endif
5507 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005509 }
5510}
Valerio Settie9646ec2023-08-02 20:02:28 +02005511#endif /* MBEDTLS_PK_C &&
5512 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005513
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005514/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005515 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005516 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005517mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005518{
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005520#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_MD_MD5;
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_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005527#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005528#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005531#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005532#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005535#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005536#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005539#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005540#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005541 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005543#endif
5544 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005546 }
5547}
5548
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005549/*
5550 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005555#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005556 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 return MBEDTLS_SSL_HASH_MD5;
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_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005560 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005562#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005563#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005564 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005566#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005567#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005568 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005570#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005571#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005572 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005574#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005575#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005576 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005578#endif
5579 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005581 }
5582}
5583
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005584/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005585 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005586 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005588int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005589{
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005591
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (group_list == NULL) {
5593 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005594 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005595
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 for (; *group_list != 0; group_list++) {
5597 if (*group_list == tls_id) {
5598 return 0;
5599 }
5600 }
5601
5602 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005603}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005604
Valerio Setti49e69072023-06-27 17:27:51 +02005605#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005606/*
5607 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005609int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005610{
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005612
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005614 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005616
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005618}
Valerio Setti49e69072023-06-27 17:27:51 +02005619#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005620
Valerio Setti18c9fed2022-12-30 17:44:24 +01005621static const struct {
5622 uint16_t tls_id;
5623 mbedtls_ecp_group_id ecp_group_id;
5624 psa_ecc_family_t psa_family;
5625 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005626} tls_id_match_table[] =
5627{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005628#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005629 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005631#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005632 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005633#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005634#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005635 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005636#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005637#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005638 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005639#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005640#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005641 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005642#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005643#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005644 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005646#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005647 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005648#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005649#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005650 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005651#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005652#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005653 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005655#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005656 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005658#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005659 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005661#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005662 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005663#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005664#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005665 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005667 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005668};
5669
Gilles Peskine449bd832023-01-11 14:50:10 +01005670int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005671 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673{
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5675 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005676 if (type != NULL) {
5677 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 }
5679 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005680 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682 return PSA_SUCCESS;
5683 }
5684 }
5685
5686 return PSA_ERROR_NOT_SUPPORTED;
5687}
5688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005690{
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5692 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005693 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005695 }
5696
5697 return MBEDTLS_ECP_DP_NONE;
5698}
5699
Gilles Peskine449bd832023-01-11 14:50:10 +01005700uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005701{
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5703 i++) {
5704 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005705 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005707 }
5708
5709 return 0;
5710}
5711
Valerio Setti67419f02023-01-04 16:12:42 +01005712#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005713static const struct {
5714 uint16_t tls_id;
5715 const char *name;
5716} tls_id_curve_name_table[] =
5717{
Valerio Setti54e23792023-07-07 10:49:27 +02005718 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5719 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5720 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5721 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5722 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5723 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5724 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5725 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5726 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5727 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5728 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5729 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5730 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005731 { 0, NULL },
5732};
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005735{
Valerio Settiacd32c02023-06-29 18:06:29 +02005736 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5737 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5738 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005740 }
5741
5742 return NULL;
5743}
Valerio Setti67419f02023-01-04 16:12:42 +01005744#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005747int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5748 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5749 int cert_endpoint,
5750 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005751{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005752 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005753 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005754 const char *ext_oid;
5755 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005756
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005758 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 case MBEDTLS_KEY_EXCHANGE_RSA:
5761 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005762 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005763 break;
5764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005765 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5766 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5767 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5768 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005769 break;
5770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5772 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005773 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005774 break;
5775
5776 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005777 case MBEDTLS_KEY_EXCHANGE_NONE:
5778 case MBEDTLS_KEY_EXCHANGE_PSK:
5779 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5780 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005781 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005782 usage = 0;
5783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005785 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5786 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005787 }
5788
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005790 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005791 ret = -1;
5792 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005793
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5797 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005798 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005800 }
5801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005803 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005804 ret = -1;
5805 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005806
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005808}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005810
Jerry Yu148165c2021-09-24 23:20:59 +08005811#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005812int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5813 const mbedtls_md_type_t md,
5814 unsigned char *dst,
5815 size_t dst_len,
5816 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005817{
Ronald Cronf6893e12022-01-07 22:09:01 +01005818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5819 psa_hash_operation_t *hash_operation_to_clone;
5820 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5821
Jerry Yu148165c2021-09-24 23:20:59 +08005822 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005825#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 case MBEDTLS_MD_SHA384:
5827 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5828 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005829#endif
5830
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005831#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 case MBEDTLS_MD_SHA256:
5833 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5834 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005835#endif
5836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 default:
5838 goto exit;
5839 }
5840
5841 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5842 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005843 goto exit;
5844 }
5845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5847 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005848 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005850
5851exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005852#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5853 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005854 (void) ssl;
5855#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005856 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005857}
5858#else /* MBEDTLS_USE_PSA_CRYPTO */
5859
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005860#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005861MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005862static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5863 unsigned char *dst,
5864 size_t dst_len,
5865 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005867 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005868 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 if (dst_len < 48) {
5871 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5872 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005873
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005874 mbedtls_md_init(&sha384);
5875 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005876 if (ret != 0) {
5877 goto exit;
5878 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005879 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005880 if (ret != 0) {
5881 goto exit;
5882 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005883
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005884 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005885 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005886 goto exit;
5887 }
5888
5889 *olen = 48;
5890
5891exit:
5892
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005893 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005895}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005896#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005897
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005898#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005900static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5901 unsigned char *dst,
5902 size_t dst_len,
5903 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005904{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005905 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005906 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if (dst_len < 32) {
5909 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5910 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005911
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005912 mbedtls_md_init(&sha256);
5913 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5914 if (ret != 0) {
5915 goto exit;
5916 }
5917 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5918 if (ret != 0) {
5919 goto exit;
5920 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005921
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005922 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5923 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005924 goto exit;
5925 }
5926
5927 *olen = 32;
5928
5929exit:
5930
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005931 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005933}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005934#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5937 const mbedtls_md_type_t md,
5938 unsigned char *dst,
5939 size_t dst_len,
5940 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005941{
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005943
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005944#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 case MBEDTLS_MD_SHA384:
5946 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005947#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005948
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005949#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 case MBEDTLS_MD_SHA256:
5951 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005952#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005953
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005955#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5956 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 (void) ssl;
5958 (void) dst;
5959 (void) dst_len;
5960 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005961#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005963 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005965}
XiaokangQian647719a2021-12-07 09:16:29 +00005966
Jerry Yu148165c2021-09-24 23:20:59 +08005967#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005968
Ronald Crone68ab4f2022-10-05 12:46:29 +02005969#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005970/* mbedtls_ssl_parse_sig_alg_ext()
5971 *
5972 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5973 * value (TLS 1.3 RFC8446):
5974 * enum {
5975 * ....
5976 * ecdsa_secp256r1_sha256( 0x0403 ),
5977 * ecdsa_secp384r1_sha384( 0x0503 ),
5978 * ecdsa_secp521r1_sha512( 0x0603 ),
5979 * ....
5980 * } SignatureScheme;
5981 *
5982 * struct {
5983 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5984 * } SignatureSchemeList;
5985 *
5986 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5987 * value (TLS 1.2 RFC5246):
5988 * enum {
5989 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5990 * sha512(6), (255)
5991 * } HashAlgorithm;
5992 *
5993 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5994 * SignatureAlgorithm;
5995 *
5996 * struct {
5997 * HashAlgorithm hash;
5998 * SignatureAlgorithm signature;
5999 * } SignatureAndHashAlgorithm;
6000 *
6001 * SignatureAndHashAlgorithm
6002 * supported_signature_algorithms<2..2^16-2>;
6003 *
6004 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6005 * generalization of the TLS 1.2 signature algorithm extension.
6006 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6007 * `SignatureScheme` field of TLS 1.3
6008 *
6009 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006010int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6011 const unsigned char *buf,
6012 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006013{
6014 const unsigned char *p = buf;
6015 size_t supported_sig_algs_len = 0;
6016 const unsigned char *supported_sig_algs_end;
6017 uint16_t sig_alg;
6018 uint32_t common_idx = 0;
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6021 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006022 p += 2;
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 memset(ssl->handshake->received_sig_algs, 0,
6025 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006028 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 while (p < supported_sig_algs_end) {
6030 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6031 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006032 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6034 sig_alg,
6035 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6038 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6039 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006040 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006041 }
6042#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6045 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006046
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006048 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6049 common_idx += 1;
6050 }
6051 }
6052 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 if (p != end) {
6054 MBEDTLS_SSL_DEBUG_MSG(1,
6055 ("Signature algorithms extension length misaligned"));
6056 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6057 MBEDTLS_ERR_SSL_DECODE_ERROR);
6058 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006059 }
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (common_idx == 0) {
6062 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6063 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6064 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6065 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006066 }
6067
Gabor Mezei15b95a62022-05-09 16:37:58 +02006068 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006070}
6071
Ronald Crone68ab4f2022-10-05 12:46:29 +02006072#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006073
Jerry Yudc7bd172022-02-17 13:44:15 +08006074#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6075
6076#if defined(MBEDTLS_USE_PSA_CRYPTO)
6077
Gilles Peskine449bd832023-01-11 14:50:10 +01006078static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6079 mbedtls_svc_key_id_t key,
6080 psa_algorithm_t alg,
6081 const unsigned char *raw_psk, size_t raw_psk_length,
6082 const unsigned char *seed, size_t seed_length,
6083 const unsigned char *label, size_t label_length,
6084 const unsigned char *other_secret,
6085 size_t other_secret_length,
6086 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006087{
6088 psa_status_t status;
6089
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 status = psa_key_derivation_setup(derivation, alg);
6091 if (status != PSA_SUCCESS) {
6092 return status;
6093 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6096 status = psa_key_derivation_input_bytes(derivation,
6097 PSA_KEY_DERIVATION_INPUT_SEED,
6098 seed, seed_length);
6099 if (status != PSA_SUCCESS) {
6100 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006101 }
6102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if (other_secret != NULL) {
6104 status = psa_key_derivation_input_bytes(derivation,
6105 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6106 other_secret, other_secret_length);
6107 if (status != PSA_SUCCESS) {
6108 return status;
6109 }
6110 }
6111
6112 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 status = psa_key_derivation_input_bytes(
6114 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 raw_psk, raw_psk_length);
6116 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006117 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006119 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (status != PSA_SUCCESS) {
6121 return status;
6122 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 status = psa_key_derivation_input_bytes(derivation,
6125 PSA_KEY_DERIVATION_INPUT_LABEL,
6126 label, label_length);
6127 if (status != PSA_SUCCESS) {
6128 return status;
6129 }
6130 } else {
6131 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006132 }
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 status = psa_key_derivation_set_capacity(derivation, capacity);
6135 if (status != PSA_SUCCESS) {
6136 return status;
6137 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006138
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006140}
6141
Andrzej Kurek57d10632022-10-24 10:32:01 -04006142#if defined(PSA_WANT_ALG_SHA_384) || \
6143 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006145static int tls_prf_generic(mbedtls_md_type_t md_type,
6146 const unsigned char *secret, size_t slen,
6147 const char *label,
6148 const unsigned char *random, size_t rlen,
6149 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006150{
6151 psa_status_t status;
6152 psa_algorithm_t alg;
6153 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6154 psa_key_derivation_operation_t derivation =
6155 PSA_KEY_DERIVATION_OPERATION_INIT;
6156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006158 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006160 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006162
6163 /* Normally a "secret" should be long enough to be impossible to
6164 * find by brute force, and in particular should not be empty. But
6165 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6166 * and for this use case it makes sense to have a 0-length "secret".
6167 * Since the key API doesn't allow importing a key of length 0,
6168 * keep master_key=0, which setup_psa_key_derivation() understands
6169 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006171 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6173 psa_set_key_algorithm(&key_attributes, alg);
6174 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6177 if (status != PSA_SUCCESS) {
6178 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6179 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 }
6181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 status = setup_psa_key_derivation(&derivation,
6183 master_key, alg,
6184 NULL, 0,
6185 random, rlen,
6186 (unsigned char const *) label,
6187 (size_t) strlen(label),
6188 NULL, 0,
6189 dlen);
6190 if (status != PSA_SUCCESS) {
6191 psa_key_derivation_abort(&derivation);
6192 psa_destroy_key(master_key);
6193 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006194 }
6195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6197 if (status != PSA_SUCCESS) {
6198 psa_key_derivation_abort(&derivation);
6199 psa_destroy_key(master_key);
6200 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006201 }
6202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 status = psa_key_derivation_abort(&derivation);
6204 if (status != PSA_SUCCESS) {
6205 psa_destroy_key(master_key);
6206 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006207 }
6208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 if (!mbedtls_svc_key_id_is_null(master_key)) {
6210 status = psa_destroy_key(master_key);
6211 }
6212 if (status != PSA_SUCCESS) {
6213 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6214 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006215
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006217}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006218#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006219#else /* MBEDTLS_USE_PSA_CRYPTO */
6220
Andrzej Kurek57d10632022-10-24 10:32:01 -04006221#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006222 (defined(MBEDTLS_MD_CAN_SHA256) || \
6223 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006224MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006225static int tls_prf_generic(mbedtls_md_type_t md_type,
6226 const unsigned char *secret, size_t slen,
6227 const char *label,
6228 const unsigned char *random, size_t rlen,
6229 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006230{
6231 size_t nb;
6232 size_t i, j, k, md_len;
6233 unsigned char *tmp;
6234 size_t tmp_len = 0;
6235 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6236 const mbedtls_md_info_t *md_info;
6237 mbedtls_md_context_t md_ctx;
6238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6243 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6244 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 tmp_len = md_len + strlen(label) + rlen;
6249 tmp = mbedtls_calloc(1, tmp_len);
6250 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006251 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6252 goto exit;
6253 }
6254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 nb = strlen(label);
6256 memcpy(tmp + md_len, label, nb);
6257 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006258 nb += rlen;
6259
6260 /*
6261 * Compute P_<hash>(secret, label + random)[0..dlen]
6262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
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_update(&md_ctx, tmp + md_len, nb);
6272 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 }
6275 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6276 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006277 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 for (i = 0; i < dlen; i += md_len) {
6281 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len + nb);
6286 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006287 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 }
6289 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6290 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006291 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len);
6299 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
6302 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6303 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006308
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006310 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006312 }
6313
6314exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (tmp != NULL) {
6318 mbedtls_platform_zeroize(tmp, tmp_len);
6319 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006326}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006327#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006328#endif /* MBEDTLS_USE_PSA_CRYPTO */
6329
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006330#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006331MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006332static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6333 const char *label,
6334 const unsigned char *random, size_t rlen,
6335 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006336{
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6338 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006339}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006340#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006341
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006342#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006343MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006344static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6345 const char *label,
6346 const unsigned char *random, size_t rlen,
6347 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006348{
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6350 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006351}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006352#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006353
Jerry Yuf009d862022-02-17 14:01:37 +08006354/*
6355 * Set appropriate PRF function and other SSL / TLS1.2 functions
6356 *
6357 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006358 * - hash associated with the ciphersuite (only used by TLS 1.2)
6359 *
6360 * Outputs:
6361 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6362 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006363MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006364static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6365 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006366{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006367#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006369 handshake->tls_prf = tls_prf_sha384;
6370 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6371 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006373#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006374#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006375 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006376 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006377 handshake->tls_prf = tls_prf_sha256;
6378 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6379 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6380 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006381#else
Jerry Yuf009d862022-02-17 14:01:37 +08006382 {
Jerry Yuf009d862022-02-17 14:01:37 +08006383 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006384 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006386 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006387#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006390}
Jerry Yud6ab2352022-02-17 14:03:43 +08006391
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006392/*
6393 * Compute master secret if needed
6394 *
6395 * Parameters:
6396 * [in/out] handshake
6397 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6398 * (PSA-PSK) ciphersuite_info, psk_opaque
6399 * [out] premaster (cleared)
6400 * [out] master
6401 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6402 * debug: conf->f_dbg, conf->p_dbg
6403 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006404 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006407static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6408 unsigned char *master,
6409 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410{
6411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6412
6413 /* cf. RFC 5246, Section 8.1:
6414 * "The master secret is always exactly 48 bytes in length." */
6415 size_t const master_secret_len = 48;
6416
6417#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6418 unsigned char session_hash[48];
6419#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6420
6421 /* The label for the KDF used for key expansion.
6422 * This is either "master secret" or "extended master secret"
6423 * depending on whether the Extended Master Secret extension
6424 * is used. */
6425 char const *lbl = "master secret";
6426
Przemek Stekielae4ed302022-04-05 17:15:55 +02006427 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006428 * - If the Extended Master Secret extension is not used,
6429 * this is ClientHello.Random + ServerHello.Random
6430 * (see Sect. 8.1 in RFC 5246).
6431 * - If the Extended Master Secret extension is used,
6432 * this is the transcript of the handshake so far.
6433 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006434 unsigned char const *seed = handshake->randbytes;
6435 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436
6437#if !defined(MBEDTLS_DEBUG_C) && \
6438 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6439 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006441 ssl = NULL; /* make sure we don't use it except for those cases */
6442 (void) ssl;
6443#endif
6444
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 if (handshake->resume != 0) {
6446 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6447 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448 }
6449
6450#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006452 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006453 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006454 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6455 if (ret != 0) {
6456 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6457 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6460 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006462#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006463
Przemek Stekiel99114f32022-04-22 11:20:09 +02006464#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006465 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006467 /* Perform PSK-to-MS expansion in a single step. */
6468 psa_status_t status;
6469 psa_algorithm_t alg;
6470 mbedtls_svc_key_id_t psk;
6471 psa_key_derivation_operation_t derivation =
6472 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006473 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006480 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006482 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006485 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006489 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006490 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006491 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006492 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006493 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006494 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006495 other_secret_len = 48;
6496 other_secret = handshake->premaster + 2;
6497 break;
6498 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006499 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006500 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6501 other_secret = handshake->premaster + 2;
6502 break;
6503 default:
6504 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 status = setup_psa_key_derivation(&derivation, psk, alg,
6508 ssl->conf->psk, ssl->conf->psk_len,
6509 seed, seed_len,
6510 (unsigned char const *) lbl,
6511 (size_t) strlen(lbl),
6512 other_secret, other_secret_len,
6513 master_secret_len);
6514 if (status != PSA_SUCCESS) {
6515 psa_key_derivation_abort(&derivation);
6516 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006517 }
6518
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 status = psa_key_derivation_output_bytes(&derivation,
6520 master,
6521 master_secret_len);
6522 if (status != PSA_SUCCESS) {
6523 psa_key_derivation_abort(&derivation);
6524 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525 }
6526
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 status = psa_key_derivation_abort(&derivation);
6528 if (status != PSA_SUCCESS) {
6529 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6530 }
6531 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532#endif
6533 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006534#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6536 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006537 psa_status_t status;
6538 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6539 psa_key_derivation_operation_t derivation =
6540 PSA_KEY_DERIVATION_OPERATION_INIT;
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006543
6544 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6545
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 status = psa_key_derivation_setup(&derivation, alg);
6547 if (status != PSA_SUCCESS) {
6548 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006549 }
6550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 status = psa_key_derivation_set_capacity(&derivation,
6552 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6553 if (status != PSA_SUCCESS) {
6554 psa_key_derivation_abort(&derivation);
6555 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006556 }
6557
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6559 &derivation);
6560 if (status != PSA_SUCCESS) {
6561 psa_key_derivation_abort(&derivation);
6562 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006563 }
6564
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 status = psa_key_derivation_output_bytes(&derivation,
6566 handshake->premaster,
6567 handshake->pmslen);
6568 if (status != PSA_SUCCESS) {
6569 psa_key_derivation_abort(&derivation);
6570 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6571 }
6572
6573 status = psa_key_derivation_abort(&derivation);
6574 if (status != PSA_SUCCESS) {
6575 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006576 }
6577 }
6578#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6580 lbl, seed, seed_len,
6581 master,
6582 master_secret_len);
6583 if (ret != 0) {
6584 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6585 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006586 }
6587
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6589 handshake->premaster,
6590 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006591
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 mbedtls_platform_zeroize(handshake->premaster,
6593 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006594 }
6595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006597}
6598
Gilles Peskine449bd832023-01-11 14:50:10 +01006599int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006600{
6601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6602 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6603 ssl->handshake->ciphersuite_info;
6604
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006606
6607 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006609 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 if (ret != 0) {
6611 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6612 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006613 }
6614
6615 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 ret = ssl_compute_master(ssl->handshake,
6617 ssl->session_negotiate->master,
6618 ssl);
6619 if (ret != 0) {
6620 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6621 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006622 }
6623
6624 /* Swap the client and server random values:
6625 * - MS derivation wanted client+server (RFC 5246 8.1)
6626 * - key derivation wants server+client (RFC 5246 6.3) */
6627 {
6628 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 memcpy(tmp, ssl->handshake->randbytes, 64);
6630 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6631 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6632 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006633 }
6634
6635 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6637 ssl->session_negotiate->ciphersuite,
6638 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006639#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006641#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 ssl->handshake->tls_prf,
6643 ssl->handshake->randbytes,
6644 ssl->tls_version,
6645 ssl->conf->endpoint,
6646 ssl);
6647 if (ret != 0) {
6648 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6649 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006650 }
6651
6652 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6654 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006659}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006662{
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006664#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006665 case MBEDTLS_SSL_HASH_SHA384:
6666 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6667 break;
6668#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006669#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006670 case MBEDTLS_SSL_HASH_SHA256:
6671 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6672 break;
6673#endif
6674 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006676 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006677#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6678 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006679 (void) ssl;
6680#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006682}
6683
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006684#if defined(MBEDTLS_USE_PSA_CRYPTO)
6685static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6686 const psa_hash_operation_t *hs_op,
6687 size_t buffer_size,
6688 unsigned char *hash,
6689 size_t *hlen)
6690{
6691 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006692 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006693
6694#if !defined(MBEDTLS_DEBUG_C)
6695 (void) ssl;
6696#endif
6697 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006698 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006699 if (status != PSA_SUCCESS) {
6700 goto exit;
6701 }
6702
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006703 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006704 if (status != PSA_SUCCESS) {
6705 goto exit;
6706 }
6707
6708 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6709 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6710
6711exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006712 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006713 return mbedtls_md_error_from_psa(status);
6714}
6715#else
6716static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6717 const mbedtls_md_context_t *hs_ctx,
6718 unsigned char *hash,
6719 size_t *hlen)
6720{
6721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006722 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006723
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006724 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006725
6726#if !defined(MBEDTLS_DEBUG_C)
6727 (void) ssl;
6728#endif
6729 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6730
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006731 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006732 if (ret != 0) {
6733 goto exit;
6734 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006735 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006736 if (ret != 0) {
6737 goto exit;
6738 }
6739
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006740 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006741 if (ret != 0) {
6742 goto exit;
6743 }
6744
6745 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6746
6747 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6748 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6749
6750exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006751 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006752 return ret;
6753}
6754#endif /* MBEDTLS_USE_PSA_CRYPTO */
6755
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006756#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006757int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6758 unsigned char *hash,
6759 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006760{
6761#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006762 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6763 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006764#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006765 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6766 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006767#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006768}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006769#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006770
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006771#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006772int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6773 unsigned char *hash,
6774 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006775{
6776#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006777 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6778 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006779#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006780 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6781 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006782#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006783}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006784#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006785
Neil Armstrong80f6f322022-05-03 17:56:38 +02006786#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6787 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006788int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006789{
6790 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006792 const unsigned char *psk = NULL;
6793 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006797 /*
6798 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006799 * checked before calling this function.
6800 *
6801 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006802 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6805 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6806 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006807 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006808 }
6809
6810 /*
6811 * PMS = struct {
6812 * opaque other_secret<0..2^16-1>;
6813 * opaque psk<0..2^16-1>;
6814 * };
6815 * with "other_secret" depending on the particular key exchange
6816 */
6817#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6819 if (end - p < 2) {
6820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6821 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006824 p += 2;
6825
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 if (end < p || (size_t) (end - p) < psk_len) {
6827 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6828 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006833#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6834#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006836 /*
6837 * other_secret already set by the ClientKeyExchange message,
6838 * and is 48 bytes long
6839 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 if (end - p < 2) {
6841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6842 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006843
6844 *p++ = 0;
6845 *p++ = 48;
6846 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006848#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6849#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006851 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6852 size_t len;
6853
6854 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006856 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6858 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6859 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006860 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006862 p += 2 + len;
6863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6865 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006866#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006867#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6870 size_t zlen;
6871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006873 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6875 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6876 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006877 }
6878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006880 p += 2 + zlen;
6881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6883 MBEDTLS_DEBUG_ECDH_Z);
6884 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006885#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006886 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6888 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006889 }
6890
6891 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 if (end - p < 2) {
6893 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6894 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006897 p += 2;
6898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 if (end < p || (size_t) (end - p) < psk_len) {
6900 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6901 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006904 p += psk_len;
6905
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006906 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006909}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006910#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006911
6912#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006914static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006915
6916#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006917int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006918{
6919 /* If renegotiation is not enforced, retransmit until we would reach max
6920 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006922 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6923 unsigned char doublings = 1;
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006926 ++doublings;
6927 ratio >>= 1;
6928 }
6929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 if (++ssl->renego_records_seen > doublings) {
6931 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6932 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006933 }
6934 }
6935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006937}
6938#endif
6939#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006940
Jerry Yud9526692022-02-17 14:23:47 +08006941/*
6942 * Handshake functions
6943 */
6944#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6945/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006946int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006947{
6948 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6949 ssl->handshake->ciphersuite_info;
6950
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6954 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006955 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006957 }
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6960 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006961}
6962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006964{
6965 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6966 ssl->handshake->ciphersuite_info;
6967
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6971 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006972 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006974 }
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6977 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006978}
6979
6980#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6981/* Some certificate support -> implement write and parse */
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006984{
6985 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6986 size_t i, n;
6987 const mbedtls_x509_crt *crt;
6988 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6989 ssl->handshake->ciphersuite_info;
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006992
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6994 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006995 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006997 }
6998
6999#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7001 if (ssl->handshake->client_auth == 0) {
7002 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007003 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007005 }
7006 }
7007#endif /* MBEDTLS_SSL_CLI_C */
7008#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7010 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007011 /* Should never happen because we shouldn't have picked the
7012 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007014 }
7015 }
7016#endif
7017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007019
7020 /*
7021 * 0 . 0 handshake type
7022 * 1 . 3 handshake length
7023 * 4 . 6 length of all certs
7024 * 7 . 9 length of cert. 1
7025 * 10 . n-1 peer certificate
7026 * n . n+2 length of cert. 2
7027 * n+3 . ... upper level cert, etc.
7028 */
7029 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007033 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7035 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7036 " > %" MBEDTLS_PRINTF_SIZET,
7037 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7038 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007039 }
7040
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7042 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7043 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007046 i += n; crt = crt->next;
7047 }
7048
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7050 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7051 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007052
7053 ssl->out_msglen = i;
7054 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7055 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7056
7057 ssl->state++;
7058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7060 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7061 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007062 }
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007065
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007067}
7068
7069#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7070
7071#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007072MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007073static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7074 unsigned char *crt_buf,
7075 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007076{
7077 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (peer_crt == NULL) {
7080 return -1;
7081 }
Jerry Yud9526692022-02-17 14:23:47 +08007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (peer_crt->raw.len != crt_buf_len) {
7084 return -1;
7085 }
Jerry Yud9526692022-02-17 14:23:47 +08007086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007088}
7089#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007090MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007091static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7092 unsigned char *crt_buf,
7093 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007094{
7095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7096 unsigned char const * const peer_cert_digest =
7097 ssl->session->peer_cert_digest;
7098 mbedtls_md_type_t const peer_cert_digest_type =
7099 ssl->session->peer_cert_digest_type;
7100 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007102 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7103 size_t digest_len;
7104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if (peer_cert_digest == NULL || digest_info == NULL) {
7106 return -1;
7107 }
Jerry Yud9526692022-02-17 14:23:47 +08007108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 digest_len = mbedtls_md_get_size(digest_info);
7110 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7111 return -1;
7112 }
Jerry Yud9526692022-02-17 14:23:47 +08007113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7115 if (ret != 0) {
7116 return -1;
7117 }
Jerry Yud9526692022-02-17 14:23:47 +08007118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007120}
7121#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7122#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7123
7124/*
7125 * Once the certificate message is read, parse it into a cert chain and
7126 * perform basic checks, but leave actual verification to the caller
7127 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007129static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7130 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007131{
7132 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7133#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007135#endif
7136 size_t i, n;
7137 uint8_t alert;
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7140 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7141 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7142 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7143 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007144 }
7145
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7147 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7148 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7149 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007150 }
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7153 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7154 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7155 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7156 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007157 }
7158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007160
7161 /*
7162 * Same message structure as in mbedtls_ssl_write_certificate()
7163 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007164 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 if (ssl->in_msg[i] != 0 ||
7167 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7168 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7169 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7170 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7171 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007172 }
7173
7174 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7175 i += 3;
7176
7177 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007179 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (i + 3 > ssl->in_hslen) {
7181 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7182 mbedtls_ssl_send_alert_message(ssl,
7183 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7184 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7185 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007186 }
7187 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7188 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 if (ssl->in_msg[i] != 0) {
7190 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7191 mbedtls_ssl_send_alert_message(ssl,
7192 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7193 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7194 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007195 }
7196
7197 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007198 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007199 i += 3;
7200
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 if (n < 128 || i + n > ssl->in_hslen) {
7202 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7203 mbedtls_ssl_send_alert_message(ssl,
7204 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7205 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7206 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007207 }
7208
7209 /* Check if we're handling the first CRT in the chain. */
7210#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007212 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007214 /* During client-side renegotiation, check that the server's
7215 * end-CRTs hasn't changed compared to the initial handshake,
7216 * mitigating the triple handshake attack. On success, reuse
7217 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7219 if (ssl_check_peer_crt_unchanged(ssl,
7220 &ssl->in_msg[i],
7221 n) != 0) {
7222 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7223 mbedtls_ssl_send_alert_message(ssl,
7224 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7225 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7226 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007227 }
7228
7229 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007231 }
7232#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7233
7234 /* Parse the next certificate in the chain. */
7235#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007236 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007237#else
7238 /* If we don't need to store the CRT chain permanently, parse
7239 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007241#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007243 case 0: /*ok*/
7244 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7245 /* Ignore certificate with an unknown algorithm: maybe a
7246 prior certificate was already trusted. */
7247 break;
7248
7249 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7250 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7251 goto crt_parse_der_failed;
7252
7253 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7254 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7255 goto crt_parse_der_failed;
7256
7257 default:
7258 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007259crt_parse_der_failed:
7260 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7261 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7262 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007263 }
7264
7265 i += n;
7266 }
7267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7269 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007270}
7271
7272#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007274static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007275{
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7277 return -1;
7278 }
Jerry Yud9526692022-02-17 14:23:47 +08007279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007281 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7282 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7284 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7285 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007286 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007288}
7289#endif /* MBEDTLS_SSL_SRV_C */
7290
7291/* Check if a certificate message is expected.
7292 * Return either
7293 * - SSL_CERTIFICATE_EXPECTED, or
7294 * - SSL_CERTIFICATE_SKIP
7295 * indicating whether a Certificate message is expected or not.
7296 */
7297#define SSL_CERTIFICATE_EXPECTED 0
7298#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007299MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007300static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7301 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007302{
7303 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7304 ssl->handshake->ciphersuite_info;
7305
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7307 return SSL_CERTIFICATE_SKIP;
7308 }
Jerry Yud9526692022-02-17 14:23:47 +08007309
7310#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7312 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7313 return SSL_CERTIFICATE_SKIP;
7314 }
Jerry Yud9526692022-02-17 14:23:47 +08007315
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007317 ssl->session_negotiate->verify_result =
7318 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007320 }
7321 }
7322#else
7323 ((void) authmode);
7324#endif /* MBEDTLS_SSL_SRV_C */
7325
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007327}
7328
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007329MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007330static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7331 int authmode,
7332 mbedtls_x509_crt *chain,
7333 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007334{
7335 int ret = 0;
7336 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7337 ssl->handshake->ciphersuite_info;
7338 int have_ca_chain = 0;
7339
7340 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7341 void *p_vrfy;
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7344 return 0;
7345 }
Jerry Yud9526692022-02-17 14:23:47 +08007346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (ssl->f_vrfy != NULL) {
7348 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007349 f_vrfy = ssl->f_vrfy;
7350 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 } else {
7352 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007353 f_vrfy = ssl->conf->f_vrfy;
7354 p_vrfy = ssl->conf->p_vrfy;
7355 }
7356
7357 /*
7358 * Main check: verify certificate
7359 */
7360#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007362 ((void) rs_ctx);
7363 have_ca_chain = 1;
7364
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007366 ret = mbedtls_x509_crt_verify_with_ca_cb(
7367 chain,
7368 ssl->conf->f_ca_cb,
7369 ssl->conf->p_ca_cb,
7370 ssl->conf->cert_profile,
7371 ssl->hostname,
7372 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 f_vrfy, p_vrfy);
7374 } else
Jerry Yud9526692022-02-17 14:23:47 +08007375#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7376 {
7377 mbedtls_x509_crt *ca_chain;
7378 mbedtls_x509_crl *ca_crl;
7379
7380#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007382 ca_chain = ssl->handshake->sni_ca_chain;
7383 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 } else
Jerry Yud9526692022-02-17 14:23:47 +08007385#endif
7386 {
7387 ca_chain = ssl->conf->ca_chain;
7388 ca_crl = ssl->conf->ca_crl;
7389 }
7390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007392 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 }
Jerry Yud9526692022-02-17 14:23:47 +08007394
7395 ret = mbedtls_x509_crt_verify_restartable(
7396 chain,
7397 ca_chain, ca_crl,
7398 ssl->conf->cert_profile,
7399 ssl->hostname,
7400 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007402 }
7403
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 if (ret != 0) {
7405 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007406 }
7407
7408#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7410 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7411 }
Jerry Yud9526692022-02-17 14:23:47 +08007412#endif
7413
7414 /*
7415 * Secondary checks: always done, but change 'ret' only if it was 0
7416 */
7417
Valerio Settiacd32c02023-06-29 18:06:29 +02007418#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007419 {
7420 const mbedtls_pk_context *pk = &chain->pk;
7421
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007422 /* If certificate uses an EC key, make sure the curve is OK.
7423 * This is a public key, so it can't be opaque, so can_do() is a good
7424 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007426 /* and in the unlikely case the above assumption no longer holds
7427 * we are making sure that pk_ec() here does not return a NULL
7428 */
Valerio Settid0405092023-05-24 13:16:40 +02007429 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7430 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7431 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007433 }
Valerio Setti97207782023-05-18 18:59:06 +02007434 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007435 ssl->session_negotiate->verify_result |=
7436 MBEDTLS_X509_BADCERT_BAD_KEY;
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7439 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007440 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007442 }
Jerry Yud9526692022-02-17 14:23:47 +08007443 }
7444 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007445#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (mbedtls_ssl_check_cert_usage(chain,
7448 ciphersuite_info,
7449 !ssl->conf->endpoint,
7450 &ssl->session_negotiate->verify_result) != 0) {
7451 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7452 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 }
Jerry Yud9526692022-02-17 14:23:47 +08007455 }
7456
7457 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7458 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7459 * with details encoded in the verification flags. All other kinds
7460 * of error codes, including those from the user provided f_vrfy
7461 * functions, are treated as fatal and lead to a failure of
7462 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7464 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7465 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007466 ret = 0;
7467 }
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7470 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007471 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7472 }
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007475 uint8_t alert;
7476
7477 /* The certificate may have been rejected for several reasons.
7478 Pick one and send the corresponding alert. Which alert to send
7479 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007481 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007483 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
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_EXT_KEY_USAGE) {
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_NS_CERT_TYPE) {
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_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007491 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007493 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007495 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007497 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007499 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007501 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 }
7503 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7504 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007505 }
7506
7507#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (ssl->session_negotiate->verify_result != 0) {
7509 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7510 (unsigned int) ssl->session_negotiate->verify_result));
7511 } else {
7512 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007513 }
7514#endif /* MBEDTLS_DEBUG_C */
7515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007517}
7518
7519#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007520MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007521static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7522 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007523{
7524 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7525 /* Remember digest of the peer's end-CRT. */
7526 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7528 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7529 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7530 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7531 mbedtls_ssl_send_alert_message(ssl,
7532 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7533 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007534
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007536 }
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 ret = mbedtls_md(mbedtls_md_info_from_type(
7539 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7540 start, len,
7541 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007542
7543 ssl->session_negotiate->peer_cert_digest_type =
7544 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7545 ssl->session_negotiate->peer_cert_digest_len =
7546 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007549}
7550
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007551MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007552static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7553 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007554{
7555 unsigned char *end = start + len;
7556 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7557
7558 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7560 ret = mbedtls_pk_parse_subpubkey(&start, end,
7561 &ssl->handshake->peer_pubkey);
7562 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007563 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007565 }
7566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007568}
7569#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007572{
7573 int ret = 0;
7574 int crt_expected;
7575#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7576 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7577 ? ssl->handshake->sni_authmode
7578 : ssl->conf->authmode;
7579#else
7580 const int authmode = ssl->conf->authmode;
7581#endif
7582 void *rs_ctx = NULL;
7583 mbedtls_x509_crt *chain = NULL;
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007586
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7588 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7589 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007590 goto exit;
7591 }
7592
7593#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (ssl->handshake->ecrs_enabled &&
7595 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007596 chain = ssl->handshake->ecrs_peer_cert;
7597 ssl->handshake->ecrs_peer_cert = NULL;
7598 goto crt_verify;
7599 }
7600#endif
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007603 /* mbedtls_ssl_read_record may have sent an alert already. We
7604 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007606 goto exit;
7607 }
7608
7609#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007611 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007614 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 }
Jerry Yud9526692022-02-17 14:23:47 +08007616
7617 goto exit;
7618 }
7619#endif /* MBEDTLS_SSL_SRV_C */
7620
7621 /* Clear existing peer CRT structure in case we tried to
7622 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7626 if (chain == NULL) {
7627 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7628 sizeof(mbedtls_x509_crt)));
7629 mbedtls_ssl_send_alert_message(ssl,
7630 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7631 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007632
7633 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7634 goto exit;
7635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 ret = ssl_parse_certificate_chain(ssl, chain);
7639 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007640 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 }
Jerry Yud9526692022-02-17 14:23:47 +08007642
7643#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007645 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 }
Jerry Yud9526692022-02-17 14:23:47 +08007647
7648crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007650 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 }
Jerry Yud9526692022-02-17 14:23:47 +08007652#endif
7653
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 ret = ssl_parse_certificate_verify(ssl, authmode,
7655 chain, rs_ctx);
7656 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007657 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 }
Jerry Yud9526692022-02-17 14:23:47 +08007659
7660#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7661 {
7662 unsigned char *crt_start, *pk_start;
7663 size_t crt_len, pk_len;
7664
7665 /* We parse the CRT chain without copying, so
7666 * these pointers point into the input buffer,
7667 * and are hence still valid after freeing the
7668 * CRT chain. */
7669
7670 crt_start = chain->raw.p;
7671 crt_len = chain->raw.len;
7672
7673 pk_start = chain->pk_raw.p;
7674 pk_len = chain->pk_raw.len;
7675
7676 /* Free the CRT structures before computing
7677 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 mbedtls_x509_crt_free(chain);
7679 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007680 chain = NULL;
7681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7683 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007684 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 }
Jerry Yud9526692022-02-17 14:23:47 +08007686
Gilles Peskine449bd832023-01-11 14:50:10 +01007687 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7688 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007689 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 }
Jerry Yud9526692022-02-17 14:23:47 +08007691 }
7692#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7693 /* Pass ownership to session structure. */
7694 ssl->session_negotiate->peer_cert = chain;
7695 chain = NULL;
7696#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007699
7700exit:
7701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007703 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 }
Jerry Yud9526692022-02-17 14:23:47 +08007705
7706#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007708 ssl->handshake->ecrs_peer_cert = chain;
7709 chain = NULL;
7710 }
7711#endif
7712
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 if (chain != NULL) {
7714 mbedtls_x509_crt_free(chain);
7715 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007716 }
7717
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007719}
7720#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7721
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007722static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7723 unsigned char *padbuf, size_t hlen,
7724 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007725{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007726 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007727 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007728#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007730 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007731 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007732 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007733#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007735 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007736 mbedtls_md_context_t cloned_ctx;
7737 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738#endif
7739
7740 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007742 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007744
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007746 ? "client finished"
7747 : "server finished";
7748
7749#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007750 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007751
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007752 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007754 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007755 }
7756
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007757 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007759 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007760 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007761 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007762#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007763 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007764
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007765 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007766 if (ret != 0) {
7767 goto exit;
7768 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007769 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007770 if (ret != 0) {
7771 goto exit;
7772 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007773
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007774 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007775 if (ret != 0) {
7776 goto exit;
7777 }
7778#endif /* MBEDTLS_USE_PSA_CRYPTO */
7779
7780 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7781
Jerry Yu615bd6f2022-02-17 14:25:15 +08007782 /*
7783 * TLSv1.2:
7784 * hash = PRF( master, finished_label,
7785 * Hash( handshake ) )[0.11]
7786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007788 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007791
Paul Elliottecb95be2023-08-11 16:41:04 +01007792 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007793
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007794 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007795
7796exit:
7797#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007798 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007799 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007800#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007801 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007802 return ret;
7803#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007804}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007805
7806#if defined(MBEDTLS_MD_CAN_SHA256)
7807static int ssl_calc_finished_tls_sha256(
7808 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7809{
7810 unsigned char padbuf[32];
7811 return ssl_calc_finished_tls_generic(ssl,
7812#if defined(MBEDTLS_USE_PSA_CRYPTO)
7813 &ssl->handshake->fin_sha256_psa,
7814#else
7815 &ssl->handshake->fin_sha256,
7816#endif
7817 padbuf, sizeof(padbuf),
7818 buf, from);
7819}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007820#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007821
Jerry Yub7ba49e2022-02-17 14:25:53 +08007822
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007823#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007824static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007826{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007827 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007828 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007829#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007830 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007831#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007832 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007833#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007834 padbuf, sizeof(padbuf),
7835 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007836}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007837#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007838
Gilles Peskine449bd832023-01-11 14:50:10 +01007839void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007840{
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007842
7843 /*
7844 * Free our handshake params
7845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 mbedtls_ssl_handshake_free(ssl);
7847 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007848 ssl->handshake = NULL;
7849
7850 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007851 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 if (ssl->transform) {
7854 mbedtls_ssl_transform_free(ssl->transform);
7855 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007856 }
7857 ssl->transform = ssl->transform_negotiate;
7858 ssl->transform_negotiate = NULL;
7859
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007861}
7862
Gilles Peskine449bd832023-01-11 14:50:10 +01007863void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007864{
7865 int resume = ssl->handshake->resume;
7866
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007868
7869#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007871 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7872 ssl->renego_records_seen = 0;
7873 }
7874#endif
7875
7876 /*
7877 * Free the previous session and switch in the current one
7878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007880#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7881 /* RFC 7366 3.1: keep the EtM state */
7882 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007884#endif
7885
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 mbedtls_ssl_session_free(ssl->session);
7887 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007888 }
7889 ssl->session = ssl->session_negotiate;
7890 ssl->session_negotiate = NULL;
7891
7892 /*
7893 * Add cache entry
7894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007896 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 resume == 0) {
7898 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7899 ssl->session->id,
7900 ssl->session->id_len,
7901 ssl->session) != 0) {
7902 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7903 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007904 }
7905
7906#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7908 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007909 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911
7912 /* Keep last flight around in case we need to resend it:
7913 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7915 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007916#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007918
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007919 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007920
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007922}
7923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007926 int ret;
7927 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007928
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007932
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007933 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7934 if (ret != 0) {
7935 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7936 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007937
7938 /*
7939 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7940 * may define some other value. Currently (early 2016), no defined
7941 * ciphersuite does this (and this is unlikely to change as activity has
7942 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7943 */
7944 hash_len = 12;
7945
7946#if defined(MBEDTLS_SSL_RENEGOTIATION)
7947 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007949#endif
7950
7951 ssl->out_msglen = 4 + hash_len;
7952 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7953 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7954
7955 /*
7956 * In case of session resuming, invert the client and server
7957 * ChangeCipherSpec messages order.
7958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007964#endif
7965#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007967 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007969#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007971 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973
7974 /*
7975 * Switch to our negotiated transform and session parameters for outbound
7976 * data.
7977 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007979
7980#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982 unsigned char i;
7983
7984 /* Remember current epoch settings for resending */
7985 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7987 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007988
7989 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007991
7992
7993 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 for (i = 2; i > 0; i--) {
7995 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007996 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 }
7998 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999
8000 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (i == 0) {
8002 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8003 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008004 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008006#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008008
8009 ssl->transform_out = ssl->transform_negotiate;
8010 ssl->session_out = ssl->session_negotiate;
8011
8012#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8014 mbedtls_ssl_send_flight_completed(ssl);
8015 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016#endif
8017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8019 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8020 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021 }
8022
8023#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8025 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8026 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8027 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008028 }
8029#endif
8030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008034}
8035
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008036#define SSL_MAX_HASH_LEN 12
8037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008039{
8040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8041 unsigned int hash_len = 12;
8042 unsigned char buf[SSL_MAX_HASH_LEN];
8043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008045
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008046 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8047 if (ret != 0) {
8048 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8049 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008053 goto exit;
8054 }
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8057 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8058 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8059 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008060 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8061 goto exit;
8062 }
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8065 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8066 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008067 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8068 goto exit;
8069 }
8070
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8072 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8073 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8074 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8076 goto exit;
8077 }
8078
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8080 buf, hash_len) != 0) {
8081 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8082 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8083 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008084 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8085 goto exit;
8086 }
8087
8088#if defined(MBEDTLS_SSL_RENEGOTIATION)
8089 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008091#endif
8092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008094#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008096 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008098#endif
8099#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008101 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008103#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008105 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008107
8108#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8110 mbedtls_ssl_recv_flight_completed(ssl);
8111 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008112#endif
8113
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008115
8116exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 mbedtls_platform_zeroize(buf, hash_len);
8118 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008119}
8120
Jerry Yu392112c2022-02-17 14:34:10 +08008121#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8122/*
8123 * Helper to get TLS 1.2 PRF from ciphersuite
8124 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8125 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008126static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008127{
Jerry Yu392112c2022-02-17 14:34:10 +08008128 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008130#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8132 return tls_prf_sha384;
8133 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008134#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008135#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008136 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8138 return tls_prf_sha256;
8139 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008140 }
8141#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008142#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8143 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008144 (void) ciphersuite_info;
8145#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008148}
8149#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008150
Gilles Peskine449bd832023-01-11 14:50:10 +01008151static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008152{
8153 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008154#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 if (tls_prf == tls_prf_sha384) {
8156 return MBEDTLS_SSL_TLS_PRF_SHA384;
8157 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008159#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 if (tls_prf == tls_prf_sha256) {
8161 return MBEDTLS_SSL_TLS_PRF_SHA256;
8162 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008163#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008165}
8166
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008167/*
8168 * Populate a transform structure with session keys and all the other
8169 * necessary information.
8170 *
8171 * Parameters:
8172 * - [in/out]: transform: structure to populate
8173 * [in] must be just initialised with mbedtls_ssl_transform_init()
8174 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8175 * - [in] ciphersuite
8176 * - [in] master
8177 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008178 * - [in] tls_prf: pointer to PRF to use for key derivation
8179 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008180 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008181 * - [in] endpoint: client or server
8182 * - [in] ssl: used for:
8183 * - ssl->conf->{f,p}_export_keys
8184 * [in] optionally used for:
8185 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8186 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008187MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008188static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8189 int ciphersuite,
8190 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008191#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008193#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 ssl_tls_prf_t tls_prf,
8195 const unsigned char randbytes[64],
8196 mbedtls_ssl_protocol_version tls_version,
8197 unsigned endpoint,
8198 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008199{
8200 int ret = 0;
8201 unsigned char keyblk[256];
8202 unsigned char *key1;
8203 unsigned char *key2;
8204 unsigned char *mac_enc;
8205 unsigned char *mac_dec;
8206 size_t mac_key_len = 0;
8207 size_t iv_copy_len;
8208 size_t keylen;
8209 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008210 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008211#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008212 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008213 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008214#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008215
8216#if defined(MBEDTLS_USE_PSA_CRYPTO)
8217 psa_key_type_t key_type;
8218 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8219 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008220 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008221 size_t key_bits;
8222 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8223#endif
8224
8225#if !defined(MBEDTLS_DEBUG_C) && \
8226 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008228 ssl = NULL; /* make sure we don't use it except for these cases */
8229 (void) ssl;
8230 }
8231#endif
8232
8233 /*
8234 * Some data just needs copying into the structure
8235 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008236#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008237 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008238#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008239 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008240
8241#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008243#endif
8244
8245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008247 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8248 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250 }
8251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8252
8253 /*
8254 * Get various info structures
8255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8257 if (ciphersuite_info == NULL) {
8258 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8259 ciphersuite));
8260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261 }
8262
Neil Armstrongab555e02022-04-04 11:07:59 +02008263 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008264#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008266#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008270 transform->taglen =
8271 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008273
8274#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008275 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 transform->taglen,
8277 &alg,
8278 &key_type,
8279 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008280 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008282 goto end;
8283 }
8284#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008285 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (cipher_info == NULL) {
8287 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8288 ciphersuite_info->cipher));
8289 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008290 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008291#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008292
Neil Armstronge4512952022-03-08 09:08:22 +01008293#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008294 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008296 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 (unsigned) ciphersuite_info->mac));
8298 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008299 }
8300#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008301 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 if (md_info == NULL) {
8303 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8304 (unsigned) ciphersuite_info->mac));
8305 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008306 }
Neil Armstronge4512952022-03-08 09:08:22 +01008307#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008308
8309#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8310 /* Copy own and peer's CID if the use of the CID
8311 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8313 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008314
8315 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8317 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8318 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008319
8320 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8322 ssl->handshake->peer_cid_len);
8323 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8324 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325 }
8326#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8327
8328 /*
8329 * Compute key block using the PRF
8330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8332 if (ret != 0) {
8333 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8334 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008335 }
8336
Gilles Peskine449bd832023-01-11 14:50:10 +01008337 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8338 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8339 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8340 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8341 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008342
8343 /*
8344 * Determine the appropriate key, IV and MAC length.
8345 */
8346
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008347#if defined(MBEDTLS_USE_PSA_CRYPTO)
8348 keylen = PSA_BITS_TO_BYTES(key_bits);
8349#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008351#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008352
Valerio Settie5707042023-10-11 11:54:42 +02008353#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 size_t explicit_ivlen;
8356
8357 transform->maclen = 0;
8358 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008359
8360 /* All modes haves 96-bit IVs, but the length of the static parts vary
8361 * with mode and version:
8362 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8363 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8364 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8365 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8366 * sequence number).
8367 */
8368 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008369
8370 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008371#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008373#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8375 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008376#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008377
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008381 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008383
8384 /* Minimum length of encrypted record */
8385 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8386 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 } else
Valerio Settie5707042023-10-11 11:54:42 +02008388#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008389#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008391 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008393#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008395#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008396 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008397#endif /* MBEDTLS_USE_PSA_CRYPTO */
8398
8399#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008400 /* Get MAC length */
8401 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8402#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8405 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8406 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407 goto end;
8408 }
8409
8410 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008412#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008413 transform->maclen = mac_key_len;
8414
8415 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008416#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008418#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008419 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008420#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008421
8422 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008423 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008424 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008426 /*
8427 * GenericBlockCipher:
8428 * 1. if EtM is in use: one block plus MAC
8429 * otherwise: * first multiple of blocklen greater than maclen
8430 * 2. IV
8431 */
8432#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 + block_size;
8436 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008437#endif
8438 {
8439 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 + block_size
8441 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 }
8443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 } else {
8447 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008448 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8449 goto end;
8450 }
8451 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8454 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8456 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008457 }
8458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8460 (unsigned) keylen,
8461 (unsigned) transform->minlen,
8462 (unsigned) transform->ivlen,
8463 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008464
8465 /*
8466 * Finally setup the cipher contexts, IVs and MAC secrets.
8467 */
8468#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008470 key1 = keyblk + mac_key_len * 2;
8471 key2 = keyblk + mac_key_len * 2 + keylen;
8472
8473 mac_enc = keyblk;
8474 mac_dec = keyblk + mac_key_len;
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 iv_copy_len = (transform->fixed_ivlen) ?
8477 transform->fixed_ivlen : transform->ivlen;
8478 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8479 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8480 iv_copy_len);
8481 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008482#endif /* MBEDTLS_SSL_CLI_C */
8483#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 key1 = keyblk + mac_key_len * 2 + keylen;
8486 key2 = keyblk + mac_key_len * 2;
8487
8488 mac_enc = keyblk + mac_key_len;
8489 mac_dec = keyblk;
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 iv_copy_len = (transform->fixed_ivlen) ?
8492 transform->fixed_ivlen : transform->ivlen;
8493 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8494 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8495 iv_copy_len);
8496 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008497#endif /* MBEDTLS_SSL_SRV_C */
8498 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008499 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008500 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8501 goto end;
8502 }
8503
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (ssl != NULL && ssl->f_export_keys != NULL) {
8505 ssl->f_export_keys(ssl->p_export_keys,
8506 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8507 master, 48,
8508 randbytes + 32,
8509 randbytes,
8510 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008511 }
8512
8513#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008514 transform->psa_alg = alg;
8515
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8517 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8518 psa_set_key_algorithm(&attributes, alg);
8519 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008520
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 if ((status = psa_import_key(&attributes,
8522 key1,
8523 PSA_BITS_TO_BYTES(key_bits),
8524 &transform->psa_key_enc)) != PSA_SUCCESS) {
8525 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008526 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008528 goto end;
8529 }
8530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008532
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if ((status = psa_import_key(&attributes,
8534 key2,
8535 PSA_BITS_TO_BYTES(key_bits),
8536 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008537 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008539 goto end;
8540 }
8541 }
8542#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8544 cipher_info)) != 0) {
8545 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008546 goto end;
8547 }
8548
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8550 cipher_info)) != 0) {
8551 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008552 goto end;
8553 }
8554
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8556 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8557 MBEDTLS_ENCRYPT)) != 0) {
8558 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559 goto end;
8560 }
8561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8563 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8564 MBEDTLS_DECRYPT)) != 0) {
8565 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008566 goto end;
8567 }
8568
8569#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8571 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8572 MBEDTLS_PADDING_NONE)) != 0) {
8573 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008574 goto end;
8575 }
8576
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8578 MBEDTLS_PADDING_NONE)) != 0) {
8579 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008580 goto end;
8581 }
8582 }
8583#endif /* MBEDTLS_CIPHER_MODE_CBC */
8584#endif /* MBEDTLS_USE_PSA_CRYPTO */
8585
Neil Armstrong29c0c042022-03-17 17:47:28 +01008586#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8587 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8588 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008590#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008592
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8594 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8595 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008596
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 if ((status = psa_import_key(&attributes,
8598 mac_enc, mac_key_len,
8599 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008600 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008602 goto end;
8603 }
8604
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8606 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008607#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008609#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008611 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8613 PSA_KEY_USAGE_VERIFY_HASH);
8614 } else {
8615 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8616 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if ((status = psa_import_key(&attributes,
8619 mac_dec, mac_key_len,
8620 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008621 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008623 goto end;
8624 }
8625#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, 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 }
8630 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8631 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008632 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008634#endif /* MBEDTLS_USE_PSA_CRYPTO */
8635 }
8636#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8637
8638 ((void) mac_dec);
8639 ((void) mac_enc);
8640
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008641end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8643 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008644}
8645
Valerio Settia08b1a42022-11-17 15:10:02 +01008646#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8647 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008648int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 psa_pake_operation_t *pake_ctx,
8650 const unsigned char *buf,
8651 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008652{
8653 psa_status_t status;
8654 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008655 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008656 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8657 * At round two perform a single cycle
8658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 for (; remaining_steps > 0; remaining_steps--) {
8662 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008663 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008665 /* Length is stored at the first byte */
8666 size_t length = buf[input_offset];
8667 input_offset += 1;
8668
Gilles Peskine449bd832023-01-11 14:50:10 +01008669 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008670 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8671 }
8672
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 status = psa_pake_input(pake_ctx, step,
8674 buf + input_offset, length);
8675 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008676 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008677 }
8678
8679 input_offset += length;
8680 }
8681 }
8682
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008684 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008688}
8689
Valerio Setti6b3dab02022-11-17 17:14:54 +01008690int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008691 psa_pake_operation_t *pake_ctx,
8692 unsigned char *buf,
8693 size_t len, size_t *olen,
8694 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008695{
8696 psa_status_t status;
8697 size_t output_offset = 0;
8698 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008699 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008700 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8701 * At round two perform a single cycle
8702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008704
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 for (; remaining_steps > 0; remaining_steps--) {
8706 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8707 step <= PSA_PAKE_STEP_ZK_PROOF;
8708 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008709 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008710 * For each step, prepend 1 byte with the length of the data as
8711 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 status = psa_pake_output(pake_ctx, step,
8714 buf + output_offset + 1,
8715 len - output_offset - 1,
8716 &output_len);
8717 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008718 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008719 }
8720
Valerio Setti99d88c12022-11-22 16:03:43 +01008721 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008722
8723 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008724 }
8725 }
8726
8727 *olen = output_offset;
8728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008730}
Valerio Settia08b1a42022-11-17 15:10:02 +01008731#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8732
Jerry Yuee40f9d2022-02-17 14:55:16 +08008733#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008734int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8735 unsigned char *hash, size_t *hashlen,
8736 unsigned char *data, size_t data_len,
8737 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738{
8739 psa_status_t status;
8740 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008741 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008742
Gilles Peskine449bd832023-01-11 14:50:10 +01008743 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008744
Gilles Peskine449bd832023-01-11 14:50:10 +01008745 if ((status = psa_hash_setup(&hash_operation,
8746 hash_alg)) != PSA_SUCCESS) {
8747 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008748 goto exit;
8749 }
8750
Gilles Peskine449bd832023-01-11 14:50:10 +01008751 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8752 64)) != PSA_SUCCESS) {
8753 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008754 goto exit;
8755 }
8756
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 if ((status = psa_hash_update(&hash_operation,
8758 data, data_len)) != PSA_SUCCESS) {
8759 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760 goto exit;
8761 }
8762
Gilles Peskine449bd832023-01-11 14:50:10 +01008763 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8764 hashlen)) != PSA_SUCCESS) {
8765 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8766 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008767 }
8768
8769exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 if (status != PSA_SUCCESS) {
8771 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8772 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8773 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008774 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8777 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008778 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008783 }
8784 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786}
8787
8788#else
8789
Gilles Peskine449bd832023-01-11 14:50:10 +01008790int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8791 unsigned char *hash, size_t *hashlen,
8792 unsigned char *data, size_t data_len,
8793 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008794{
8795 int ret = 0;
8796 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8798 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008801
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803
8804 /*
8805 * digitally-signed struct {
8806 * opaque client_random[32];
8807 * opaque server_random[32];
8808 * ServerDHParams params;
8809 * };
8810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008811 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8812 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813 goto exit;
8814 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8816 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", 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, ssl->handshake->randbytes, 64)) != 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_update(&ctx, data, data_len)) != 0) {
8824 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008825 goto exit;
8826 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008827 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8828 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008829 goto exit;
8830 }
8831
8832exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if (ret != 0) {
8836 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8837 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8838 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008839
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008841}
8842#endif /* MBEDTLS_USE_PSA_CRYPTO */
8843
Jerry Yud9d91da2022-02-17 14:57:06 +08008844#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8845
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008846/* Find the preferred hash for a given signature algorithm. */
8847unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 mbedtls_ssl_context *ssl,
8849 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008850{
Gabor Mezei078e8032022-04-27 21:17:56 +02008851 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008852 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008853
Gilles Peskine449bd832023-01-11 14:50:10 +01008854 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8855 return MBEDTLS_SSL_HASH_NONE;
8856 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008857
Gilles Peskine449bd832023-01-11 14:50:10 +01008858 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008859 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8861 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008862 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8864 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008865
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008866 mbedtls_md_type_t md_alg =
8867 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8868 if (md_alg == MBEDTLS_MD_NONE) {
8869 continue;
8870 }
8871
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008873#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008875 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008876 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008877
Gilles Peskine449bd832023-01-11 14:50:10 +01008878 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8879 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8880 PSA_ALG_ECDSA(psa_hash_alg),
8881 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008882 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008884
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8886 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8887 PSA_ALG_RSA_PKCS1V15_SIGN(
8888 psa_hash_alg),
8889 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008890 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008892 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008893#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008894
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008896 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008897 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008898
Gilles Peskine449bd832023-01-11 14:50:10 +01008899 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008900}
8901
8902#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8903
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904/* Serialization of TLS 1.2 sessions:
8905 *
8906 * struct {
8907 * uint64 start_time;
8908 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008909 * uint8 session_id_len; // at most 32
8910 * opaque session_id[32];
8911 * opaque master[48]; // fixed length in the standard
8912 * uint32 verify_result;
8913 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8914 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8915 * uint32 ticket_lifetime;
8916 * uint8 mfl_code; // up to 255 according to standard
8917 * uint8 encrypt_then_mac; // 0 or 1
8918 * } serialized_session_tls12;
8919 *
8920 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008921static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8922 unsigned char *buf,
8923 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008924{
8925 unsigned char *p = buf;
8926 size_t used = 0;
8927
8928#if defined(MBEDTLS_HAVE_TIME)
8929 uint64_t start;
8930#endif
8931#if defined(MBEDTLS_X509_CRT_PARSE_C)
8932#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8933 size_t cert_len;
8934#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8935#endif /* MBEDTLS_X509_CRT_PARSE_C */
8936
8937 /*
8938 * Time
8939 */
8940#if defined(MBEDTLS_HAVE_TIME)
8941 used += 8;
8942
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008944 start = (uint64_t) session->start;
8945
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008947 p += 8;
8948 }
8949#endif /* MBEDTLS_HAVE_TIME */
8950
8951 /*
8952 * Basic mandatory fields
8953 */
8954 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008955 + 1 /* id_len */
8956 + sizeof(session->id)
8957 + sizeof(session->master)
8958 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008959
Gilles Peskine449bd832023-01-11 14:50:10 +01008960 if (used <= buf_len) {
8961 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962 p += 2;
8963
Gilles Peskine449bd832023-01-11 14:50:10 +01008964 *p++ = MBEDTLS_BYTE_0(session->id_len);
8965 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966 p += 32;
8967
Gilles Peskine449bd832023-01-11 14:50:10 +01008968 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969 p += 48;
8970
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008972 p += 4;
8973 }
8974
8975 /*
8976 * Peer's end-entity certificate
8977 */
8978#if defined(MBEDTLS_X509_CRT_PARSE_C)
8979#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008981 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008983 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985
8986 used += 3 + cert_len;
8987
Gilles Peskine449bd832023-01-11 14:50:10 +01008988 if (used <= buf_len) {
8989 *p++ = MBEDTLS_BYTE_2(cert_len);
8990 *p++ = MBEDTLS_BYTE_1(cert_len);
8991 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008992
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 if (session->peer_cert != NULL) {
8994 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008995 p += cert_len;
8996 }
8997 }
8998#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009000 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002 *p++ = (unsigned char) session->peer_cert_digest_type;
9003 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009004 memcpy(p, session->peer_cert_digest,
9005 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009006 p += session->peer_cert_digest_len;
9007 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009010 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009011 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9012 *p++ = 0;
9013 }
9014 }
9015#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9016#endif /* MBEDTLS_X509_CRT_PARSE_C */
9017
9018 /*
9019 * Session ticket if any, plus associated data
9020 */
9021#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9022 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9023
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (used <= buf_len) {
9025 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9026 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9027 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009028
Gilles Peskine449bd832023-01-11 14:50:10 +01009029 if (session->ticket != NULL) {
9030 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031 p += session->ticket_len;
9032 }
9033
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009035 p += 4;
9036 }
9037#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9038
9039 /*
9040 * Misc extension-related info
9041 */
9042#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9043 used += 1;
9044
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009046 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048#endif
9049
9050#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9051 used += 1;
9052
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 if (used <= buf_len) {
9054 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9055 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009056#endif
9057
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059}
9060
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009062static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9063 const unsigned char *buf,
9064 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065{
9066#if defined(MBEDTLS_HAVE_TIME)
9067 uint64_t start;
9068#endif
9069#if defined(MBEDTLS_X509_CRT_PARSE_C)
9070#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9071 size_t cert_len;
9072#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9073#endif /* MBEDTLS_X509_CRT_PARSE_C */
9074
9075 const unsigned char *p = buf;
9076 const unsigned char * const end = buf + len;
9077
9078 /*
9079 * Time
9080 */
9081#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 if (8 > (size_t) (end - p)) {
9083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9084 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009086 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009087 p += 8;
9088
9089 session->start = (time_t) start;
9090#endif /* MBEDTLS_HAVE_TIME */
9091
9092 /*
9093 * Basic mandatory fields
9094 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9097 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009098
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009099 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009100 p += 2;
9101
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009104 p += 32;
9105
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009107 p += 48;
9108
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009109 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009110 p += 4;
9111
9112 /* Immediately clear invalid pointer values that have been read, in case
9113 * we exit early before we replaced them with valid ones. */
9114#if defined(MBEDTLS_X509_CRT_PARSE_C)
9115#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9116 session->peer_cert = NULL;
9117#else
9118 session->peer_cert_digest = NULL;
9119#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9120#endif /* MBEDTLS_X509_CRT_PARSE_C */
9121#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9122 session->ticket = NULL;
9123#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9124
9125 /*
9126 * Peer certificate
9127 */
9128#if defined(MBEDTLS_X509_CRT_PARSE_C)
9129#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9130 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009131 if (3 > (size_t) (end - p)) {
9132 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9133 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009135 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136 p += 3;
9137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9140
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if (cert_len > (size_t) (end - p)) {
9142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9143 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 if (session->peer_cert == NULL) {
9148 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9149 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009150
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009152
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9154 p, cert_len)) != 0) {
9155 mbedtls_x509_crt_free(session->peer_cert);
9156 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009157 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009158 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009159 }
9160
9161 p += cert_len;
9162 }
9163#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9164 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 if (2 > (size_t) (end - p)) {
9166 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9167 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168
9169 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9170 session->peer_cert_digest_len = (size_t) *p++;
9171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009173 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9175 if (md_info == NULL) {
9176 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9177 }
9178 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9180 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009181
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9183 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9184 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185
9186 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 mbedtls_calloc(1, session->peer_cert_digest_len);
9188 if (session->peer_cert_digest == NULL) {
9189 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9190 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 memcpy(session->peer_cert_digest, p,
9193 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009194 p += session->peer_cert_digest_len;
9195 }
9196#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9197#endif /* MBEDTLS_X509_CRT_PARSE_C */
9198
9199 /*
9200 * Session ticket and associated data
9201 */
9202#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009203 if (3 > (size_t) (end - p)) {
9204 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9205 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009207 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009208 p += 3;
9209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (session->ticket_len != 0) {
9211 if (session->ticket_len > (size_t) (end - p)) {
9212 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9213 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009214
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 session->ticket = mbedtls_calloc(1, session->ticket_len);
9216 if (session->ticket == NULL) {
9217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9218 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009219
Gilles Peskine449bd832023-01-11 14:50:10 +01009220 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009221 p += session->ticket_len;
9222 }
9223
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 if (4 > (size_t) (end - p)) {
9225 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9226 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009227
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009228 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009229 p += 4;
9230#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9231
9232 /*
9233 * Misc extension-related info
9234 */
9235#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009236 if (1 > (size_t) (end - p)) {
9237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9238 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009239
9240 session->mfl_code = *p++;
9241#endif
9242
9243#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009244 if (1 > (size_t) (end - p)) {
9245 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9246 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009247
9248 session->encrypt_then_mac = *p++;
9249#endif
9250
9251 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 if (p != end) {
9253 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9254 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009257}
Jerry Yudc7bd172022-02-17 13:44:15 +08009258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9259
XiaokangQian75d40ef2022-04-20 11:05:24 +00009260int mbedtls_ssl_validate_ciphersuite(
9261 const mbedtls_ssl_context *ssl,
9262 const mbedtls_ssl_ciphersuite_t *suite_info,
9263 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009265{
9266 (void) ssl;
9267
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 if (suite_info == NULL) {
9269 return -1;
9270 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009271
Gilles Peskine449bd832023-01-11 14:50:10 +01009272 if ((suite_info->min_tls_version > max_tls_version) ||
9273 (suite_info->max_tls_version < min_tls_version)) {
9274 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009275 }
9276
XiaokangQian060d8672022-04-21 09:24:56 +00009277#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009278#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009279#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009280 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9281 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009282#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009283 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9284 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009285#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009286 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009287 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009288 }
9289#endif
9290
9291 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9292#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009293 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9294 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9295 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009296 }
9297#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9298#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9299
Gilles Peskine449bd832023-01-11 14:50:10 +01009300 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009301}
9302
Ronald Crone68ab4f2022-10-05 12:46:29 +02009303#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009304/*
9305 * Function for writing a signature algorithm extension.
9306 *
9307 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9308 * value (TLS 1.3 RFC8446):
9309 * enum {
9310 * ....
9311 * ecdsa_secp256r1_sha256( 0x0403 ),
9312 * ecdsa_secp384r1_sha384( 0x0503 ),
9313 * ecdsa_secp521r1_sha512( 0x0603 ),
9314 * ....
9315 * } SignatureScheme;
9316 *
9317 * struct {
9318 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9319 * } SignatureSchemeList;
9320 *
9321 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9322 * value (TLS 1.2 RFC5246):
9323 * enum {
9324 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9325 * sha512(6), (255)
9326 * } HashAlgorithm;
9327 *
9328 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9329 * SignatureAlgorithm;
9330 *
9331 * struct {
9332 * HashAlgorithm hash;
9333 * SignatureAlgorithm signature;
9334 * } SignatureAndHashAlgorithm;
9335 *
9336 * SignatureAndHashAlgorithm
9337 * supported_signature_algorithms<2..2^16-2>;
9338 *
9339 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9340 * generalization of the TLS 1.2 signature algorithm extension.
9341 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9342 * `SignatureScheme` field of TLS 1.3
9343 *
9344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009345int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9346 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009347{
9348 unsigned char *p = buf;
9349 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9350 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9351
9352 *out_len = 0;
9353
Gilles Peskine449bd832023-01-11 14:50:10 +01009354 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009355
9356 /* Check if we have space for header and length field:
9357 * - extension_type (2 bytes)
9358 * - extension_data_length (2 bytes)
9359 * - supported_signature_algorithms_length (2 bytes)
9360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009361 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009362 p += 6;
9363
9364 /*
9365 * Write supported_signature_algorithms
9366 */
9367 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9369 if (sig_alg == NULL) {
9370 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9371 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009372
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9374 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9375 *sig_alg,
9376 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9377 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009378 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 }
9380 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9381 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009382 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009383 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9384 *sig_alg,
9385 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009386 }
9387
9388 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009389 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 if (supported_sig_alg_len == 0) {
9391 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9392 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009393 }
9394
Gilles Peskine449bd832023-01-11 14:50:10 +01009395 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9396 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9397 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009398
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009399 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009400
9401#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009403#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009404
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009406}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009407#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009408
XiaokangQian40a35232022-05-07 09:02:40 +00009409#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009410/*
9411 * mbedtls_ssl_parse_server_name_ext
9412 *
9413 * Structure of server_name extension:
9414 *
9415 * enum {
9416 * host_name(0), (255)
9417 * } NameType;
9418 * opaque HostName<1..2^16-1>;
9419 *
9420 * struct {
9421 * NameType name_type;
9422 * select (name_type) {
9423 * case host_name: HostName;
9424 * } name;
9425 * } ServerName;
9426 * struct {
9427 * ServerName server_name_list<1..2^16-1>
9428 * } ServerNameList;
9429 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009430MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009431int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9432 const unsigned char *buf,
9433 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009434{
9435 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9436 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009437 size_t server_name_list_len, hostname_len;
9438 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009439
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009441
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9443 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009444 p += 2;
9445
Gilles Peskine449bd832023-01-11 14:50:10 +01009446 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009447 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 while (p < server_name_list_end) {
9449 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9450 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9451 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9452 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009453
Gilles Peskine449bd832023-01-11 14:50:10 +01009454 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009455 /* sni_name is intended to be used only during the parsing of the
9456 * ClientHello message (it is reset to NULL before the end of
9457 * the message parsing). Thus it is ok to just point to the
9458 * reception buffer and not make a copy of it.
9459 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009460 ssl->handshake->sni_name = p + 3;
9461 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009462 if (ssl->conf->f_sni == NULL) {
9463 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009464 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9466 ssl, p + 3, hostname_len);
9467 if (ret != 0) {
9468 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9469 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9470 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9471 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9472 }
9473 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009474 }
9475
9476 p += hostname_len + 3;
9477 }
9478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009480}
9481#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9482
XiaokangQianacb39922022-06-17 10:18:48 +00009483#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009484MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009485int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9486 const unsigned char *buf,
9487 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009488{
9489 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009490 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009491 const unsigned char *protocol_name_list;
9492 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009493 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009494
9495 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009496 if (ssl->conf->alpn_list == NULL) {
9497 return 0;
9498 }
XiaokangQianacb39922022-06-17 10:18:48 +00009499
9500 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009501 * RFC7301, section 3.1
9502 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009503 *
XiaokangQianc7403452022-06-23 03:24:12 +00009504 * struct {
9505 * ProtocolName protocol_name_list<2..2^16-1>
9506 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009507 */
9508
XiaokangQianc7403452022-06-23 03:24:12 +00009509 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009510 * protocol_name_list_len 2 bytes
9511 * protocol_name_len 1 bytes
9512 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009517 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009519 protocol_name_list = p;
9520 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009521
9522 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009524 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9526 protocol_name_len);
9527 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009528 MBEDTLS_SSL_PEND_FATAL_ALERT(
9529 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9531 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009532 }
9533
9534 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009535 }
9536
9537 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009538 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9539 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009540 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009542 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009543 if (protocol_name_len == alpn_len &&
9544 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009545 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009547 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009548
9549 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009550 }
9551 }
9552
XiaokangQian95d5f542022-06-24 02:29:26 +00009553 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009554 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9556 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9557 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009558}
9559
Gilles Peskine449bd832023-01-11 14:50:10 +01009560int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9561 unsigned char *buf,
9562 unsigned char *end,
9563 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009564{
9565 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009566 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009567 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009568
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 if (ssl->alpn_chosen == NULL) {
9570 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009571 }
9572
Gilles Peskine449bd832023-01-11 14:50:10 +01009573 protocol_name_len = strlen(ssl->alpn_chosen);
9574 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009575
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009577 /*
9578 * 0 . 1 ext identifier
9579 * 2 . 3 ext length
9580 * 4 . 5 protocol list length
9581 * 6 . 6 protocol name length
9582 * 7 . 7+n protocol name
9583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009584 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009585
XiaokangQian95d5f542022-06-24 02:29:26 +00009586 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009587
Gilles Peskine449bd832023-01-11 14:50:10 +01009588 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9589 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009590 /* Note: the length of the chosen protocol has been checked to be less
9591 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009594
Gilles Peskine449bd832023-01-11 14:50:10 +01009595 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009596
9597#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009598 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009599#endif
9600
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009602}
9603#endif /* MBEDTLS_SSL_ALPN */
9604
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009605#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009606 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009607 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009608 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009609int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9610 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009611{
9612 /* Initialize to suppress unnecessary compiler warning */
9613 size_t hostname_len = 0;
9614
9615 /* Check if new hostname is valid before
9616 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 if (hostname != NULL) {
9618 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009619
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9622 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009623 }
9624
9625 /* Now it's clear that we will overwrite the old hostname,
9626 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009627 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009628 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009629 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009630 }
9631
9632 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009633 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009634 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 } else {
9636 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9637 if (session->hostname == NULL) {
9638 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9639 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009640
Gilles Peskine449bd832023-01-11 14:50:10 +01009641 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009642 }
9643
Gilles Peskine449bd832023-01-11 14:50:10 +01009644 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009645}
Xiaokang Qian03409292022-10-12 02:49:52 +00009646#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9647 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009648 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009649 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009651#endif /* MBEDTLS_SSL_TLS_C */