blob: 1a3fd71068ead96a64214929bb15588683f8c742 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500309 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Jerry Yu60835a82021-08-04 10:13:52 +08001358 /* Space for further checks */
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001361}
1362
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001363/*
1364 * Setup an SSL context
1365 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1368 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001369{
Janos Follath865b3eb2019-12-16 11:46:15 +00001370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001371 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1372 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001374 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if ((ret = ssl_conf_check(ssl)) != 0) {
1377 return ret;
1378 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001379 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001380
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001382 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001383 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001384
1385 /* Set to NULL in case of an error condition */
1386 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001387
Darryl Greenb33cc762019-11-28 14:29:44 +00001388#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1389 ssl->in_buf_len = in_buf_len;
1390#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1392 if (ssl->in_buf == NULL) {
1393 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001394 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001395 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001396 }
1397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->out_buf_len = out_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1402 if (ssl->out_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001409
Johan Pascalb62bb512015-12-03 21:56:45 +01001410#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001412#endif
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419
1420error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_free(ssl->in_buf);
1422 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424 ssl->conf = NULL;
1425
Darryl Greenb33cc762019-11-28 14:29:44 +00001426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1427 ssl->in_buf_len = 0;
1428 ssl->out_buf_len = 0;
1429#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001430 ssl->in_buf = NULL;
1431 ssl->out_buf = NULL;
1432
1433 ssl->in_hdr = NULL;
1434 ssl->in_ctr = NULL;
1435 ssl->in_len = NULL;
1436 ssl->in_iv = NULL;
1437 ssl->in_msg = NULL;
1438
1439 ssl->out_hdr = NULL;
1440 ssl->out_ctr = NULL;
1441 ssl->out_len = NULL;
1442 ssl->out_iv = NULL;
1443 ssl->out_msg = NULL;
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
1448/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001449 * Reset an initialized and used SSL context for re-use while retaining
1450 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001451 *
1452 * If partial is non-zero, keep data in the input buffer and client ID.
1453 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1456 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457{
Darryl Greenb33cc762019-11-28 14:29:44 +00001458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1459 size_t in_buf_len = ssl->in_buf_len;
1460 size_t out_buf_len = ssl->out_buf_len;
1461#else
1462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1463 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1464#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001465
Hanno Beckerb0302c42021-08-03 09:39:42 +01001466#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1467 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001468#endif
1469
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001470 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474
1475 /* Reset incoming message parsing */
1476 ssl->in_offt = NULL;
1477 ssl->nb_zero = 0;
1478 ssl->in_msgtype = 0;
1479 ssl->in_msglen = 0;
1480 ssl->in_hslen = 0;
1481 ssl->keep_current_message = 0;
1482 ssl->transform_in = NULL;
1483
1484#if defined(MBEDTLS_SSL_PROTO_DTLS)
1485 ssl->next_record_offset = 0;
1486 ssl->in_epoch = 0;
1487#endif
1488
1489 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001491 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493 }
1494
Ronald Cronad8c17b2022-06-10 17:18:09 +02001495 ssl->send_alert = 0;
1496
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 /* Reset outgoing message writing */
1498 ssl->out_msgtype = 0;
1499 ssl->out_msglen = 0;
1500 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 memset(ssl->out_buf, 0, out_buf_len);
1502 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->transform_out = NULL;
1504
1505#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507#endif
1508
XiaokangQian2b01dc32022-01-21 02:53:13 +00001509#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (ssl->transform) {
1511 mbedtls_ssl_transform_free(ssl->transform);
1512 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform = NULL;
1514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1516
XiaokangQian2b01dc32022-01-21 02:53:13 +00001517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_transform_free(ssl->transform_application);
1519 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 ssl->transform_application = NULL;
1521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001523#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1525 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1530 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_handshake = NULL;
1532 }
1533
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538{
1539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1540
1541 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
1545 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_RENEGOTIATION)
1547 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001549
1550 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1552 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001557 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session) {
1559 mbedtls_ssl_session_free(ssl->session);
1560 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001561 ssl->session = NULL;
1562 }
1563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001565 ssl->alpn_chosen = NULL;
1566#endif
1567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001569 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (free_cli_id) {
1574 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001575 ssl->cli_id = NULL;
1576 ssl->cli_id_len = 0;
1577 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001578#endif
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if ((ret = ssl_handshake_init(ssl)) != 0) {
1581 return ret;
1582 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001585}
1586
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001587/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 * Reset an initialized and used SSL context for re-use while retaining
1589 * all application-set variables, function pointers and data.
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592{
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594}
1595
1596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 * SSL set accessors
1598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001601 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001602}
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607}
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613}
1614#endif
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1624 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001625{
1626 ssl->disable_datagram_packing = !allow_packing;
1627}
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1630 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->hs_timeout_min = min;
1633 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1644 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1645 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001647 conf->f_vrfy = f_vrfy;
1648 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1653 int (*f_rng)(void *, unsigned char *, size_t),
1654 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001656 conf->f_rng = f_rng;
1657 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1661 void (*f_dbg)(void *, int, const char *, int, const char *),
1662 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_dbg = f_dbg;
1665 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001666}
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1669 void *p_bio,
1670 mbedtls_ssl_send_t *f_send,
1671 mbedtls_ssl_recv_t *f_recv,
1672 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001673{
1674 ssl->p_bio = p_bio;
1675 ssl->f_send = f_send;
1676 ssl->f_recv = f_recv;
1677 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001678}
1679
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682{
1683 ssl->mtu = mtu;
1684}
1685#endif
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688{
1689 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690}
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1693 void *p_timer,
1694 mbedtls_ssl_set_timer_t *f_set_timer,
1695 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696{
1697 ssl->p_timer = p_timer;
1698 ssl->f_set_timer = f_set_timer;
1699 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001700
1701 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703}
1704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001706void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1707 void *p_cache,
1708 mbedtls_ssl_cache_get_t *f_get_cache,
1709 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001710{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001711 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723 session == NULL ||
1724 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (ssl->handshake->resume == 1) {
1730 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1731 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001732
Jerry Yu21092062022-10-10 21:21:31 +08001733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001735 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001739 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1741 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1742 session->ciphersuite));
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001744 }
Jerry Yu40afab62022-10-08 10:42:13 +08001745 }
Jerry Yu21092062022-10-10 21:21:31 +08001746#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1749 session)) != 0) {
1750 return ret;
1751 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001752
Paul Bakker0a597072012-09-25 21:55:46 +00001753 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1760 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001761{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001762 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001763}
1764
Ronald Cron6f135e12021-12-08 16:57:54 +01001765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1767 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001768{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001769 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001771
1772#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001773void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1774 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001775{
1776 conf->early_data_enabled = early_data_enabled;
1777}
Jerry Yucc4e0072022-11-22 17:22:22 +08001778
1779#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001780void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001782{
Jerry Yu39da9852022-12-06 16:58:36 +08001783 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001784}
1785#endif /* MBEDTLS_SSL_SRV_C */
1786
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1792 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001793{
1794 conf->cert_profile = profile;
1795}
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001798{
1799 mbedtls_ssl_key_cert *cur = key_cert, *next;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001802 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 cur = next;
1805 }
1806}
1807
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001808/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1811 mbedtls_x509_crt *cert,
1812 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001813{
niisato8ee24222018-06-25 19:05:48 +09001814 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1824 if (new_cert == NULL) {
1825 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1826 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
niisato8ee24222018-06-25 19:05:48 +09001828 new_cert->cert = cert;
1829 new_cert->key = key;
1830 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001834 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001836 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 }
niisato8ee24222018-06-25 19:05:48 +09001840 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844}
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849{
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851}
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001854 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001856{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 conf->ca_chain = ca_chain;
1858 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001859
1860#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1861 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1862 * cannot be used together. */
1863 conf->f_ca_cb = NULL;
1864 conf->p_ca_cb = NULL;
1865#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
Hanno Becker5adaad92019-03-27 16:54:37 +00001867
1868#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1871 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001872{
1873 conf->f_ca_cb = f_ca_cb;
1874 conf->p_ca_cb = p_ca_cb;
1875
1876 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1877 * cannot be used together. */
1878 conf->ca_chain = NULL;
1879 conf->ca_crl = NULL;
1880}
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001883
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001884#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1886 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001887{
1888 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001890}
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1893 mbedtls_x509_crt *own_cert,
1894 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895{
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1897 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1901 mbedtls_x509_crt *ca_chain,
1902 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001903{
1904 ssl->handshake->sni_ca_chain = ca_chain;
1905 ssl->handshake->sni_ca_crl = ca_crl;
1906}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001907
Glenn Strauss999ef702022-03-11 01:37:23 -05001908#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1910 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001911{
1912 ssl->handshake->dn_hints = crt;
1913}
1914#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1917 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918{
1919 ssl->handshake->sni_authmode = authmode;
1920}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1922
Hanno Becker8927c832019-04-03 12:52:50 +01001923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001924void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1926 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001927{
1928 ssl->f_vrfy = f_vrfy;
1929 ssl->p_vrfy = p_vrfy;
1930}
1931#endif
1932
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Valerio Setti016f6822022-12-09 14:17:50 +01001935#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001936static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1937static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1938
Valerio Setti016f6822022-12-09 14:17:50 +01001939static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 mbedtls_ssl_context *ssl,
1941 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001942{
1943 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001944 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001945 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001946 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1950 psa_pake_cs_set_primitive(&cipher_suite,
1951 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1952 PSA_ECC_FAMILY_SECP_R1,
1953 256));
1954 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1957 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001962 user = jpake_server_id;
1963 user_len = sizeof(jpake_server_id);
1964 peer = jpake_client_id;
1965 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_client_id;
1968 user_len = sizeof(jpake_client_id);
1969 peer = jpake_server_id;
1970 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001972
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1974 if (status != PSA_SUCCESS) {
1975 return status;
1976 }
1977
1978 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001980 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
1988 ssl->handshake->psa_pake_ctx_is_ok = 1;
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1994 const unsigned char *pw,
1995 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001996{
1997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1998 psa_status_t status;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (ssl->handshake == NULL || ssl->conf == NULL) {
2001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 /* Empty password is not valid */
2005 if ((pw == NULL) || (pw_len == 0)) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2007 }
2008
2009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2010 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2011 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2012
2013 status = psa_import_key(&attributes, pw, pw_len,
2014 &ssl->handshake->psa_pake_password);
2015 if (status != PSA_SUCCESS) {
2016 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2017 }
2018
2019 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2020 ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 psa_destroy_key(ssl->handshake->psa_pake_password);
2023 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2024 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2025 }
2026
2027 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002028}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2031 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033 psa_status_t status;
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (ssl->handshake == NULL || ssl->conf == NULL) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (mbedtls_svc_key_id_is_null(pwd)) {
2040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2041 }
2042
2043 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2044 if (status != PSA_SUCCESS) {
2045 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2046 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2047 }
2048
2049 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002050}
2051#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2053 const unsigned char *pw,
2054 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002055{
2056 mbedtls_ecjpake_role role;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ssl->handshake == NULL || ssl->conf == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061
Valerio Settic689ed82022-12-07 14:40:38 +01002062 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if ((pw == NULL) || (pw_len == 0)) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Valerio Settic689ed82022-12-07 14:40:38 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2074 role,
2075 MBEDTLS_MD_SHA256,
2076 MBEDTLS_ECP_DP_SECP256R1,
2077 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078}
Valerio Setti02c25b52022-11-15 14:08:42 +01002079#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002080#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002084{
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (conf->psk_identity == NULL ||
2086 conf->psk_identity_len == 0) {
2087 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002088 }
2089
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2092 return 1;
2093 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk != NULL && conf->psk_len != 0) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
2105 /* Remove reference to existing PSK, if any. */
2106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108 /* The maintenance of the PSK key slot is the
2109 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002114 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115 conf->psk = NULL;
2116 conf->psk_len = 0;
2117 }
2118
2119 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (conf->psk_identity != NULL) {
2121 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk_identity = NULL;
2123 conf->psk_identity_len = 0;
2124 }
2125}
2126
Hanno Becker7390c712018-11-15 13:33:04 +00002127/* This function assumes that PSK identity in the SSL config is unset.
2128 * It checks that the provided identity is well-formed and attempts
2129 * to make a copy of it in the SSL config.
2130 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002132static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2133 unsigned char const *psk_identity,
2134 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002135{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002136 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002138 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 (psk_identity_len >> 16) != 0 ||
2140 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2145 if (conf->psk_identity == NULL) {
2146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2147 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002148
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002149 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002153}
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2156 const unsigned char *psk, size_t psk_len,
2157 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002160
2161 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2163 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2164 }
Hanno Becker7390c712018-11-15 13:33:04 +00002165
2166 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (psk == NULL) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2169 }
2170 if (psk_len == 0) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2178 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002182
2183 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2185 if (ret != 0) {
2186 ssl_conf_remove_psk(conf);
2187 }
Hanno Becker7390c712018-11-15 13:33:04 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002193{
2194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002196 /* The maintenance of the external PSK key slot is the
2197 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->psk_opaque_is_internal) {
2199 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002200 ssl->handshake->psk_opaque_is_internal = 0;
2201 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002202 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203 }
Neil Armstronge952a302022-05-03 10:22:14 +02002204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002206 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 ssl->handshake->psk_len = 0;
2209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211}
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2214 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002215{
Neil Armstrong501c9322022-05-03 09:35:09 +02002216#if defined(MBEDTLS_USE_PSA_CRYPTO)
2217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002219 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (psk == NULL || ssl->handshake == NULL) {
2224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2225 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2229 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2236 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2237 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2238 } else {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2240 }
2241 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002242 }
2243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002244
Jerry Yu568ec252022-07-22 21:27:34 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2247 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2248 psa_set_key_usage_flags(&key_attributes,
2249 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 psa_set_key_algorithm(&key_attributes, alg);
2254 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2257 if (status != PSA_SUCCESS) {
2258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2259 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
2261 /* Allow calling psa_destroy_key() on psk remove */
2262 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002264#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
2269 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274}
2275
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002276#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002277int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2278 mbedtls_svc_key_id_t psk,
2279 const unsigned char *psk_identity,
2280 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281{
Janos Follath865b3eb2019-12-16 11:46:15 +00002282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002283
2284 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2287 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288
Hanno Becker7390c712018-11-15 13:33:04 +00002289 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_svc_key_id_is_null(psk)) {
2291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2292 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002293 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002294
2295 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2297 psk_identity_len);
2298 if (ret != 0) {
2299 ssl_conf_remove_psk(conf);
2300 }
Hanno Becker7390c712018-11-15 13:33:04 +00002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2306 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002307{
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((mbedtls_svc_key_id_is_null(psk)) ||
2309 (ssl->handshake == NULL)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316}
2317#endif /* MBEDTLS_USE_PSA_CRYPTO */
2318
Jerry Yu8897c072022-08-12 13:56:53 +08002319#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2321 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2322 size_t),
2323 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324{
2325 conf->f_psk = f_psk;
2326 conf->p_psk = p_psk;
2327}
Jerry Yu8897c072022-08-12 13:56:53 +08002328#endif /* MBEDTLS_SSL_SRV_C */
2329
Ronald Cron73fe8df2022-10-05 14:31:43 +02002330#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
2332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002333static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (alg == PSA_ALG_CBC_NO_PADDING) {
2338 return MBEDTLS_SSL_MODE_CBC;
2339 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (PSA_ALG_IS_AEAD(alg)) {
2342 return MBEDTLS_SSL_MODE_AEAD;
2343 }
2344 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002345}
2346
2347#else /* MBEDTLS_USE_PSA_CRYPTO */
2348
2349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002351{
2352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (mode == MBEDTLS_MODE_CBC) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2357
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358#if defined(MBEDTLS_GCM_C) || \
2359 defined(MBEDTLS_CCM_C) || \
2360 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mode == MBEDTLS_MODE_CHACHAPOLY) {
2364 return MBEDTLS_SSL_MODE_AEAD;
2365 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369}
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371
Gilles Peskinee108d982022-04-26 16:50:40 +02002372static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2373 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002375{
2376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2378 base_mode == MBEDTLS_SSL_MODE_CBC) {
2379 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002380 }
2381#else
2382 (void) encrypt_then_mac;
2383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385}
2386
Neil Armstrongab555e02022-04-04 11:07:59 +02002387mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002389{
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002395#endif
2396 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 encrypt_then_mac = transform->encrypt_then_mac;
2401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403}
2404
Neil Armstrongab555e02022-04-04 11:07:59 +02002405mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410{
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2412
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413#if defined(MBEDTLS_USE_PSA_CRYPTO)
2414 psa_status_t status;
2415 psa_algorithm_t alg;
2416 psa_key_type_t type;
2417 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002418 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2419 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (status == PSA_SUCCESS) {
2421 base_mode = mbedtls_ssl_get_base_mode(alg);
2422 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#else
2424 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002425 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 base_mode =
2428 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#endif /* MBEDTLS_USE_PSA_CRYPTO */
2432
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2434 int encrypt_then_mac = 0;
2435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437}
2438
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002439#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002440
2441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002442/* Serialization of TLS 1.3 sessions:
2443 *
2444 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002445 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002446 * uint64 ticket_received;
2447 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002448 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * } ClientOnlyData;
2450 *
2451 * struct {
2452 * uint8 endpoint;
2453 * uint8 ciphersuite[2];
2454 * uint32 ticket_age_add;
2455 * uint8 ticket_flags;
2456 * opaque resumption_key<0..255>;
2457 * select ( endpoint ) {
2458 * case client: ClientOnlyData;
2459 * case server: uint64 start_time;
2460 * };
2461 * } serialized_session_tls13;
2462 *
2463 */
2464#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002465MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002466static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2467 unsigned char *buf,
2468 size_t buf_len,
2469 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002470{
2471 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002472#if defined(MBEDTLS_SSL_CLI_C) && \
2473 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 size_t hostname_len = (session->hostname == NULL) ?
2475 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002476#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002477 size_t needed = 1 /* endpoint */
2478 + 2 /* ciphersuite */
2479 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002480 + 1 /* ticket_flags */
2481 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002482 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2486 }
Jerry Yu34191072022-08-18 10:32:09 +08002487 needed += session->resumption_key_len; /* resumption_key */
2488
Jerry Yu438ddd82022-07-07 06:55:50 +00002489#if defined(MBEDTLS_HAVE_TIME)
2490 needed += 8; /* start_time or ticket_received */
2491#endif
2492
2493#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002495#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002496 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002498#endif
2499
Jerry Yu438ddd82022-07-07 06:55:50 +00002500 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002501 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002502
2503 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (session->ticket_len > SIZE_MAX - needed) {
2505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2506 }
Jerry Yu34191072022-08-18 10:32:09 +08002507
Jerry Yue28d9742022-08-18 15:44:03 +08002508 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002509 }
2510#endif /* MBEDTLS_SSL_CLI_C */
2511
Jerry Yue36fdd62022-08-17 21:31:36 +08002512 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (needed > buf_len) {
2514 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2515 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002516
2517 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2519 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002520 p[7] = session->ticket_flags;
2521
2522 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002523 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002524 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002526 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002527
2528#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2530 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 p += 8;
2532 }
2533#endif /* MBEDTLS_HAVE_TIME */
2534
2535#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002537#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002539 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002541 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002543 p += hostname_len;
2544 }
2545#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2546
Jerry Yu438ddd82022-07-07 06:55:50 +00002547#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002549 p += 8;
2550#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002552 p += 4;
2553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002555 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 if (session->ticket != NULL && session->ticket_len > 0) {
2558 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += session->ticket_len;
2560 }
2561 }
2562#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002564}
2565
2566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002567static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2568 const unsigned char *buf,
2569 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002570{
2571 const unsigned char *p = buf;
2572 const unsigned char *end = buf + len;
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (end - p < 9) {
2575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2576 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2579 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002580 session->ticket_flags = p[7];
2581
2582 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002583 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002584 p += 9;
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (end - p < session->resumption_key_len) {
2587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2588 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2592 }
2593 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002594 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002595
2596#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2598 if (end - p < 8) {
2599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2600 }
2601 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 p += 8;
2603 }
2604#endif /* MBEDTLS_HAVE_TIME */
2605
2606#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002608#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002610 size_t hostname_len;
2611 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (end - p < 2) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002616 p += 2;
2617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (end - p < (long int) hostname_len) {
2619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2620 }
2621 if (hostname_len > 0) {
2622 session->hostname = mbedtls_calloc(1, hostname_len);
2623 if (session->hostname == NULL) {
2624 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2625 }
2626 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002627 p += hostname_len;
2628 }
2629#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2630 MBEDTLS_SSL_SESSION_TICKETS */
2631
Jerry Yu438ddd82022-07-07 06:55:50 +00002632#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (end - p < 8) {
2634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2635 }
2636 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002637 p += 8;
2638#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 if (end - p < 4) {
2640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2641 }
2642 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002643 p += 4;
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (end - p < 2) {
2646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2647 }
2648 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002649 p += 2;
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < (long int) session->ticket_len) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 if (session->ticket_len > 0) {
2655 session->ticket = mbedtls_calloc(1, session->ticket_len);
2656 if (session->ticket == NULL) {
2657 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2658 }
2659 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002660 p += session->ticket_len;
2661 }
2662 }
2663#endif /* MBEDTLS_SSL_CLI_C */
2664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002666
2667}
2668#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002669MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002670static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2671 unsigned char *buf,
2672 size_t buf_len,
2673 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002674{
2675 ((void) session);
2676 ((void) buf);
2677 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002678 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002680}
Jerry Yu438ddd82022-07-07 06:55:50 +00002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2683 unsigned char *buf,
2684 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002685{
2686 ((void) session);
2687 ((void) buf);
2688 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002690}
2691#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002692#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2695 size_t taglen,
2696 psa_algorithm_t *alg,
2697 psa_key_type_t *key_type,
2698 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002699{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002700#if !defined(MBEDTLS_SSL_HAVE_CCM)
2701 (void) taglen;
2702#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002704#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002705 case MBEDTLS_CIPHER_AES_128_CBC:
2706 *alg = PSA_ALG_CBC_NO_PADDING;
2707 *key_type = PSA_KEY_TYPE_AES;
2708 *key_size = 128;
2709 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002710#endif
2711#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002712 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002714 *key_type = PSA_KEY_TYPE_AES;
2715 *key_size = 128;
2716 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002717#endif
2718#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002719 case MBEDTLS_CIPHER_AES_128_GCM:
2720 *alg = PSA_ALG_GCM;
2721 *key_type = PSA_KEY_TYPE_AES;
2722 *key_size = 128;
2723 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002724#endif
2725#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002726 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002728 *key_type = PSA_KEY_TYPE_AES;
2729 *key_size = 192;
2730 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002731#endif
2732#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733 case MBEDTLS_CIPHER_AES_192_GCM:
2734 *alg = PSA_ALG_GCM;
2735 *key_type = PSA_KEY_TYPE_AES;
2736 *key_size = 192;
2737 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002738#endif
2739#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002740 case MBEDTLS_CIPHER_AES_256_CBC:
2741 *alg = PSA_ALG_CBC_NO_PADDING;
2742 *key_type = PSA_KEY_TYPE_AES;
2743 *key_size = 256;
2744 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002745#endif
2746#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002747 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002749 *key_type = PSA_KEY_TYPE_AES;
2750 *key_size = 256;
2751 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002752#endif
2753#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002754 case MBEDTLS_CIPHER_AES_256_GCM:
2755 *alg = PSA_ALG_GCM;
2756 *key_type = PSA_KEY_TYPE_AES;
2757 *key_size = 256;
2758 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002759#endif
2760#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002761 case MBEDTLS_CIPHER_ARIA_128_CBC:
2762 *alg = PSA_ALG_CBC_NO_PADDING;
2763 *key_type = PSA_KEY_TYPE_ARIA;
2764 *key_size = 128;
2765 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002766#endif
2767#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002768 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002770 *key_type = PSA_KEY_TYPE_ARIA;
2771 *key_size = 128;
2772 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002773#endif
2774#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002775 case MBEDTLS_CIPHER_ARIA_128_GCM:
2776 *alg = PSA_ALG_GCM;
2777 *key_type = PSA_KEY_TYPE_ARIA;
2778 *key_size = 128;
2779 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002780#endif
2781#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002782 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002784 *key_type = PSA_KEY_TYPE_ARIA;
2785 *key_size = 192;
2786 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002787#endif
2788#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002789 case MBEDTLS_CIPHER_ARIA_192_GCM:
2790 *alg = PSA_ALG_GCM;
2791 *key_type = PSA_KEY_TYPE_ARIA;
2792 *key_size = 192;
2793 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002794#endif
2795#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002796 case MBEDTLS_CIPHER_ARIA_256_CBC:
2797 *alg = PSA_ALG_CBC_NO_PADDING;
2798 *key_type = PSA_KEY_TYPE_ARIA;
2799 *key_size = 256;
2800 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002801#endif
2802#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002803 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002805 *key_type = PSA_KEY_TYPE_ARIA;
2806 *key_size = 256;
2807 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002808#endif
2809#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002810 case MBEDTLS_CIPHER_ARIA_256_GCM:
2811 *alg = PSA_ALG_GCM;
2812 *key_type = PSA_KEY_TYPE_ARIA;
2813 *key_size = 256;
2814 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002815#endif
2816#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002817 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2818 *alg = PSA_ALG_CBC_NO_PADDING;
2819 *key_type = PSA_KEY_TYPE_CAMELLIA;
2820 *key_size = 128;
2821 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002822#endif
2823#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002824 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002826 *key_type = PSA_KEY_TYPE_CAMELLIA;
2827 *key_size = 128;
2828 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002829#endif
2830#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002831 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2832 *alg = PSA_ALG_GCM;
2833 *key_type = PSA_KEY_TYPE_CAMELLIA;
2834 *key_size = 128;
2835 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002836#endif
2837#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002838 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002840 *key_type = PSA_KEY_TYPE_CAMELLIA;
2841 *key_size = 192;
2842 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002843#endif
2844#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002845 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2846 *alg = PSA_ALG_GCM;
2847 *key_type = PSA_KEY_TYPE_CAMELLIA;
2848 *key_size = 192;
2849 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002850#endif
2851#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002852 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2853 *alg = PSA_ALG_CBC_NO_PADDING;
2854 *key_type = PSA_KEY_TYPE_CAMELLIA;
2855 *key_size = 256;
2856 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002857#endif
2858#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002859 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002861 *key_type = PSA_KEY_TYPE_CAMELLIA;
2862 *key_size = 256;
2863 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002864#endif
2865#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002866 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2867 *alg = PSA_ALG_GCM;
2868 *key_type = PSA_KEY_TYPE_CAMELLIA;
2869 *key_size = 256;
2870 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002871#endif
2872#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002873 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2874 *alg = PSA_ALG_CHACHA20_POLY1305;
2875 *key_type = PSA_KEY_TYPE_CHACHA20;
2876 *key_size = 256;
2877 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002878#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002879 case MBEDTLS_CIPHER_NULL:
2880 *alg = MBEDTLS_SSL_NULL_CIPHER;
2881 *key_type = 0;
2882 *key_size = 0;
2883 break;
2884 default:
2885 return PSA_ERROR_NOT_SUPPORTED;
2886 }
2887
2888 return PSA_SUCCESS;
2889}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002890#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002891
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002892#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002893int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2894 const unsigned char *dhm_P, size_t P_len,
2895 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002896{
Janos Follath865b3eb2019-12-16 11:46:15 +00002897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 mbedtls_mpi_free(&conf->dhm_P);
2900 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2903 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2904 mbedtls_mpi_free(&conf->dhm_P);
2905 mbedtls_mpi_free(&conf->dhm_G);
2906 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002907 }
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002910}
Paul Bakker5121ce52009-01-03 21:22:43 +00002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002913{
Janos Follath865b3eb2019-12-16 11:46:15 +00002914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 mbedtls_mpi_free(&conf->dhm_P);
2917 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2920 &conf->dhm_P)) != 0 ||
2921 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2922 &conf->dhm_G)) != 0) {
2923 mbedtls_mpi_free(&conf->dhm_P);
2924 mbedtls_mpi_free(&conf->dhm_G);
2925 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002926 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002929}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002930#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002931
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002932#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2933/*
2934 * Set the minimum length for Diffie-Hellman parameters
2935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002936void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2937 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002938{
2939 conf->dhm_min_bitlen = bitlen;
2940}
2941#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2942
Ronald Crone68ab4f2022-10-05 12:46:29 +02002943#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002944#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002945/*
2946 * Set allowed/preferred hashes for handshake signatures
2947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002948void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2949 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002950{
2951 conf->sig_hashes = hashes;
2952}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002953#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002954
Jerry Yuf017ee42022-01-12 15:49:48 +08002955/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002956void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2957 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002958{
Jerry Yuf017ee42022-01-12 15:49:48 +08002959#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2960 conf->sig_hashes = NULL;
2961#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2962 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002963}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002964#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002965
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002966#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002967#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002968/*
2969 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002970 *
2971 * mbedtls_ssl_setup() takes the provided list
2972 * and translates it to a list of IANA TLS group identifiers,
2973 * stored in ssl->handshake->group_list.
2974 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002976void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2977 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002978{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002979 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002980 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002981}
Brett Warrene0edc842021-08-17 09:53:13 +01002982#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002983#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002984
Brett Warrene0edc842021-08-17 09:53:13 +01002985/*
2986 * Set the allowed groups
2987 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002988void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2989 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002990{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002991#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002992 conf->curve_list = NULL;
2993#endif
2994 conf->group_list = group_list;
2995}
2996
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002997#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002998int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002999{
Hanno Becker947194e2017-04-07 13:25:49 +01003000 /* Initialize to suppress unnecessary compiler warning */
3001 size_t hostname_len = 0;
3002
3003 /* Check if new hostname is valid before
3004 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (hostname != NULL) {
3006 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3010 }
Hanno Becker947194e2017-04-07 13:25:49 +01003011 }
3012
3013 /* Now it's clear that we will overwrite the old hostname,
3014 * so we can free it safely */
3015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003017 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003018 }
3019
3020 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003023 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 } else {
3025 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3026 if (ssl->hostname == NULL) {
3027 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3028 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003031
Hanno Becker947194e2017-04-07 13:25:49 +01003032 ssl->hostname[hostname_len] = '\0';
3033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003036}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003037#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003038
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003039#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003040void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3041 int (*f_sni)(void *, mbedtls_ssl_context *,
3042 const unsigned char *, size_t),
3043 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003044{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003045 conf->f_sni = f_sni;
3046 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003047}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003051int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003052{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003053 size_t cur_len, tot_len;
3054 const char **p;
3055
3056 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003057 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3058 * MUST NOT be truncated."
3059 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003060 */
3061 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 for (p = protos; *p != NULL; p++) {
3063 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003064 tot_len += cur_len;
3065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 if ((cur_len == 0) ||
3067 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3068 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3070 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003071 }
3072
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003073 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003079{
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003081}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003083
Johan Pascalb62bb512015-12-03 21:56:45 +01003084#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003085void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3086 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003087{
3088 conf->dtls_srtp_mki_support = support_mki_value;
3089}
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3092 unsigned char *mki_value,
3093 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003094{
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003097 }
Ron Eldor591f1622018-01-22 12:30:04 +02003098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3100 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003101 }
Ron Eldor591f1622018-01-22 12:30:04 +02003102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003104 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003106}
3107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3109 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003110{
Johan Pascal253d0262020-09-22 13:04:45 +02003111 const mbedtls_ssl_srtp_profile *p;
3112 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003113
Johan Pascal253d0262020-09-22 13:04:45 +02003114 /* check the profiles list: all entry must be valid,
3115 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3117 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3118 p++) {
3119 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003120 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003122 /* unsupported value, stop parsing and set the size to an error value */
3123 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003124 }
3125 }
3126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3128 conf->dtls_srtp_profile_list = NULL;
3129 conf->dtls_srtp_profile_list_len = 0;
3130 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003131 }
3132
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003133 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003134 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003137}
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3140 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003141{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003142 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3143 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003145 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003147 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3149 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003150 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003151}
Johan Pascalb62bb512015-12-03 21:56:45 +01003152#endif /* MBEDTLS_SSL_DTLS_SRTP */
3153
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303154#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003155void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003156{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003157 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003158}
3159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003161{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003162 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003163}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303164#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003165
Janos Follath088ce432017-04-10 12:42:31 +01003166#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003167void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3168 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003169{
3170 conf->cert_req_ca_list = cert_req_ca_list;
3171}
3172#endif
3173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003175void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003176{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003177 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003178}
3179#endif
3180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003182void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003183{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003184 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003185}
3186#endif
3187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003189int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003190{
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3192 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3193 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003194 }
3195
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003196 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003199}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003203{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003204 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003205}
3206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003208void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003209{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003210 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003211}
3212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003215 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003216}
3217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3219 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003220{
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003222}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003226#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003227void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003228{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003229 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003230}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003231#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003232
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003233#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003234
Jerry Yud0766ec2022-09-22 10:46:57 +08003235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003236void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3237 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003238{
Jerry Yud0766ec2022-09-22 10:46:57 +08003239 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003240}
3241#endif
3242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3244 mbedtls_ssl_ticket_write_t *f_ticket_write,
3245 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3246 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003247{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003248 conf->f_ticket_write = f_ticket_write;
3249 conf->f_ticket_parse = f_ticket_parse;
3250 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003251}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003252#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003254
Gilles Peskine449bd832023-01-11 14:50:10 +01003255void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3256 mbedtls_ssl_export_keys_t *f_export_keys,
3257 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003258{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003259 ssl->f_export_keys = f_export_keys;
3260 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003261}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003262
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003263#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003264void mbedtls_ssl_conf_async_private_cb(
3265 mbedtls_ssl_config *conf,
3266 mbedtls_ssl_async_sign_t *f_async_sign,
3267 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3268 mbedtls_ssl_async_resume_t *f_async_resume,
3269 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003271{
3272 conf->f_async_sign_start = f_async_sign;
3273 conf->f_async_decrypt_start = f_async_decrypt;
3274 conf->f_async_resume = f_async_resume;
3275 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003276 conf->p_async_config_data = async_config_data;
3277}
3278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003280{
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003282}
3283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003285{
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 if (ssl->handshake == NULL) {
3287 return NULL;
3288 } else {
3289 return ssl->handshake->user_async_ctx;
3290 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003291}
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3294 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003295{
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003297 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003299}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003300#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003301
Paul Bakker5121ce52009-01-03 21:22:43 +00003302/*
3303 * SSL get accessors
3304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003305uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003306{
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 if (ssl->session != NULL) {
3308 return ssl->session->verify_result;
3309 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003310
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 if (ssl->session_negotiate != NULL) {
3312 return ssl->session_negotiate->verify_result;
3313 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003316}
3317
Gilles Peskine449bd832023-01-11 14:50:10 +01003318int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003319{
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (ssl == NULL || ssl->session == NULL) {
3321 return 0;
3322 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003323
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003325}
3326
Gilles Peskine449bd832023-01-11 14:50:10 +01003327const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003328{
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl == NULL || ssl->session == NULL) {
3330 return NULL;
3331 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003334}
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003337{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3340 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003341 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003343 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003345 }
3346 }
3347#endif
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003350 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003352 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003353 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003354 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003356 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003357}
3358
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003359#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003360size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003361{
David Horstmann95d516f2021-05-04 18:36:56 +01003362 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003363 size_t read_mfl;
3364
Jerry Yuddda0502022-12-01 19:43:12 +08003365#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003366 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3368 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3369 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003370 }
Jerry Yuddda0502022-12-01 19:43:12 +08003371#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003372
3373 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 if (ssl->session_out != NULL) {
3375 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3376 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003377 max_len = read_mfl;
3378 }
3379 }
3380
Jerry Yuddda0502022-12-01 19:43:12 +08003381 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 if (ssl->session_negotiate != NULL) {
3383 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3384 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003385 max_len = read_mfl;
3386 }
3387 }
3388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003390}
3391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003393{
3394 size_t max_len;
3395
3396 /*
3397 * Assume mfl_code is correct since it was checked when set
3398 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003400
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003401 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003402 if (ssl->session_out != NULL &&
3403 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3404 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003405 }
3406
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003407 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 if (ssl->session_negotiate != NULL &&
3409 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3410 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003411 }
3412
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003414}
3415#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3416
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003417#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003418size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003419{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003420 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3422 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3423 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3424 return 0;
3425 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003426
Gilles Peskine449bd832023-01-11 14:50:10 +01003427 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3428 return ssl->mtu;
3429 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003430
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 if (ssl->mtu == 0) {
3432 return ssl->handshake->mtu;
3433 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003434
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 return ssl->mtu < ssl->handshake->mtu ?
3436 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003437}
3438#endif /* MBEDTLS_SSL_PROTO_DTLS */
3439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003441{
3442 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3443
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003444#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3445 !defined(MBEDTLS_SSL_PROTO_DTLS)
3446 (void) ssl;
3447#endif
3448
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003449#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003453 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003455#endif
3456
3457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3459 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3460 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003461 const size_t overhead = (size_t) ret;
3462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 if (ret < 0) {
3464 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003465 }
3466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (mtu <= overhead) {
3468 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3469 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3470 }
3471
3472 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003473 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003475 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003476#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003477
Hanno Becker0defedb2018-08-10 12:35:02 +01003478#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3479 !defined(MBEDTLS_SSL_PROTO_DTLS)
3480 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003481#endif
3482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003484}
3485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003487{
3488 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3489
3490#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3491 (void) ssl;
3492#endif
3493
3494#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003496
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003498 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003500#endif
3501
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003503}
3504
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003506const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003507{
Gilles Peskine449bd832023-01-11 14:50:10 +01003508 if (ssl == NULL || ssl->session == NULL) {
3509 return NULL;
3510 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003511
Hanno Beckere6824572019-02-07 13:18:46 +00003512#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003514#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003516#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003517}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003521int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3522 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003523{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003524 int ret;
3525
Gilles Peskine449bd832023-01-11 14:50:10 +01003526 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003527 dst == NULL ||
3528 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3530 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003531 }
3532
Hanno Beckere810bbc2021-05-14 16:01:05 +01003533 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3534 * idempotent: Each session can only be exported once.
3535 *
3536 * (This is in preparation for TLS 1.3 support where we will
3537 * need the ability to export multiple sessions (aka tickets),
3538 * which will be achieved by calling mbedtls_ssl_get_session()
3539 * multiple times until it fails.)
3540 *
3541 * Check whether we have already exported the current session,
3542 * and fail if so.
3543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003544 if (ssl->session->exported == 1) {
3545 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3546 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003547
Gilles Peskine449bd832023-01-11 14:50:10 +01003548 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3549 if (ret != 0) {
3550 return ret;
3551 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003552
3553 /* Remember that we've exported the session. */
3554 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003555 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003556}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003558
Paul Bakker5121ce52009-01-03 21:22:43 +00003559/*
Hanno Beckera835da52019-05-16 12:39:07 +01003560 * Define ticket header determining Mbed TLS version
3561 * and structure of the ticket.
3562 */
3563
Hanno Becker94ef3b32019-05-16 12:50:45 +01003564/*
Hanno Becker50b59662019-05-28 14:30:45 +01003565 * Define bitflag determining compile-time settings influencing
3566 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003567 */
3568
Hanno Becker50b59662019-05-28 14:30:45 +01003569#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003570#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003571#else
Hanno Becker3e088662019-05-29 11:10:18 +01003572#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003573#endif /* MBEDTLS_HAVE_TIME */
3574
3575#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003576#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003577#else
Hanno Becker3e088662019-05-29 11:10:18 +01003578#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003579#endif /* MBEDTLS_X509_CRT_PARSE_C */
3580
3581#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003582#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003583#else
Hanno Becker3e088662019-05-29 11:10:18 +01003584#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003585#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3586
3587#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003588#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003589#else
Hanno Becker3e088662019-05-29 11:10:18 +01003590#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003591#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3592
Hanno Becker94ef3b32019-05-16 12:50:45 +01003593#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003594#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003595#else
Hanno Becker3e088662019-05-29 11:10:18 +01003596#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003597#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3598
Hanno Becker94ef3b32019-05-16 12:50:45 +01003599#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3600#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3601#else
3602#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3603#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3604
Hanno Becker3e088662019-05-29 11:10:18 +01003605#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3606#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3607#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3608#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003609#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3610#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003611
Hanno Becker50b59662019-05-28 14:30:45 +01003612#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003613 ((uint16_t) ( \
3614 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3615 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3616 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3617 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3618 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3619 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3620 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003621
Hanno Beckerf8787072019-05-16 12:41:07 +01003622static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003623 MBEDTLS_VERSION_MAJOR,
3624 MBEDTLS_VERSION_MINOR,
3625 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003626 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3627 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003628};
Hanno Beckera835da52019-05-16 12:39:07 +01003629
3630/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003631 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003632 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003633 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003634 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003635 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003636 * opaque mbedtls_version[3]; // library version: major, minor, patch
3637 * opaque session_format[2]; // library-version specific 16-bit field
3638 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003639 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003640 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003641 * Note: When updating the format, remember to keep
3642 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003643 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003644 * // In this version, `session_format` determines
3645 * // the setting of those compile-time
3646 * // configuration options which influence
3647 * // the structure of mbedtls_ssl_session.
3648 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003649 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003650 * // - TLS 1.2 (0x0303)
3651 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003652 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003653 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003654 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003655 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003656 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003657 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003658 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003659 *
3660 * };
3661 *
3662 * } serialized_session;
3663 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003664 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003665
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003666MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003667static int ssl_session_save(const mbedtls_ssl_session *session,
3668 unsigned char omit_header,
3669 unsigned char *buf,
3670 size_t buf_len,
3671 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003672{
3673 unsigned char *p = buf;
3674 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003675 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003676#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3677 size_t out_len;
3678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3679#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003680 if (session == NULL) {
3681 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3682 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003683
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003685 /*
3686 * Add Mbed TLS version identifier
3687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003689
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 if (used <= buf_len) {
3691 memcpy(p, ssl_serialized_session_header,
3692 sizeof(ssl_serialized_session_header));
3693 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003694 }
3695 }
3696
3697 /*
3698 * TLS version identifier
3699 */
3700 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 if (used <= buf_len) {
3702 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003703 }
3704
3705 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003706 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003708#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 case MBEDTLS_SSL_VERSION_TLS1_2:
3710 used += ssl_tls12_session_save(session, p, remaining_len);
3711 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003712#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3713
Jerry Yu251a12e2022-07-13 15:15:48 +08003714#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003715 case MBEDTLS_SSL_VERSION_TLS1_3:
3716 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3717 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3718 return ret;
3719 }
3720 used += out_len;
3721 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003722#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3723
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 default:
3725 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 }
3727
3728 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003729 if (used > buf_len) {
3730 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3731 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003732
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003734}
3735
3736/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003737 * Public wrapper for ssl_session_save()
3738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003739int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3740 unsigned char *buf,
3741 size_t buf_len,
3742 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003743{
Gilles Peskine449bd832023-01-11 14:50:10 +01003744 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003745}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003746
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003747/*
3748 * Deserialize session, see mbedtls_ssl_session_save() for format.
3749 *
3750 * This internal version is wrapped by a public function that cleans up in
3751 * case of error, and has an extra option omit_header.
3752 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003753MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003754static int ssl_session_load(mbedtls_ssl_session *session,
3755 unsigned char omit_header,
3756 const unsigned char *buf,
3757 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003758{
3759 const unsigned char *p = buf;
3760 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003761 size_t remaining_len;
3762
3763
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 if (session == NULL) {
3765 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3766 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003767
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003769 /*
3770 * Check Mbed TLS version identifier
3771 */
3772
Gilles Peskine449bd832023-01-11 14:50:10 +01003773 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3774 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003775 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003776
3777 if (memcmp(p, ssl_serialized_session_header,
3778 sizeof(ssl_serialized_session_header)) != 0) {
3779 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3780 }
3781 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003782 }
3783
3784 /*
3785 * TLS version identifier
3786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 if (1 > (size_t) (end - p)) {
3788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3789 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003790 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003791
3792 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003793 remaining_len = (end - p);
3794 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003795#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 case MBEDTLS_SSL_VERSION_TLS1_2:
3797 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003798#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3799
Jerry Yu438ddd82022-07-07 06:55:50 +00003800#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003801 case MBEDTLS_SSL_VERSION_TLS1_3:
3802 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003803#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3804
Gilles Peskine449bd832023-01-11 14:50:10 +01003805 default:
3806 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003807 }
3808}
3809
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003810/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003811 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003813int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3814 const unsigned char *buf,
3815 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003816{
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003818
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 if (ret != 0) {
3820 mbedtls_ssl_session_free(session);
3821 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003824}
3825
3826/*
Paul Bakker1961b702013-01-25 14:49:24 +01003827 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003828 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003830static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003831{
3832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3833
Ronald Cron66dbf912022-02-02 15:33:46 +01003834 /*
3835 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003836 * that were written into the output buffer by the previous handshake step,
3837 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003838 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3839 * We proceed to the next handshake step only when all data from the
3840 * previous one have been sent to the peer, thus we make sure that this is
3841 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3842 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3843 * we have to wait before to go ahead.
3844 * In the case of TLS 1.3, handshake step handlers do not send data to the
3845 * peer. Data are only sent here and through
3846 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003847 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3850 return ret;
3851 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003852
3853#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3855 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3856 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3857 return ret;
3858 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003859 }
3860#endif /* MBEDTLS_SSL_PROTO_DTLS */
3861
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003863}
3864
Gilles Peskine449bd832023-01-11 14:50:10 +01003865int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003866{
Hanno Becker41934dd2021-08-07 19:13:43 +01003867 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003868
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003870 ssl->conf == NULL ||
3871 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3873 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003874 }
3875
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 ret = ssl_prepare_handshake_step(ssl);
3877 if (ret != 0) {
3878 return ret;
3879 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 ret = mbedtls_ssl_handle_pending_alert(ssl);
3882 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003883 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 }
Jerry Yue7047812021-09-13 19:26:39 +08003885
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003886 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3887 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3888 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3889
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003890#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3892 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003893 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003894
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003896 case MBEDTLS_SSL_HELLO_REQUEST:
3897 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003898 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003899 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003900
Ronald Cron9f0fba32022-02-10 16:45:15 +01003901 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003903 break;
3904
3905 default:
3906#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3908 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3909 } else {
3910 ret = mbedtls_ssl_handshake_client_step(ssl);
3911 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003912#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003913 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003914#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003916#endif
3917 }
Jerry Yub9930e72021-08-06 17:11:51 +08003918 }
Ronald Cron6291b232023-03-08 15:51:25 +01003919#endif /* MBEDTLS_SSL_CLI_C */
3920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003921#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003923#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3924 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003926 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 ret = mbedtls_ssl_handshake_server_step(ssl);
3928 }
Ronald Cron6291b232023-03-08 15:51:25 +01003929#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3930 ret = mbedtls_ssl_handshake_server_step(ssl);
3931#else
3932 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003933#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003934 }
3935#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003936
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003938 /* handshake_step return error. And it is same
3939 * with alert_reason.
3940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (ssl->send_alert) {
3942 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003943 goto cleanup;
3944 }
3945 }
3946
3947cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003949}
3950
3951/*
3952 * Perform the SSL handshake
3953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003954int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003955{
3956 int ret = 0;
3957
Hanno Beckera817ea42020-10-20 15:20:23 +01003958 /* Sanity checks */
3959
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 if (ssl == NULL || ssl->conf == NULL) {
3961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3962 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003963
Hanno Beckera817ea42020-10-20 15:20:23 +01003964#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3966 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3967 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3968 "mbedtls_ssl_set_timer_cb() for DTLS"));
3969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003970 }
3971#endif /* MBEDTLS_SSL_PROTO_DTLS */
3972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003974
Hanno Beckera817ea42020-10-20 15:20:23 +01003975 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3977 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003978
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003980 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 }
Paul Bakker1961b702013-01-25 14:49:24 +01003982 }
3983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003987}
3988
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003989#if defined(MBEDTLS_SSL_RENEGOTIATION)
3990#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003991/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003992 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003993 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003994MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003995static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003996{
Janos Follath865b3eb2019-12-16 11:46:15 +00003997 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004000
4001 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4003 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4006 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4007 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004008 }
4009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004011
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004013}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004015
4016/*
4017 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018 * - any side: calling mbedtls_ssl_renegotiate(),
4019 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4020 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004021 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004022 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004023 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004025int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004026{
Janos Follath865b3eb2019-12-16 11:46:15 +00004027 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004030
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 if ((ret = ssl_handshake_init(ssl)) != 0) {
4032 return ret;
4033 }
Paul Bakker48916f92012-09-16 19:57:18 +00004034
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004035 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4036 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004037#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4039 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4040 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004041 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004043 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004045 }
4046#endif
4047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004048 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4049 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004050
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4053 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004054 }
4055
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004057
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004059}
4060
4061/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004062 * Renegotiate current connection on client,
4063 * or request renegotiation on server
4064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004066{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004067 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if (ssl == NULL || ssl->conf == NULL) {
4070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4071 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004073#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004074 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4076 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4078 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004080 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004081
4082 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (ssl->out_left != 0) {
4084 return mbedtls_ssl_flush_output(ssl);
4085 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004088 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004089#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004091#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004092 /*
4093 * On client, either start the renegotiation process or,
4094 * if already in progress, continue the handshake
4095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4097 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004099 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004100
4101 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4102 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4103 return ret;
4104 }
4105 } else {
4106 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4107 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4108 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004109 }
4110 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004111#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004114}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004115#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004118{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004119 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004122 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004124
Valerio Setti6f0441d2023-07-03 12:11:36 +02004125#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004126#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 if (ssl->handshake->group_list_heap_allocated) {
4128 mbedtls_free((void *) handshake->group_list);
4129 }
Brett Warrene0edc842021-08-17 09:53:13 +01004130 handshake->group_list = NULL;
4131#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004132#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004133
Ronald Crone68ab4f2022-10-05 12:46:29 +02004134#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004135#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (ssl->handshake->sig_algs_heap_allocated) {
4137 mbedtls_free((void *) handshake->sig_algs);
4138 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004139 handshake->sig_algs = NULL;
4140#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004141#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 if (ssl->handshake->certificate_request_context) {
4143 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004144 }
4145#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004146#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004147
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004148#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4150 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004151 handshake->async_in_progress = 0;
4152 }
4153#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4154
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004155#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004156#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004158#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004159 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004160#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004161#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004162#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004163#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004165#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004166 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004167#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004168#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004170#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004172#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004173#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004174 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004176#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004177
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004178#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004179#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004181 /*
4182 * Opaque keys are not stored in the handshake's data and it's the user
4183 * responsibility to destroy them. Clear ones, instead, are created by
4184 * the TLS library and should be destroyed at the same level
4185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4187 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004188 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004189 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4190#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004192#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004193#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004194 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004195 handshake->ecjpake_cache = NULL;
4196 handshake->ecjpake_cache_len = 0;
4197#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004198#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004199
Valerio Setti7aeec542023-07-05 18:57:21 +02004200#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004201 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004202 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004203 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004205#endif
4206
Ronald Cron73fe8df2022-10-05 14:31:43 +02004207#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004210 /* The maintenance of the external PSK key slot is the
4211 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (ssl->handshake->psk_opaque_is_internal) {
4213 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004214 ssl->handshake->psk_opaque_is_internal = 0;
4215 }
4216 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4217 }
Neil Armstronge952a302022-05-03 10:22:14 +02004218#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004220 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004221 }
Neil Armstronge952a302022-05-03 10:22:14 +02004222#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004223#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004225#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4226 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004227 /*
4228 * Free only the linked list wrapper, not the keys themselves
4229 * since the belong to the SNI callback
4230 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004232#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004233
Gilles Peskineeccd8882020-03-10 12:19:08 +01004234#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4236 if (handshake->ecrs_peer_cert != NULL) {
4237 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4238 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004239 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004240#endif
4241
Hanno Becker75173122019-02-06 16:18:31 +00004242#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4243 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004245#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4246
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004247#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4249 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004250#endif /* MBEDTLS_SSL_CLI_C &&
4251 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004252
4253#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 mbedtls_ssl_flight_free(handshake->flight);
4255 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004256#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004257
Valerio Settiea59c432023-07-25 11:14:03 +02004258#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004259 if (handshake->xxdh_psa_privkey_is_external == 0) {
4260 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 }
Valerio Settiea59c432023-07-25 11:14:03 +02004262#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004263
Ronald Cron6f135e12021-12-08 16:57:54 +01004264#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 mbedtls_ssl_transform_free(handshake->transform_handshake);
4266 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004267#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4269 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004270#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004271#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004272
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004273
4274#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4275 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4276 * processes datagrams and the fact that a datagram is allowed to have
4277 * several records in it, it is possible that the I/O buffers are not
4278 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4280 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004281#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004282
Jerry Yuba9c7272021-10-30 11:54:10 +08004283 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 mbedtls_platform_zeroize(handshake,
4285 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004286}
4287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004289{
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004291 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004294#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004296#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004297
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004298#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004302#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004304#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004305
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004307}
4308
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004309#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004310
4311#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4312#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4313#else
4314#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4315#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4316
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004317#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004318
4319#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4320#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4321#else
4322#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4323#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4324
4325#if defined(MBEDTLS_SSL_ALPN)
4326#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4327#else
4328#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4329#endif /* MBEDTLS_SSL_ALPN */
4330
4331#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4332#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4333#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4334#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4335
4336#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 ((uint32_t) ( \
4338 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4339 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4340 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4341 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4342 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4343 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4344 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4345 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004346
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004347static unsigned char ssl_serialized_context_header[] = {
4348 MBEDTLS_VERSION_MAJOR,
4349 MBEDTLS_VERSION_MINOR,
4350 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4352 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4353 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4354 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4355 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004356};
4357
Paul Bakker5121ce52009-01-03 21:22:43 +00004358/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004359 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004360 *
4361 * The format of the serialized data is:
4362 * (in the presentation language of TLS, RFC 8446 section 3)
4363 *
4364 * // header
4365 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004366 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004367 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004368 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004369 * Note: When updating the format, remember to keep these
4370 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004371 *
4372 * // session sub-structure
4373 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4374 * // transform sub-structure
4375 * uint8 random[64]; // ServerHello.random+ClientHello.random
4376 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4377 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4378 * // fields from ssl_context
4379 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4380 * uint64 in_window_top; // DTLS: last validated record seq_num
4381 * uint64 in_window; // DTLS: bitmask for replay protection
4382 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4383 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4384 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4385 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4386 *
4387 * Note that many fields of the ssl_context or sub-structures are not
4388 * serialized, as they fall in one of the following categories:
4389 *
4390 * 1. forced value (eg in_left must be 0)
4391 * 2. pointer to dynamically-allocated memory (eg session, transform)
4392 * 3. value can be re-derived from other data (eg session keys from MS)
4393 * 4. value was temporary (eg content of input buffer)
4394 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4397 unsigned char *buf,
4398 size_t buf_len,
4399 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004400{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004401 unsigned char *p = buf;
4402 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004403 size_t session_len;
4404 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004405
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004406 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004407 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4408 * this function's documentation.
4409 *
4410 * These are due to assumptions/limitations in the implementation. Some of
4411 * them are likely to stay (no handshake in progress) some might go away
4412 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004413 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004414 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4416 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004418 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (ssl->handshake != NULL) {
4420 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004422 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004423 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 if (ssl->transform == NULL || ssl->session == NULL) {
4425 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004427 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004428 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 if (mbedtls_ssl_check_pending(ssl) != 0) {
4430 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4431 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004432 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 if (ssl->out_left != 0) {
4434 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004436 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004437 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4439 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004441 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004442 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4444 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4445 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004446 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004447 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4449 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004451 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004452 /* Renegotiation must not be enabled */
4453#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4455 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004457 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004458#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004459
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004460 /*
4461 * Version and format identifier
4462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (used <= buf_len) {
4466 memcpy(p, ssl_serialized_context_header,
4467 sizeof(ssl_serialized_context_header));
4468 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004469 }
4470
4471 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004472 * Session (length + data)
4473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4475 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4476 return ret;
4477 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004478
4479 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 if (used <= buf_len) {
4481 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004482 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 ret = ssl_session_save(ssl->session, 1,
4485 p, session_len, &session_len);
4486 if (ret != 0) {
4487 return ret;
4488 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004489
4490 p += session_len;
4491 }
4492
4493 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004494 * Transform
4495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 used += sizeof(ssl->transform->randbytes);
4497 if (used <= buf_len) {
4498 memcpy(p, ssl->transform->randbytes,
4499 sizeof(ssl->transform->randbytes));
4500 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004501 }
4502
4503#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4504 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004506 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004508 p += ssl->transform->in_cid_len;
4509
4510 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004512 p += ssl->transform->out_cid_len;
4513 }
4514#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4515
4516 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004517 * Saved fields from top-level ssl_context structure
4518 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004519 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (used <= buf_len) {
4521 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004522 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004523 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004524
4525#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4526 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (used <= buf_len) {
4528 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004529 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004532 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004533 }
4534#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4535
4536#if defined(MBEDTLS_SSL_PROTO_DTLS)
4537 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004539 *p++ = ssl->disable_datagram_packing;
4540 }
4541#endif /* MBEDTLS_SSL_PROTO_DTLS */
4542
Jerry Yuae0b2e22021-10-08 15:21:19 +08004543 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (used <= buf_len) {
4545 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004546 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004547 }
4548
4549#if defined(MBEDTLS_SSL_PROTO_DTLS)
4550 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (used <= buf_len) {
4552 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004553 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004554 }
4555#endif /* MBEDTLS_SSL_PROTO_DTLS */
4556
4557#if defined(MBEDTLS_SSL_ALPN)
4558 {
4559 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004561 : 0;
4562
4563 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004565 *p++ = alpn_len;
4566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (ssl->alpn_chosen != NULL) {
4568 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004569 p += alpn_len;
4570 }
4571 }
4572 }
4573#endif /* MBEDTLS_SSL_ALPN */
4574
4575 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004576 * Done
4577 */
4578 *olen = used;
4579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (used > buf_len) {
4581 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4582 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004587}
4588
4589/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004590 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004591 *
4592 * This internal version is wrapped by a public function that cleans up in
4593 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004594 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004595MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004596static int ssl_context_load(mbedtls_ssl_context *ssl,
4597 const unsigned char *buf,
4598 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004599{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004600 const unsigned char *p = buf;
4601 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004602 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004604#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004605 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004606#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004607
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004608 /*
4609 * The context should have been freshly setup or reset.
4610 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004611 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004612 * renegotiating, or if the user mistakenly loaded a session first.)
4613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4615 ssl->session != NULL) {
4616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004617 }
4618
4619 /*
4620 * We can't check that the config matches the initial one, but we can at
4621 * least check it matches the requirements for serializing.
4622 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004623 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004624#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004625 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004626#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004627 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4628 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4629 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4630 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004632 }
4633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004635
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004636 /*
4637 * Check version identifier
4638 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004641 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004642
4643 if (memcmp(p, ssl_serialized_context_header,
4644 sizeof(ssl_serialized_context_header)) != 0) {
4645 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4646 }
4647 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004648
4649 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004650 * Session
4651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if ((size_t) (end - p) < 4) {
4653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4654 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004655
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004656 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004657 p += 4;
4658
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004659 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004660 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004661 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004662 ssl->session_in = ssl->session;
4663 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004664 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 if ((size_t) (end - p) < session_len) {
4667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4668 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 ret = ssl_session_load(ssl->session, 1, p, session_len);
4671 if (ret != 0) {
4672 mbedtls_ssl_session_free(ssl->session);
4673 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004674 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004675
4676 p += session_len;
4677
4678 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004679 * Transform
4680 */
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(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004684#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004685 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686 ssl->transform_in = ssl->transform;
4687 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004688 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004689#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004690
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004691#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4693 if (prf_func == NULL) {
4694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4695 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004696
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4700 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 ret = ssl_tls12_populate_transform(ssl->transform,
4703 ssl->session->ciphersuite,
4704 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004705#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004707#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 prf_func,
4709 p, /* currently pointing to randbytes */
4710 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4711 ssl->conf->endpoint,
4712 ssl);
4713 if (ret != 0) {
4714 return ret;
4715 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004716#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004718
4719#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4720 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if ((size_t) (end - p) < 1) {
4722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4723 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004724
4725 ssl->transform->in_cid_len = *p++;
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4729 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004732 p += ssl->transform->in_cid_len;
4733
4734 ssl->transform->out_cid_len = *p++;
4735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4738 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004741 p += ssl->transform->out_cid_len;
4742#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4743
4744 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004745 * Saved fields from top-level ssl_context structure
4746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if ((size_t) (end - p) < 4) {
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4749 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004750
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004751 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004752 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004753
4754#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if ((size_t) (end - p) < 16) {
4756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4757 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004758
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004759 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760 p += 8;
4761
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004762 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004763 p += 8;
4764#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4765
4766#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if ((size_t) (end - p) < 1) {
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4769 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770
4771 ssl->disable_datagram_packing = *p++;
4772#endif /* MBEDTLS_SSL_PROTO_DTLS */
4773
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4775 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4776 }
4777 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4778 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004779
4780#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if ((size_t) (end - p) < 2) {
4782 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4783 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004784
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004786 p += 2;
4787#endif /* MBEDTLS_SSL_PROTO_DTLS */
4788
4789#if defined(MBEDTLS_SSL_ALPN)
4790 {
4791 uint8_t alpn_len;
4792 const char **cur;
4793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 if ((size_t) (end - p) < 1) {
4795 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4796 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004797
4798 alpn_len = *p++;
4799
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004801 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4803 if (strlen(*cur) == alpn_len &&
4804 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004805 ssl->alpn_chosen = *cur;
4806 break;
4807 }
4808 }
4809 }
4810
4811 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4814 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004815
4816 p += alpn_len;
4817 }
4818#endif /* MBEDTLS_SSL_ALPN */
4819
4820 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004821 * Forced fields from top-level ssl_context structure
4822 *
4823 * Most of them already set to the correct value by mbedtls_ssl_init() and
4824 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4825 */
4826 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004827 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004828
Hanno Becker361b10d2019-08-30 10:42:49 +01004829 /* Adjust pointers for header fields of outgoing records to
4830 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004832
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004833#if defined(MBEDTLS_SSL_PROTO_DTLS)
4834 ssl->in_epoch = 1;
4835#endif
4836
4837 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4838 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004839 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4840 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (ssl->handshake != NULL) {
4842 mbedtls_ssl_handshake_free(ssl);
4843 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004844 ssl->handshake = NULL;
4845 }
4846
4847 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004848 * Done - should have consumed entire buffer
4849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (p != end) {
4851 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4852 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004855}
4856
4857/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004858 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004860int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4861 const unsigned char *buf,
4862 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004863{
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (ret != 0) {
4867 mbedtls_ssl_free(context);
4868 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004871}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004872#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004873
4874/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004875 * Free an SSL context
4876 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004878{
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004880 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004886#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4887 size_t out_buf_len = ssl->out_buf_len;
4888#else
4889 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4890#endif
4891
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004892 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004893 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 }
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004897#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4898 size_t in_buf_len = ssl->in_buf_len;
4899#else
4900 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4901#endif
4902
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004903 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004904 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004905 }
4906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if (ssl->transform) {
4908 mbedtls_ssl_transform_free(ssl->transform);
4909 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004910 }
4911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (ssl->handshake) {
4913 mbedtls_ssl_handshake_free(ssl);
4914 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004915
4916#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4918 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004919#endif
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 mbedtls_ssl_session_free(ssl->session_negotiate);
4922 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004923 }
4924
Ronald Cron6f135e12021-12-08 16:57:54 +01004925#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 mbedtls_ssl_transform_free(ssl->transform_application);
4927 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004928#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if (ssl->session) {
4931 mbedtls_ssl_session_free(ssl->session);
4932 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004933 }
4934
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004937 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004938 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004939#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004940
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004941#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004943#endif
4944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004946
Paul Bakker86f04f42013-02-14 11:20:09 +01004947 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004949}
4950
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004951/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004952 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004954void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004955{
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004957}
4958
Gilles Peskineae270bf2021-06-02 00:05:29 +02004959/* The selection should be the same as mbedtls_x509_crt_profile_default in
4960 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004961 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004962 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004963 * about this list.
4964 */
Brett Warrene0edc842021-08-17 09:53:13 +01004965static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004966#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004967 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004968#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004969#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004970 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004971#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004972#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004973 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004974#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004975#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004976 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004977#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004978#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004979 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004980#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004981#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004982 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004983#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004984#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004985 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004986#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004987#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004988 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004989#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004990#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004991 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4992 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4993 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4994 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4995 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4996#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004997 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004998};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004999
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005000static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005001 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5002 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5003 0
5004};
5005
Ronald Crone68ab4f2022-10-05 12:46:29 +02005006#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005007
Jerry Yu909df7b2022-01-22 11:56:27 +08005008/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005009 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005010 * rules SHOULD be upheld.
5011 * - No duplicate entries.
5012 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005013 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005014 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005015 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005016static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005017
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005018#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005019 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005020 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005021 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005022 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5023#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005024
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005025#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005027 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005028 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005029 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5030#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005031
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005032#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005033 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005034 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005035 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005036 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5037#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005041 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005042#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005043 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005046 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005047 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005048#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005049 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005050
Gilles Peskine449bd832023-01-11 14:50:10 +01005051#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005053 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005054#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005055 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005056
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005057#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005058 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005059#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005060
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005061#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005062 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005063#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005064
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005065#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005066 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005067#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005068
Gabor Mezei15b95a62022-05-09 16:37:58 +02005069 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005070};
5071
5072/* NOTICE: see above */
5073#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5074static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005075#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005076#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005078#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005079#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5080 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5081#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005082#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005084#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005085#endif /* MBEDTLS_MD_CAN_SHA512*/
5086#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005087#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005089#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005090#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5091 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5092#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005093#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005095#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005096#endif /* MBEDTLS_MD_CAN_SHA384*/
5097#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005098#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005100#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005101#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5102 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5103#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005104#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005106#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005107#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005108 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005109};
5110#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5111/* NOTICE: see above */
5112static uint16_t ssl_preset_suiteb_sig_algs[] = {
5113
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005114#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005115 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005116 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005117 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005118 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5119#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005120
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005121#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005122 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005123 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005124 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005125 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5126#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005129 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005130 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005131#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005132 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005133
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005134#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005135 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005136#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005137
Gabor Mezei15b95a62022-05-09 16:37:58 +02005138 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005139};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005140
Jerry Yu909df7b2022-01-22 11:56:27 +08005141/* NOTICE: see above */
5142#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5143static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005144#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005145#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005147#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005148#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005150#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005151#endif /* MBEDTLS_MD_CAN_SHA256*/
5152#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005153#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005155#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005156#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005159#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005160 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005161};
Jerry Yu909df7b2022-01-22 11:56:27 +08005162#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5163
Ronald Crone68ab4f2022-10-05 12:46:29 +02005164#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005165
Brett Warrene0edc842021-08-17 09:53:13 +01005166static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005167#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005168 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005169#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005170#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005171 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005172#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005173 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005174};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005175
Ronald Crone68ab4f2022-10-05 12:46:29 +02005176#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005177/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005178 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005179MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005180static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005181{
5182 size_t i, j;
5183 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005184
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5186 for (j = 0; j < i; j++) {
5187 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005188 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 }
5190 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5191 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5192 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005193 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005194 }
5195 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005196 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197}
5198
Ronald Crone68ab4f2022-10-05 12:46:29 +02005199#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005200
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005201/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005202 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005203 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005204int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5205 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005206{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005207#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005209#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005210
Ronald Crone68ab4f2022-10-05 12:46:29 +02005211#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5213 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5214 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005215 }
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5218 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5219 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005220 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005221
5222#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5224 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5225 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005226 }
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5229 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5230 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005231 }
5232#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005233#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005234
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005235 /* Use the functions here so that they are covered in tests,
5236 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 mbedtls_ssl_conf_endpoint(conf, endpoint);
5238 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005239
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005240 /*
5241 * Things that are common to all presets
5242 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005243#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005245 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5246#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5247 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5248#endif
5249 }
5250#endif
5251
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005252#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5253 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5254#endif
5255
5256#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5257 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5258#endif
5259
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005260#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261 conf->f_cookie_write = ssl_cookie_write_dummy;
5262 conf->f_cookie_check = ssl_cookie_check_dummy;
5263#endif
5264
5265#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5266 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5267#endif
5268
Janos Follath088ce432017-04-10 12:42:31 +01005269#if defined(MBEDTLS_SSL_SRV_C)
5270 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005271 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005272#endif
5273
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005274#if defined(MBEDTLS_SSL_PROTO_DTLS)
5275 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5276 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5277#endif
5278
5279#if defined(MBEDTLS_SSL_RENEGOTIATION)
5280 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 memset(conf->renego_period, 0x00, 2);
5282 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005283#endif
5284
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005285#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005287 const unsigned char dhm_p[] =
5288 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5289 const unsigned char dhm_g[] =
5290 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5293 dhm_p, sizeof(dhm_p),
5294 dhm_g, sizeof(dhm_g))) != 0) {
5295 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005296 }
5297 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005298#endif
5299
Ronald Cron6f135e12021-12-08 16:57:54 +01005300#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005301
5302#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005303 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005304#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005305 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005306#endif
5307#endif /* MBEDTLS_SSL_EARLY_DATA */
5308
Jerry Yud0766ec2022-09-22 10:46:57 +08005309#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005310 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005312#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005313 /*
5314 * Allow all TLS 1.3 key exchange modes by default.
5315 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005316 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005317#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005320#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005321 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005322 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005323#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005325#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005327#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005328 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5329 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005330#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5331 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5332 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5333#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5334 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5335 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5336#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005338#endif
5339 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005340
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341 /*
5342 * Preset-specific defaults
5343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005345 /*
5346 * NSA Suite B
5347 */
5348 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005349
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005350 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005351
5352#if defined(MBEDTLS_X509_CRT_PARSE_C)
5353 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005354#endif
5355
Ronald Crone68ab4f2022-10-05 12:46:29 +02005356#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005357#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005359 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005361#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005363#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005365#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005366 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005368 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005369 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005370
5371 /*
5372 * Default
5373 */
5374 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005375
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005376 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005377
5378#if defined(MBEDTLS_X509_CRT_PARSE_C)
5379 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5380#endif
5381
Ronald Crone68ab4f2022-10-05 12:46:29 +02005382#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005385 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005389#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005390
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005391#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005392 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005393#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005394 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005395
5396#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5397 conf->dhm_min_bitlen = 1024;
5398#endif
5399 }
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005402}
5403
5404/*
5405 * Free mbedtls_ssl_config
5406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005407void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005408{
5409#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 mbedtls_mpi_free(&conf->dhm_P);
5411 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005412#endif
5413
Ronald Cron73fe8df2022-10-05 14:31:43 +02005414#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005415#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005417 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5418 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005419#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005421 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005422 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005423 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005424 }
5425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005427 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005428 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005429 conf->psk_identity_len = 0;
5430 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005431#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005432
5433#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005435#endif
5436
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005438}
5439
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005440#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005441 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005442/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005445unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005446{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5449 return MBEDTLS_SSL_SIG_RSA;
5450 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005451#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005452#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5454 return MBEDTLS_SSL_SIG_ECDSA;
5455 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005456#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005458}
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005461{
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005463 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005465 case MBEDTLS_PK_ECDSA:
5466 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005468 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005470 }
5471}
5472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005474{
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005476#if defined(MBEDTLS_RSA_C)
5477 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005479#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005480#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005483#endif
5484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005486 }
5487}
Valerio Settie9646ec2023-08-02 20:02:28 +02005488#endif /* MBEDTLS_PK_C &&
5489 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005490
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005491/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005492 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005495{
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005497#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005500#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005501#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005504#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005505#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005508#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005509#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005512#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005513#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005514 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005516#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005517#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005518 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005520#endif
5521 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005523 }
5524}
5525
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005526/*
5527 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005529unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005530{
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005532#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005533 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005535#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005536#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005537 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005539#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005540#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005541 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005543#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005544#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005545 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005547#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005548#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005549 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005551#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005552#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005553 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005555#endif
5556 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005558 }
5559}
5560
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005561/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005562 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005563 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005564 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005565int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005566{
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 if (group_list == NULL) {
5570 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005571 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005572
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 for (; *group_list != 0; group_list++) {
5574 if (*group_list == tls_id) {
5575 return 0;
5576 }
5577 }
5578
5579 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005580}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005581
Valerio Setti49e69072023-06-27 17:27:51 +02005582#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005583/*
5584 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005586int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005587{
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005589
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005591 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005593
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005595}
Valerio Setti49e69072023-06-27 17:27:51 +02005596#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005597
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598static const struct {
5599 uint16_t tls_id;
5600 mbedtls_ecp_group_id ecp_group_id;
5601 psa_ecc_family_t psa_family;
5602 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005603} tls_id_match_table[] =
5604{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005605#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005606 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005608#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005609 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005611#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005612 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005614#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005615 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005617#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005618 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005620#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005621 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005623#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005624 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005626#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005627 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005628#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005629#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005630 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005631#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005632#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005633 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005634#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005635#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005636 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005638#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005639 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005640#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005641#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005642 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005644 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005645};
5646
Gilles Peskine449bd832023-01-11 14:50:10 +01005647int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005648 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650{
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5652 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005653 if (type != NULL) {
5654 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
5656 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005657 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005659 return PSA_SUCCESS;
5660 }
5661 }
5662
5663 return PSA_ERROR_NOT_SUPPORTED;
5664}
5665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005667{
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5669 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005670 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005672 }
5673
5674 return MBEDTLS_ECP_DP_NONE;
5675}
5676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678{
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5680 i++) {
5681 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005684 }
5685
5686 return 0;
5687}
5688
Valerio Setti67419f02023-01-04 16:12:42 +01005689#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005690static const struct {
5691 uint16_t tls_id;
5692 const char *name;
5693} tls_id_curve_name_table[] =
5694{
Valerio Setti54e23792023-07-07 10:49:27 +02005695 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5696 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5697 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5698 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5699 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5700 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5701 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5702 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5703 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5704 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5705 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5706 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5707 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005708 { 0, NULL },
5709};
5710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005712{
Valerio Settiacd32c02023-06-29 18:06:29 +02005713 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5714 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5715 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005717 }
5718
5719 return NULL;
5720}
Valerio Setti67419f02023-01-04 16:12:42 +01005721#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005724int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5725 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5726 int cert_endpoint,
5727 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005728{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005729 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005730 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005731 const char *ext_oid;
5732 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005735 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 case MBEDTLS_KEY_EXCHANGE_RSA:
5738 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005739 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005740 break;
5741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005742 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5743 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5744 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5745 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005746 break;
5747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005748 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5749 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005750 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005751 break;
5752
5753 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005754 case MBEDTLS_KEY_EXCHANGE_NONE:
5755 case MBEDTLS_KEY_EXCHANGE_PSK:
5756 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5757 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005758 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005759 usage = 0;
5760 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005762 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5763 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005764 }
5765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005767 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005768 ret = -1;
5769 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005770
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5774 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005775 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005777 }
5778
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005780 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005781 ret = -1;
5782 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005783
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005785}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005787
Jerry Yu148165c2021-09-24 23:20:59 +08005788#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005789int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5790 const mbedtls_md_type_t md,
5791 unsigned char *dst,
5792 size_t dst_len,
5793 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005794{
Ronald Cronf6893e12022-01-07 22:09:01 +01005795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5796 psa_hash_operation_t *hash_operation_to_clone;
5797 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5798
Jerry Yu148165c2021-09-24 23:20:59 +08005799 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005800
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005802#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 case MBEDTLS_MD_SHA384:
5804 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5805 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005806#endif
5807
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005808#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 case MBEDTLS_MD_SHA256:
5810 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5811 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005812#endif
5813
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 default:
5815 goto exit;
5816 }
5817
5818 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5819 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005820 goto exit;
5821 }
5822
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5824 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005825 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005827
5828exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005829#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5830 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005831 (void) ssl;
5832#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005833 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005834}
5835#else /* MBEDTLS_USE_PSA_CRYPTO */
5836
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005837#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005838MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005839static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5840 unsigned char *dst,
5841 size_t dst_len,
5842 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005844 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005845 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (dst_len < 48) {
5848 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5849 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005850
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005851 mbedtls_md_init(&sha384);
5852 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005853 if (ret != 0) {
5854 goto exit;
5855 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005856 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005857 if (ret != 0) {
5858 goto exit;
5859 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005861 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005862 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005863 goto exit;
5864 }
5865
5866 *olen = 48;
5867
5868exit:
5869
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005870 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005872}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005873#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005874
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005875#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005876MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005877static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5878 unsigned char *dst,
5879 size_t dst_len,
5880 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005881{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005882 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005883 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (dst_len < 32) {
5886 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5887 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005888
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005889 mbedtls_md_init(&sha256);
5890 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5891 if (ret != 0) {
5892 goto exit;
5893 }
5894 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5895 if (ret != 0) {
5896 goto exit;
5897 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005898
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005899 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5900 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005901 goto exit;
5902 }
5903
5904 *olen = 32;
5905
5906exit:
5907
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005908 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005910}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005911#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5914 const mbedtls_md_type_t md,
5915 unsigned char *dst,
5916 size_t dst_len,
5917 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005918{
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005920
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005921#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 case MBEDTLS_MD_SHA384:
5923 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005924#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005925
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005926#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 case MBEDTLS_MD_SHA256:
5928 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005929#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005932#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5933 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 (void) ssl;
5935 (void) dst;
5936 (void) dst_len;
5937 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005938#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005940 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005942}
XiaokangQian647719a2021-12-07 09:16:29 +00005943
Jerry Yu148165c2021-09-24 23:20:59 +08005944#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005945
Ronald Crone68ab4f2022-10-05 12:46:29 +02005946#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005947/* mbedtls_ssl_parse_sig_alg_ext()
5948 *
5949 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5950 * value (TLS 1.3 RFC8446):
5951 * enum {
5952 * ....
5953 * ecdsa_secp256r1_sha256( 0x0403 ),
5954 * ecdsa_secp384r1_sha384( 0x0503 ),
5955 * ecdsa_secp521r1_sha512( 0x0603 ),
5956 * ....
5957 * } SignatureScheme;
5958 *
5959 * struct {
5960 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5961 * } SignatureSchemeList;
5962 *
5963 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5964 * value (TLS 1.2 RFC5246):
5965 * enum {
5966 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5967 * sha512(6), (255)
5968 * } HashAlgorithm;
5969 *
5970 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5971 * SignatureAlgorithm;
5972 *
5973 * struct {
5974 * HashAlgorithm hash;
5975 * SignatureAlgorithm signature;
5976 * } SignatureAndHashAlgorithm;
5977 *
5978 * SignatureAndHashAlgorithm
5979 * supported_signature_algorithms<2..2^16-2>;
5980 *
5981 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5982 * generalization of the TLS 1.2 signature algorithm extension.
5983 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5984 * `SignatureScheme` field of TLS 1.3
5985 *
5986 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005987int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5988 const unsigned char *buf,
5989 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005990{
5991 const unsigned char *p = buf;
5992 size_t supported_sig_algs_len = 0;
5993 const unsigned char *supported_sig_algs_end;
5994 uint16_t sig_alg;
5995 uint32_t common_idx = 0;
5996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5998 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005999 p += 2;
6000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 memset(ssl->handshake->received_sig_algs, 0,
6002 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006003
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006005 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 while (p < supported_sig_algs_end) {
6007 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6008 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006009 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6011 sig_alg,
6012 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6015 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6016 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006017 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006018 }
6019#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6022 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006025 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6026 common_idx += 1;
6027 }
6028 }
6029 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (p != end) {
6031 MBEDTLS_SSL_DEBUG_MSG(1,
6032 ("Signature algorithms extension length misaligned"));
6033 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6034 MBEDTLS_ERR_SSL_DECODE_ERROR);
6035 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006036 }
6037
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 if (common_idx == 0) {
6039 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6040 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6041 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6042 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006043 }
6044
Gabor Mezei15b95a62022-05-09 16:37:58 +02006045 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006047}
6048
Ronald Crone68ab4f2022-10-05 12:46:29 +02006049#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006050
Jerry Yudc7bd172022-02-17 13:44:15 +08006051#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6052
6053#if defined(MBEDTLS_USE_PSA_CRYPTO)
6054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6056 mbedtls_svc_key_id_t key,
6057 psa_algorithm_t alg,
6058 const unsigned char *raw_psk, size_t raw_psk_length,
6059 const unsigned char *seed, size_t seed_length,
6060 const unsigned char *label, size_t label_length,
6061 const unsigned char *other_secret,
6062 size_t other_secret_length,
6063 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006064{
6065 psa_status_t status;
6066
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 status = psa_key_derivation_setup(derivation, alg);
6068 if (status != PSA_SUCCESS) {
6069 return status;
6070 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6073 status = psa_key_derivation_input_bytes(derivation,
6074 PSA_KEY_DERIVATION_INPUT_SEED,
6075 seed, seed_length);
6076 if (status != PSA_SUCCESS) {
6077 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006078 }
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (other_secret != NULL) {
6081 status = psa_key_derivation_input_bytes(derivation,
6082 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6083 other_secret, other_secret_length);
6084 if (status != PSA_SUCCESS) {
6085 return status;
6086 }
6087 }
6088
6089 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006090 status = psa_key_derivation_input_bytes(
6091 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 raw_psk, raw_psk_length);
6093 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006094 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (status != PSA_SUCCESS) {
6098 return status;
6099 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 status = psa_key_derivation_input_bytes(derivation,
6102 PSA_KEY_DERIVATION_INPUT_LABEL,
6103 label, label_length);
6104 if (status != PSA_SUCCESS) {
6105 return status;
6106 }
6107 } else {
6108 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 }
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 status = psa_key_derivation_set_capacity(derivation, capacity);
6112 if (status != PSA_SUCCESS) {
6113 return status;
6114 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006117}
6118
Andrzej Kurek57d10632022-10-24 10:32:01 -04006119#if defined(PSA_WANT_ALG_SHA_384) || \
6120 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006121MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006122static int tls_prf_generic(mbedtls_md_type_t md_type,
6123 const unsigned char *secret, size_t slen,
6124 const char *label,
6125 const unsigned char *random, size_t rlen,
6126 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006127{
6128 psa_status_t status;
6129 psa_algorithm_t alg;
6130 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6131 psa_key_derivation_operation_t derivation =
6132 PSA_KEY_DERIVATION_OPERATION_INIT;
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006135 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006137 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006139
6140 /* Normally a "secret" should be long enough to be impossible to
6141 * find by brute force, and in particular should not be empty. But
6142 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6143 * and for this use case it makes sense to have a 0-length "secret".
6144 * Since the key API doesn't allow importing a key of length 0,
6145 * keep master_key=0, which setup_psa_key_derivation() understands
6146 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006148 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6150 psa_set_key_algorithm(&key_attributes, alg);
6151 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6154 if (status != PSA_SUCCESS) {
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6156 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006157 }
6158
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 status = setup_psa_key_derivation(&derivation,
6160 master_key, alg,
6161 NULL, 0,
6162 random, rlen,
6163 (unsigned char const *) label,
6164 (size_t) strlen(label),
6165 NULL, 0,
6166 dlen);
6167 if (status != PSA_SUCCESS) {
6168 psa_key_derivation_abort(&derivation);
6169 psa_destroy_key(master_key);
6170 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006171 }
6172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6174 if (status != PSA_SUCCESS) {
6175 psa_key_derivation_abort(&derivation);
6176 psa_destroy_key(master_key);
6177 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006178 }
6179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 status = psa_key_derivation_abort(&derivation);
6181 if (status != PSA_SUCCESS) {
6182 psa_destroy_key(master_key);
6183 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006184 }
6185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 if (!mbedtls_svc_key_id_is_null(master_key)) {
6187 status = psa_destroy_key(master_key);
6188 }
6189 if (status != PSA_SUCCESS) {
6190 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6191 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006194}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006195#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006196#else /* MBEDTLS_USE_PSA_CRYPTO */
6197
Andrzej Kurek57d10632022-10-24 10:32:01 -04006198#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006199 (defined(MBEDTLS_MD_CAN_SHA256) || \
6200 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006201MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006202static int tls_prf_generic(mbedtls_md_type_t md_type,
6203 const unsigned char *secret, size_t slen,
6204 const char *label,
6205 const unsigned char *random, size_t rlen,
6206 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006207{
6208 size_t nb;
6209 size_t i, j, k, md_len;
6210 unsigned char *tmp;
6211 size_t tmp_len = 0;
6212 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6213 const mbedtls_md_info_t *md_info;
6214 mbedtls_md_context_t md_ctx;
6215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6216
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6220 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6221 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006224
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 tmp_len = md_len + strlen(label) + rlen;
6226 tmp = mbedtls_calloc(1, tmp_len);
6227 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6229 goto exit;
6230 }
6231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 nb = strlen(label);
6233 memcpy(tmp + md_len, label, nb);
6234 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006235 nb += rlen;
6236
6237 /*
6238 * Compute P_<hash>(secret, label + random)[0..dlen]
6239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6245 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 }
6248 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6249 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 }
6252 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6253 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 for (i = 0; i < dlen; i += md_len) {
6258 ret = mbedtls_md_hmac_reset(&md_ctx);
6259 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 }
6262 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6263 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 }
6266 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6267 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len);
6276 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006277 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 }
6279 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6280 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006283
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006287 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006289 }
6290
6291exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 if (tmp != NULL) {
6295 mbedtls_platform_zeroize(tmp, tmp_len);
6296 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006303}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006304#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006305#endif /* MBEDTLS_USE_PSA_CRYPTO */
6306
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006307#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006309static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6310 const char *label,
6311 const unsigned char *random, size_t rlen,
6312 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006313{
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6315 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006316}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006317#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006318
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006319#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006321static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6322 const char *label,
6323 const unsigned char *random, size_t rlen,
6324 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006325{
Gilles Peskine449bd832023-01-11 14:50:10 +01006326 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6327 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006328}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006329#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006330
Jerry Yuf009d862022-02-17 14:01:37 +08006331/*
6332 * Set appropriate PRF function and other SSL / TLS1.2 functions
6333 *
6334 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006335 * - hash associated with the ciphersuite (only used by TLS 1.2)
6336 *
6337 * Outputs:
6338 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6339 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006340MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006341static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6342 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006343{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006344#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006346 handshake->tls_prf = tls_prf_sha384;
6347 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6348 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006350#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006351#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006352 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006353 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006354 handshake->tls_prf = tls_prf_sha256;
6355 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6356 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6357 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006358#else
Jerry Yuf009d862022-02-17 14:01:37 +08006359 {
Jerry Yuf009d862022-02-17 14:01:37 +08006360 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006361 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006363 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006364#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006367}
Jerry Yud6ab2352022-02-17 14:03:43 +08006368
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006369/*
6370 * Compute master secret if needed
6371 *
6372 * Parameters:
6373 * [in/out] handshake
6374 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6375 * (PSA-PSK) ciphersuite_info, psk_opaque
6376 * [out] premaster (cleared)
6377 * [out] master
6378 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6379 * debug: conf->f_dbg, conf->p_dbg
6380 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006381 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006382 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006383MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006384static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6385 unsigned char *master,
6386 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006387{
6388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6389
6390 /* cf. RFC 5246, Section 8.1:
6391 * "The master secret is always exactly 48 bytes in length." */
6392 size_t const master_secret_len = 48;
6393
6394#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6395 unsigned char session_hash[48];
6396#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6397
6398 /* The label for the KDF used for key expansion.
6399 * This is either "master secret" or "extended master secret"
6400 * depending on whether the Extended Master Secret extension
6401 * is used. */
6402 char const *lbl = "master secret";
6403
Przemek Stekielae4ed302022-04-05 17:15:55 +02006404 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 * - If the Extended Master Secret extension is not used,
6406 * this is ClientHello.Random + ServerHello.Random
6407 * (see Sect. 8.1 in RFC 5246).
6408 * - If the Extended Master Secret extension is used,
6409 * this is the transcript of the handshake so far.
6410 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006411 unsigned char const *seed = handshake->randbytes;
6412 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413
6414#if !defined(MBEDTLS_DEBUG_C) && \
6415 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6416 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418 ssl = NULL; /* make sure we don't use it except for those cases */
6419 (void) ssl;
6420#endif
6421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (handshake->resume != 0) {
6423 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6424 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425 }
6426
6427#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006430 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006431 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6432 if (ret != 0) {
6433 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6434 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6437 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006438 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006439#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006440
Przemek Stekiel99114f32022-04-22 11:20:09 +02006441#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006442 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006444 /* Perform PSK-to-MS expansion in a single step. */
6445 psa_status_t status;
6446 psa_algorithm_t alg;
6447 mbedtls_svc_key_id_t psk;
6448 psa_key_derivation_operation_t derivation =
6449 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006450 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006457 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006462 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006464
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006466 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006467 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006468 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006469 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006470 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006471 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006472 other_secret_len = 48;
6473 other_secret = handshake->premaster + 2;
6474 break;
6475 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006476 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006477 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6478 other_secret = handshake->premaster + 2;
6479 break;
6480 default:
6481 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006482 }
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 status = setup_psa_key_derivation(&derivation, psk, alg,
6485 ssl->conf->psk, ssl->conf->psk_len,
6486 seed, seed_len,
6487 (unsigned char const *) lbl,
6488 (size_t) strlen(lbl),
6489 other_secret, other_secret_len,
6490 master_secret_len);
6491 if (status != PSA_SUCCESS) {
6492 psa_key_derivation_abort(&derivation);
6493 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006494 }
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 status = psa_key_derivation_output_bytes(&derivation,
6497 master,
6498 master_secret_len);
6499 if (status != PSA_SUCCESS) {
6500 psa_key_derivation_abort(&derivation);
6501 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006502 }
6503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 status = psa_key_derivation_abort(&derivation);
6505 if (status != PSA_SUCCESS) {
6506 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6507 }
6508 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006509#endif
6510 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006511#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6513 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006514 psa_status_t status;
6515 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6516 psa_key_derivation_operation_t derivation =
6517 PSA_KEY_DERIVATION_OPERATION_INIT;
6518
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006520
6521 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 status = psa_key_derivation_setup(&derivation, alg);
6524 if (status != PSA_SUCCESS) {
6525 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006526 }
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 status = psa_key_derivation_set_capacity(&derivation,
6529 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6530 if (status != PSA_SUCCESS) {
6531 psa_key_derivation_abort(&derivation);
6532 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006533 }
6534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6536 &derivation);
6537 if (status != PSA_SUCCESS) {
6538 psa_key_derivation_abort(&derivation);
6539 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006540 }
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 status = psa_key_derivation_output_bytes(&derivation,
6543 handshake->premaster,
6544 handshake->pmslen);
6545 if (status != PSA_SUCCESS) {
6546 psa_key_derivation_abort(&derivation);
6547 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6548 }
6549
6550 status = psa_key_derivation_abort(&derivation);
6551 if (status != PSA_SUCCESS) {
6552 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006553 }
6554 }
6555#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6557 lbl, seed, seed_len,
6558 master,
6559 master_secret_len);
6560 if (ret != 0) {
6561 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6562 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006563 }
6564
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6566 handshake->premaster,
6567 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006568
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 mbedtls_platform_zeroize(handshake->premaster,
6570 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006571 }
6572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006574}
6575
Gilles Peskine449bd832023-01-11 14:50:10 +01006576int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006577{
6578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6579 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6580 ssl->handshake->ciphersuite_info;
6581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006583
6584 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006586 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (ret != 0) {
6588 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6589 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006590 }
6591
6592 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 ret = ssl_compute_master(ssl->handshake,
6594 ssl->session_negotiate->master,
6595 ssl);
6596 if (ret != 0) {
6597 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6598 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006599 }
6600
6601 /* Swap the client and server random values:
6602 * - MS derivation wanted client+server (RFC 5246 8.1)
6603 * - key derivation wants server+client (RFC 5246 6.3) */
6604 {
6605 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 memcpy(tmp, ssl->handshake->randbytes, 64);
6607 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6608 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6609 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006610 }
6611
6612 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006613 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6614 ssl->session_negotiate->ciphersuite,
6615 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006616#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006618#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 ssl->handshake->tls_prf,
6620 ssl->handshake->randbytes,
6621 ssl->tls_version,
6622 ssl->conf->endpoint,
6623 ssl);
6624 if (ret != 0) {
6625 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6626 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006627 }
6628
6629 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6631 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006632
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006636}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006639{
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006641#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006642 case MBEDTLS_SSL_HASH_SHA384:
6643 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6644 break;
6645#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006646#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006647 case MBEDTLS_SSL_HASH_SHA256:
6648 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6649 break;
6650#endif
6651 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006653 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006654#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6655 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006656 (void) ssl;
6657#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006659}
6660
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006661#if defined(MBEDTLS_USE_PSA_CRYPTO)
6662static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6663 const psa_hash_operation_t *hs_op,
6664 size_t buffer_size,
6665 unsigned char *hash,
6666 size_t *hlen)
6667{
6668 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006669 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006670
6671#if !defined(MBEDTLS_DEBUG_C)
6672 (void) ssl;
6673#endif
6674 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006675 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006676 if (status != PSA_SUCCESS) {
6677 goto exit;
6678 }
6679
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006680 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006681 if (status != PSA_SUCCESS) {
6682 goto exit;
6683 }
6684
6685 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6686 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6687
6688exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006689 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006690 return mbedtls_md_error_from_psa(status);
6691}
6692#else
6693static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6694 const mbedtls_md_context_t *hs_ctx,
6695 unsigned char *hash,
6696 size_t *hlen)
6697{
6698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006699 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006700
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006701 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006702
6703#if !defined(MBEDTLS_DEBUG_C)
6704 (void) ssl;
6705#endif
6706 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6707
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006708 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006709 if (ret != 0) {
6710 goto exit;
6711 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006712 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006713 if (ret != 0) {
6714 goto exit;
6715 }
6716
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006717 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006718 if (ret != 0) {
6719 goto exit;
6720 }
6721
6722 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6723
6724 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6725 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6726
6727exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006728 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006729 return ret;
6730}
6731#endif /* MBEDTLS_USE_PSA_CRYPTO */
6732
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006733#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006734int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6735 unsigned char *hash,
6736 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006737{
6738#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006739 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6740 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006741#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006742 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6743 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006744#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006745}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006746#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006747
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006748#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006749int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6750 unsigned char *hash,
6751 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006752{
6753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006754 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6755 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006756#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006757 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6758 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006759#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006760}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006761#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006762
Neil Armstrong80f6f322022-05-03 17:56:38 +02006763#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6764 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006765int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006766{
6767 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006769 const unsigned char *psk = NULL;
6770 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006772
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006774 /*
6775 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006776 * checked before calling this function.
6777 *
6778 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006779 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6782 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6783 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006784 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006785 }
6786
6787 /*
6788 * PMS = struct {
6789 * opaque other_secret<0..2^16-1>;
6790 * opaque psk<0..2^16-1>;
6791 * };
6792 * with "other_secret" depending on the particular key exchange
6793 */
6794#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6796 if (end - p < 2) {
6797 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6798 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006801 p += 2;
6802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 if (end < p || (size_t) (end - p) < psk_len) {
6804 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6805 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006808 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006810#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6811#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006813 /*
6814 * other_secret already set by the ClientKeyExchange message,
6815 * and is 48 bytes long
6816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 if (end - p < 2) {
6818 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6819 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006820
6821 *p++ = 0;
6822 *p++ = 48;
6823 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006825#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6826#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6829 size_t len;
6830
6831 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6833 p + 2, end - (p + 2), &len,
6834 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6835 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6836 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006839 p += 2 + len;
6840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6842 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006843#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006844#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6847 size_t zlen;
6848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6850 p + 2, end - (p + 2),
6851 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6852 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6853 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006854 }
6855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006857 p += 2 + zlen;
6858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6860 MBEDTLS_DEBUG_ECDH_Z);
6861 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006862#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006863 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6865 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006866 }
6867
6868 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 if (end - p < 2) {
6870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6871 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006874 p += 2;
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (end < p || (size_t) (end - p) < psk_len) {
6877 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6878 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006881 p += psk_len;
6882
6883 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006886}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006887#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006888
6889#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006890MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006891static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006892
6893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006894int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006895{
6896 /* If renegotiation is not enforced, retransmit until we would reach max
6897 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006899 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6900 unsigned char doublings = 1;
6901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006903 ++doublings;
6904 ratio >>= 1;
6905 }
6906
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 if (++ssl->renego_records_seen > doublings) {
6908 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6909 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006910 }
6911 }
6912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006914}
6915#endif
6916#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006917
Jerry Yud9526692022-02-17 14:23:47 +08006918/*
6919 * Handshake functions
6920 */
6921#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6922/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006923int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006924{
6925 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6926 ssl->handshake->ciphersuite_info;
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6931 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006932 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006934 }
6935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6937 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006938}
6939
Gilles Peskine449bd832023-01-11 14:50:10 +01006940int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006941{
6942 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6943 ssl->handshake->ciphersuite_info;
6944
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006946
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6948 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006949 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006951 }
6952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6954 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006955}
6956
6957#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6958/* Some certificate support -> implement write and parse */
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006961{
6962 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6963 size_t i, n;
6964 const mbedtls_x509_crt *crt;
6965 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6966 ssl->handshake->ciphersuite_info;
6967
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6971 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006972 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006974 }
6975
6976#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6978 if (ssl->handshake->client_auth == 0) {
6979 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006980 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006982 }
6983 }
6984#endif /* MBEDTLS_SSL_CLI_C */
6985#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6987 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006988 /* Should never happen because we shouldn't have picked the
6989 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006991 }
6992 }
6993#endif
6994
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006996
6997 /*
6998 * 0 . 0 handshake type
6999 * 1 . 3 handshake length
7000 * 4 . 6 length of all certs
7001 * 7 . 9 length of cert. 1
7002 * 10 . n-1 peer certificate
7003 * n . n+2 length of cert. 2
7004 * n+3 . ... upper level cert, etc.
7005 */
7006 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007010 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7012 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7013 " > %" MBEDTLS_PRINTF_SIZET,
7014 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7015 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007016 }
7017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7019 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7020 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007023 i += n; crt = crt->next;
7024 }
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7027 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7028 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007029
7030 ssl->out_msglen = i;
7031 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7032 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7033
7034 ssl->state++;
7035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7037 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7038 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007039 }
7040
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007044}
7045
7046#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7047
7048#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007049MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007050static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7051 unsigned char *crt_buf,
7052 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007053{
7054 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (peer_crt == NULL) {
7057 return -1;
7058 }
Jerry Yud9526692022-02-17 14:23:47 +08007059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (peer_crt->raw.len != crt_buf_len) {
7061 return -1;
7062 }
Jerry Yud9526692022-02-17 14:23:47 +08007063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007065}
7066#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007067MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007068static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7069 unsigned char *crt_buf,
7070 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007071{
7072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7073 unsigned char const * const peer_cert_digest =
7074 ssl->session->peer_cert_digest;
7075 mbedtls_md_type_t const peer_cert_digest_type =
7076 ssl->session->peer_cert_digest_type;
7077 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007079 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7080 size_t digest_len;
7081
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 if (peer_cert_digest == NULL || digest_info == NULL) {
7083 return -1;
7084 }
Jerry Yud9526692022-02-17 14:23:47 +08007085
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 digest_len = mbedtls_md_get_size(digest_info);
7087 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7088 return -1;
7089 }
Jerry Yud9526692022-02-17 14:23:47 +08007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7092 if (ret != 0) {
7093 return -1;
7094 }
Jerry Yud9526692022-02-17 14:23:47 +08007095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007097}
7098#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7099#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7100
7101/*
7102 * Once the certificate message is read, parse it into a cert chain and
7103 * perform basic checks, but leave actual verification to the caller
7104 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007106static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7107 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007108{
7109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7110#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007112#endif
7113 size_t i, n;
7114 uint8_t alert;
7115
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7117 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7118 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7119 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7120 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007121 }
7122
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7124 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7125 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7126 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007127 }
7128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7130 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7131 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7132 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7133 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007134 }
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007137
7138 /*
7139 * Same message structure as in mbedtls_ssl_write_certificate()
7140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 if (ssl->in_msg[i] != 0 ||
7144 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7145 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7146 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7147 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7148 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007149 }
7150
7151 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7152 i += 3;
7153
7154 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007156 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (i + 3 > ssl->in_hslen) {
7158 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7159 mbedtls_ssl_send_alert_message(ssl,
7160 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7161 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7162 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007163 }
7164 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7165 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 if (ssl->in_msg[i] != 0) {
7167 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7168 mbedtls_ssl_send_alert_message(ssl,
7169 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7170 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7171 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007172 }
7173
7174 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007176 | (unsigned int) ssl->in_msg[i + 2];
7177 i += 3;
7178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 if (n < 128 || i + n > ssl->in_hslen) {
7180 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7181 mbedtls_ssl_send_alert_message(ssl,
7182 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7183 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7184 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007185 }
7186
7187 /* Check if we're handling the first CRT in the chain. */
7188#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007190 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007192 /* During client-side renegotiation, check that the server's
7193 * end-CRTs hasn't changed compared to the initial handshake,
7194 * mitigating the triple handshake attack. On success, reuse
7195 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7197 if (ssl_check_peer_crt_unchanged(ssl,
7198 &ssl->in_msg[i],
7199 n) != 0) {
7200 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7201 mbedtls_ssl_send_alert_message(ssl,
7202 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7203 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7204 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007205 }
7206
7207 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007209 }
7210#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7211
7212 /* Parse the next certificate in the chain. */
7213#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007215#else
7216 /* If we don't need to store the CRT chain permanently, parse
7217 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007219#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007221 case 0: /*ok*/
7222 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7223 /* Ignore certificate with an unknown algorithm: maybe a
7224 prior certificate was already trusted. */
7225 break;
7226
7227 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7228 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7229 goto crt_parse_der_failed;
7230
7231 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7232 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7233 goto crt_parse_der_failed;
7234
7235 default:
7236 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237crt_parse_der_failed:
7238 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7239 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7240 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007241 }
7242
7243 i += n;
7244 }
7245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7247 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007248}
7249
7250#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007251MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007252static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007253{
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7255 return -1;
7256 }
Jerry Yud9526692022-02-17 14:23:47 +08007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007259 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7260 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7262 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7263 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007264 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007266}
7267#endif /* MBEDTLS_SSL_SRV_C */
7268
7269/* Check if a certificate message is expected.
7270 * Return either
7271 * - SSL_CERTIFICATE_EXPECTED, or
7272 * - SSL_CERTIFICATE_SKIP
7273 * indicating whether a Certificate message is expected or not.
7274 */
7275#define SSL_CERTIFICATE_EXPECTED 0
7276#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007278static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7279 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007280{
7281 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7282 ssl->handshake->ciphersuite_info;
7283
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7285 return SSL_CERTIFICATE_SKIP;
7286 }
Jerry Yud9526692022-02-17 14:23:47 +08007287
7288#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7290 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7291 return SSL_CERTIFICATE_SKIP;
7292 }
Jerry Yud9526692022-02-17 14:23:47 +08007293
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007295 ssl->session_negotiate->verify_result =
7296 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007298 }
7299 }
7300#else
7301 ((void) authmode);
7302#endif /* MBEDTLS_SSL_SRV_C */
7303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007305}
7306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007308static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7309 int authmode,
7310 mbedtls_x509_crt *chain,
7311 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007312{
7313 int ret = 0;
7314 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7315 ssl->handshake->ciphersuite_info;
7316 int have_ca_chain = 0;
7317
7318 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7319 void *p_vrfy;
7320
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7322 return 0;
7323 }
Jerry Yud9526692022-02-17 14:23:47 +08007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (ssl->f_vrfy != NULL) {
7326 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007327 f_vrfy = ssl->f_vrfy;
7328 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 } else {
7330 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007331 f_vrfy = ssl->conf->f_vrfy;
7332 p_vrfy = ssl->conf->p_vrfy;
7333 }
7334
7335 /*
7336 * Main check: verify certificate
7337 */
7338#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007340 ((void) rs_ctx);
7341 have_ca_chain = 1;
7342
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007344 ret = mbedtls_x509_crt_verify_with_ca_cb(
7345 chain,
7346 ssl->conf->f_ca_cb,
7347 ssl->conf->p_ca_cb,
7348 ssl->conf->cert_profile,
7349 ssl->hostname,
7350 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 f_vrfy, p_vrfy);
7352 } else
Jerry Yud9526692022-02-17 14:23:47 +08007353#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7354 {
7355 mbedtls_x509_crt *ca_chain;
7356 mbedtls_x509_crl *ca_crl;
7357
7358#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007360 ca_chain = ssl->handshake->sni_ca_chain;
7361 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 } else
Jerry Yud9526692022-02-17 14:23:47 +08007363#endif
7364 {
7365 ca_chain = ssl->conf->ca_chain;
7366 ca_crl = ssl->conf->ca_crl;
7367 }
7368
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007370 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 }
Jerry Yud9526692022-02-17 14:23:47 +08007372
7373 ret = mbedtls_x509_crt_verify_restartable(
7374 chain,
7375 ca_chain, ca_crl,
7376 ssl->conf->cert_profile,
7377 ssl->hostname,
7378 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007380 }
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (ret != 0) {
7383 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007384 }
7385
7386#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7388 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7389 }
Jerry Yud9526692022-02-17 14:23:47 +08007390#endif
7391
7392 /*
7393 * Secondary checks: always done, but change 'ret' only if it was 0
7394 */
7395
Valerio Settiacd32c02023-06-29 18:06:29 +02007396#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007397 {
7398 const mbedtls_pk_context *pk = &chain->pk;
7399
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007400 /* If certificate uses an EC key, make sure the curve is OK.
7401 * This is a public key, so it can't be opaque, so can_do() is a good
7402 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007404 /* and in the unlikely case the above assumption no longer holds
7405 * we are making sure that pk_ec() here does not return a NULL
7406 */
Valerio Settid0405092023-05-24 13:16:40 +02007407 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7408 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7409 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007411 }
Valerio Setti97207782023-05-18 18:59:06 +02007412 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007413 ssl->session_negotiate->verify_result |=
7414 MBEDTLS_X509_BADCERT_BAD_KEY;
7415
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7417 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007418 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007420 }
Jerry Yud9526692022-02-17 14:23:47 +08007421 }
7422 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007423#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (mbedtls_ssl_check_cert_usage(chain,
7426 ciphersuite_info,
7427 !ssl->conf->endpoint,
7428 &ssl->session_negotiate->verify_result) != 0) {
7429 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7430 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007431 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 }
Jerry Yud9526692022-02-17 14:23:47 +08007433 }
7434
7435 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7436 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7437 * with details encoded in the verification flags. All other kinds
7438 * of error codes, including those from the user provided f_vrfy
7439 * functions, are treated as fatal and lead to a failure of
7440 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7442 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7443 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007444 ret = 0;
7445 }
7446
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7448 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007449 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7450 }
7451
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007453 uint8_t alert;
7454
7455 /* The certificate may have been rejected for several reasons.
7456 Pick one and send the corresponding alert. Which alert to send
7457 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007459 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007461 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007463 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007465 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007467 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007469 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007471 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007473 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007475 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007477 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007479 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 }
7481 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7482 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007483 }
7484
7485#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (ssl->session_negotiate->verify_result != 0) {
7487 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7488 (unsigned int) ssl->session_negotiate->verify_result));
7489 } else {
7490 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007491 }
7492#endif /* MBEDTLS_DEBUG_C */
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007495}
7496
7497#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007498MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007499static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7500 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007501{
7502 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7503 /* Remember digest of the peer's end-CRT. */
7504 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7506 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7507 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7508 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7509 mbedtls_ssl_send_alert_message(ssl,
7510 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7511 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007514 }
7515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 ret = mbedtls_md(mbedtls_md_info_from_type(
7517 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7518 start, len,
7519 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007520
7521 ssl->session_negotiate->peer_cert_digest_type =
7522 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7523 ssl->session_negotiate->peer_cert_digest_len =
7524 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7525
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007527}
7528
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007529MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007530static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7531 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007532{
7533 unsigned char *end = start + len;
7534 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7535
7536 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7538 ret = mbedtls_pk_parse_subpubkey(&start, end,
7539 &ssl->handshake->peer_pubkey);
7540 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007541 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007543 }
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007546}
7547#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7548
Gilles Peskine449bd832023-01-11 14:50:10 +01007549int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007550{
7551 int ret = 0;
7552 int crt_expected;
7553#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7554 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7555 ? ssl->handshake->sni_authmode
7556 : ssl->conf->authmode;
7557#else
7558 const int authmode = ssl->conf->authmode;
7559#endif
7560 void *rs_ctx = NULL;
7561 mbedtls_x509_crt *chain = NULL;
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7566 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7567 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007568 goto exit;
7569 }
7570
7571#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if (ssl->handshake->ecrs_enabled &&
7573 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007574 chain = ssl->handshake->ecrs_peer_cert;
7575 ssl->handshake->ecrs_peer_cert = NULL;
7576 goto crt_verify;
7577 }
7578#endif
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007581 /* mbedtls_ssl_read_record may have sent an alert already. We
7582 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007584 goto exit;
7585 }
7586
7587#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007589 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007592 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 }
Jerry Yud9526692022-02-17 14:23:47 +08007594
7595 goto exit;
7596 }
7597#endif /* MBEDTLS_SSL_SRV_C */
7598
7599 /* Clear existing peer CRT structure in case we tried to
7600 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7604 if (chain == NULL) {
7605 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7606 sizeof(mbedtls_x509_crt)));
7607 mbedtls_ssl_send_alert_message(ssl,
7608 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7609 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007610
7611 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7612 goto exit;
7613 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 ret = ssl_parse_certificate_chain(ssl, chain);
7617 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007618 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 }
Jerry Yud9526692022-02-17 14:23:47 +08007620
7621#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 }
Jerry Yud9526692022-02-17 14:23:47 +08007625
7626crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007628 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 }
Jerry Yud9526692022-02-17 14:23:47 +08007630#endif
7631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 ret = ssl_parse_certificate_verify(ssl, authmode,
7633 chain, rs_ctx);
7634 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007635 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 }
Jerry Yud9526692022-02-17 14:23:47 +08007637
7638#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7639 {
7640 unsigned char *crt_start, *pk_start;
7641 size_t crt_len, pk_len;
7642
7643 /* We parse the CRT chain without copying, so
7644 * these pointers point into the input buffer,
7645 * and are hence still valid after freeing the
7646 * CRT chain. */
7647
7648 crt_start = chain->raw.p;
7649 crt_len = chain->raw.len;
7650
7651 pk_start = chain->pk_raw.p;
7652 pk_len = chain->pk_raw.len;
7653
7654 /* Free the CRT structures before computing
7655 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 mbedtls_x509_crt_free(chain);
7657 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007658 chain = NULL;
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7661 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007662 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 }
Jerry Yud9526692022-02-17 14:23:47 +08007664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7666 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007667 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 }
Jerry Yud9526692022-02-17 14:23:47 +08007669 }
7670#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7671 /* Pass ownership to session structure. */
7672 ssl->session_negotiate->peer_cert = chain;
7673 chain = NULL;
7674#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007677
7678exit:
7679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007681 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 }
Jerry Yud9526692022-02-17 14:23:47 +08007683
7684#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007686 ssl->handshake->ecrs_peer_cert = chain;
7687 chain = NULL;
7688 }
7689#endif
7690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (chain != NULL) {
7692 mbedtls_x509_crt_free(chain);
7693 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007694 }
7695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007697}
7698#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7699
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007700static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7701 unsigned char *padbuf, size_t hlen,
7702 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007703{
7704 int len = 12;
7705 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007706#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007707 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007708 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007709 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007710 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007711#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007712 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007713 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007714 mbedtls_md_context_t cloned_ctx;
7715 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007716#endif
7717
7718 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007720 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007724 ? "client finished"
7725 : "server finished";
7726
7727#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007728 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007729
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007730 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007732 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007733 }
7734
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007735 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007737 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007738 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007739 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007740#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007741 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007742
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007743 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007744 if (ret != 0) {
7745 goto exit;
7746 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007747 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007748 if (ret != 0) {
7749 goto exit;
7750 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007751
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007752 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007753 if (ret != 0) {
7754 goto exit;
7755 }
7756#endif /* MBEDTLS_USE_PSA_CRYPTO */
7757
7758 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7759
Jerry Yu615bd6f2022-02-17 14:25:15 +08007760 /*
7761 * TLSv1.2:
7762 * hash = PRF( master, finished_label,
7763 * Hash( handshake ) )[0.11]
7764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007766 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007769
Paul Elliottecb95be2023-08-11 16:41:04 +01007770 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007771
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007772 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007773
7774exit:
7775#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007776 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007777 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007778#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007779 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007780 return ret;
7781#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007782}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007783
7784#if defined(MBEDTLS_MD_CAN_SHA256)
7785static int ssl_calc_finished_tls_sha256(
7786 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7787{
7788 unsigned char padbuf[32];
7789 return ssl_calc_finished_tls_generic(ssl,
7790#if defined(MBEDTLS_USE_PSA_CRYPTO)
7791 &ssl->handshake->fin_sha256_psa,
7792#else
7793 &ssl->handshake->fin_sha256,
7794#endif
7795 padbuf, sizeof(padbuf),
7796 buf, from);
7797}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007798#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007799
Jerry Yub7ba49e2022-02-17 14:25:53 +08007800
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007801#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007802static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007804{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007805 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007806 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007808 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007809#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007810 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007811#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007812 padbuf, sizeof(padbuf),
7813 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007814}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007815#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007818{
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007820
7821 /*
7822 * Free our handshake params
7823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007824 mbedtls_ssl_handshake_free(ssl);
7825 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007826 ssl->handshake = NULL;
7827
7828 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007829 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 if (ssl->transform) {
7832 mbedtls_ssl_transform_free(ssl->transform);
7833 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007834 }
7835 ssl->transform = ssl->transform_negotiate;
7836 ssl->transform_negotiate = NULL;
7837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007839}
7840
Gilles Peskine449bd832023-01-11 14:50:10 +01007841void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007842{
7843 int resume = ssl->handshake->resume;
7844
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007846
7847#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007849 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7850 ssl->renego_records_seen = 0;
7851 }
7852#endif
7853
7854 /*
7855 * Free the previous session and switch in the current one
7856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007858#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7859 /* RFC 7366 3.1: keep the EtM state */
7860 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007862#endif
7863
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 mbedtls_ssl_session_free(ssl->session);
7865 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007866 }
7867 ssl->session = ssl->session_negotiate;
7868 ssl->session_negotiate = NULL;
7869
7870 /*
7871 * Add cache entry
7872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007874 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 resume == 0) {
7876 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7877 ssl->session->id,
7878 ssl->session->id_len,
7879 ssl->session) != 0) {
7880 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7881 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007882 }
7883
7884#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7886 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007887 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007889
7890 /* Keep last flight around in case we need to resend it:
7891 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7893 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007894#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007896
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007897 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007898
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007900}
7901
Gilles Peskine449bd832023-01-11 14:50:10 +01007902int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007903{
7904 int ret, hash_len;
7905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007907
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007909
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007910 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7911 if (ret != 0) {
7912 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7913 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007914
7915 /*
7916 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7917 * may define some other value. Currently (early 2016), no defined
7918 * ciphersuite does this (and this is unlikely to change as activity has
7919 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7920 */
7921 hash_len = 12;
7922
7923#if defined(MBEDTLS_SSL_RENEGOTIATION)
7924 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007926#endif
7927
7928 ssl->out_msglen = 4 + hash_len;
7929 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7930 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7931
7932 /*
7933 * In case of session resuming, invert the client and server
7934 * ChangeCipherSpec messages order.
7935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007937#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007939 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941#endif
7942#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007944 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007946#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007950
7951 /*
7952 * Switch to our negotiated transform and session parameters for outbound
7953 * data.
7954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007956
7957#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959 unsigned char i;
7960
7961 /* Remember current epoch settings for resending */
7962 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7964 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007965
7966 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007968
7969
7970 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 for (i = 2; i > 0; i--) {
7972 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 }
7975 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007976
7977 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 if (i == 0) {
7979 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7980 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007981 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007983#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007985
7986 ssl->transform_out = ssl->transform_negotiate;
7987 ssl->session_out = ssl->session_negotiate;
7988
7989#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7991 mbedtls_ssl_send_flight_completed(ssl);
7992 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007993#endif
7994
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7996 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7997 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007998 }
7999
8000#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8002 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8003 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8004 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008005 }
8006#endif
8007
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008011}
8012
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008013#define SSL_MAX_HASH_LEN 12
8014
Gilles Peskine449bd832023-01-11 14:50:10 +01008015int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008016{
8017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8018 unsigned int hash_len = 12;
8019 unsigned char buf[SSL_MAX_HASH_LEN];
8020
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008022
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008023 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8024 if (ret != 0) {
8025 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8026 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008027
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8029 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008030 goto exit;
8031 }
8032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8034 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8035 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8036 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008037 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8038 goto exit;
8039 }
8040
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8042 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8043 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008044 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8045 goto exit;
8046 }
8047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8049 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8050 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8051 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008052 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8053 goto exit;
8054 }
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8057 buf, hash_len) != 0) {
8058 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8059 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8060 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8062 goto exit;
8063 }
8064
8065#if defined(MBEDTLS_SSL_RENEGOTIATION)
8066 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008068#endif
8069
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008071#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008073 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075#endif
8076#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008078 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008080#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008082 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008084
8085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8087 mbedtls_ssl_recv_flight_completed(ssl);
8088 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089#endif
8090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008092
8093exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 mbedtls_platform_zeroize(buf, hash_len);
8095 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008096}
8097
Jerry Yu392112c2022-02-17 14:34:10 +08008098#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8099/*
8100 * Helper to get TLS 1.2 PRF from ciphersuite
8101 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008103static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008104{
Jerry Yu392112c2022-02-17 14:34:10 +08008105 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008107#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8109 return tls_prf_sha384;
8110 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008111#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008112#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008113 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8115 return tls_prf_sha256;
8116 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008117 }
8118#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008119#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8120 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008121 (void) ciphersuite_info;
8122#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008123
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008125}
8126#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008127
Gilles Peskine449bd832023-01-11 14:50:10 +01008128static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008129{
8130 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008131#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 if (tls_prf == tls_prf_sha384) {
8133 return MBEDTLS_SSL_TLS_PRF_SHA384;
8134 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008135#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008136#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 if (tls_prf == tls_prf_sha256) {
8138 return MBEDTLS_SSL_TLS_PRF_SHA256;
8139 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008140#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008142}
8143
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008144/*
8145 * Populate a transform structure with session keys and all the other
8146 * necessary information.
8147 *
8148 * Parameters:
8149 * - [in/out]: transform: structure to populate
8150 * [in] must be just initialised with mbedtls_ssl_transform_init()
8151 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8152 * - [in] ciphersuite
8153 * - [in] master
8154 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008155 * - [in] tls_prf: pointer to PRF to use for key derivation
8156 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008157 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008158 * - [in] endpoint: client or server
8159 * - [in] ssl: used for:
8160 * - ssl->conf->{f,p}_export_keys
8161 * [in] optionally used for:
8162 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8163 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008164MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008165static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8166 int ciphersuite,
8167 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008170#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 ssl_tls_prf_t tls_prf,
8172 const unsigned char randbytes[64],
8173 mbedtls_ssl_protocol_version tls_version,
8174 unsigned endpoint,
8175 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008176{
8177 int ret = 0;
8178 unsigned char keyblk[256];
8179 unsigned char *key1;
8180 unsigned char *key2;
8181 unsigned char *mac_enc;
8182 unsigned char *mac_dec;
8183 size_t mac_key_len = 0;
8184 size_t iv_copy_len;
8185 size_t keylen;
8186 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008187 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008188#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008189 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008190 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008191#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192
8193#if defined(MBEDTLS_USE_PSA_CRYPTO)
8194 psa_key_type_t key_type;
8195 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8196 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008197 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008198 size_t key_bits;
8199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8200#endif
8201
8202#if !defined(MBEDTLS_DEBUG_C) && \
8203 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008205 ssl = NULL; /* make sure we don't use it except for these cases */
8206 (void) ssl;
8207 }
8208#endif
8209
8210 /*
8211 * Some data just needs copying into the structure
8212 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008213#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008214 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008215#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008216 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008217
8218#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008219 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008220#endif
8221
8222#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8225 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008227 }
8228#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8229
8230 /*
8231 * Get various info structures
8232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8234 if (ciphersuite_info == NULL) {
8235 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8236 ciphersuite));
8237 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008238 }
8239
Neil Armstrongab555e02022-04-04 11:07:59 +02008240 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008241#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008243#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008247 transform->taglen =
8248 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008250
8251#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008252 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 transform->taglen,
8254 &alg,
8255 &key_type,
8256 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008257 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008259 goto end;
8260 }
8261#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008262 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 if (cipher_info == NULL) {
8264 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8265 ciphersuite_info->cipher));
8266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008268#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008269
Neil Armstronge4512952022-03-08 09:08:22 +01008270#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008271 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008273 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 (unsigned) ciphersuite_info->mac));
8275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008276 }
8277#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008278 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 if (md_info == NULL) {
8280 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8281 (unsigned) ciphersuite_info->mac));
8282 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008283 }
Neil Armstronge4512952022-03-08 09:08:22 +01008284#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008285
8286#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8287 /* Copy own and peer's CID if the use of the CID
8288 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8290 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008291
8292 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8294 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8295 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008296
8297 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8299 ssl->handshake->peer_cid_len);
8300 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8301 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008302 }
8303#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8304
8305 /*
8306 * Compute key block using the PRF
8307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8309 if (ret != 0) {
8310 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8311 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008312 }
8313
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8315 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8316 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8317 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8318 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008319
8320 /*
8321 * Determine the appropriate key, IV and MAC length.
8322 */
8323
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008324#if defined(MBEDTLS_USE_PSA_CRYPTO)
8325 keylen = PSA_BITS_TO_BYTES(key_bits);
8326#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008328#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008329
Valerio Settie5707042023-10-11 11:54:42 +02008330#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332 size_t explicit_ivlen;
8333
8334 transform->maclen = 0;
8335 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008336
8337 /* All modes haves 96-bit IVs, but the length of the static parts vary
8338 * with mode and version:
8339 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8340 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8341 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8342 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8343 * sequence number).
8344 */
8345 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008346
8347 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008348#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008350#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8352 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008353#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008354
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008356 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008358 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008360
8361 /* Minimum length of encrypted record */
8362 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8363 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 } else
Valerio Settie5707042023-10-11 11:54:42 +02008365#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008368 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008372#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008373 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008374#endif /* MBEDTLS_USE_PSA_CRYPTO */
8375
8376#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008377 /* Get MAC length */
8378 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8379#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008380 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8382 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8383 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008384 goto end;
8385 }
8386
8387 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008389#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390 transform->maclen = mac_key_len;
8391
8392 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008393#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008395#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008396 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398
8399 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008401 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008403 /*
8404 * GenericBlockCipher:
8405 * 1. if EtM is in use: one block plus MAC
8406 * otherwise: * first multiple of blocklen greater than maclen
8407 * 2. IV
8408 */
8409#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008411 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 + block_size;
8413 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008414#endif
8415 {
8416 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 + block_size
8418 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 }
8420
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008423 } else {
8424 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008425 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8426 goto end;
8427 }
8428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8431 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008432 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8433 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008434 }
8435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8437 (unsigned) keylen,
8438 (unsigned) transform->minlen,
8439 (unsigned) transform->ivlen,
8440 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008441
8442 /*
8443 * Finally setup the cipher contexts, IVs and MAC secrets.
8444 */
8445#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008447 key1 = keyblk + mac_key_len * 2;
8448 key2 = keyblk + mac_key_len * 2 + keylen;
8449
8450 mac_enc = keyblk;
8451 mac_dec = keyblk + mac_key_len;
8452
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 iv_copy_len = (transform->fixed_ivlen) ?
8454 transform->fixed_ivlen : transform->ivlen;
8455 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8456 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8457 iv_copy_len);
8458 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459#endif /* MBEDTLS_SSL_CLI_C */
8460#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462 key1 = keyblk + mac_key_len * 2 + keylen;
8463 key2 = keyblk + mac_key_len * 2;
8464
8465 mac_enc = keyblk + mac_key_len;
8466 mac_dec = keyblk;
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 iv_copy_len = (transform->fixed_ivlen) ?
8469 transform->fixed_ivlen : transform->ivlen;
8470 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8471 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8472 iv_copy_len);
8473 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474#endif /* MBEDTLS_SSL_SRV_C */
8475 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8478 goto end;
8479 }
8480
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 if (ssl != NULL && ssl->f_export_keys != NULL) {
8482 ssl->f_export_keys(ssl->p_export_keys,
8483 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8484 master, 48,
8485 randbytes + 32,
8486 randbytes,
8487 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488 }
8489
8490#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008491 transform->psa_alg = alg;
8492
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8494 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8495 psa_set_key_algorithm(&attributes, alg);
8496 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008497
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 if ((status = psa_import_key(&attributes,
8499 key1,
8500 PSA_BITS_TO_BYTES(key_bits),
8501 &transform->psa_key_enc)) != PSA_SUCCESS) {
8502 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008503 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505 goto end;
8506 }
8507
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008509
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 if ((status = psa_import_key(&attributes,
8511 key2,
8512 PSA_BITS_TO_BYTES(key_bits),
8513 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008514 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008516 goto end;
8517 }
8518 }
8519#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8521 cipher_info)) != 0) {
8522 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008523 goto end;
8524 }
8525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8527 cipher_info)) != 0) {
8528 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008529 goto end;
8530 }
8531
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8533 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8534 MBEDTLS_ENCRYPT)) != 0) {
8535 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008536 goto end;
8537 }
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8540 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8541 MBEDTLS_DECRYPT)) != 0) {
8542 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008543 goto end;
8544 }
8545
8546#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8548 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8549 MBEDTLS_PADDING_NONE)) != 0) {
8550 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008551 goto end;
8552 }
8553
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8555 MBEDTLS_PADDING_NONE)) != 0) {
8556 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008557 goto end;
8558 }
8559 }
8560#endif /* MBEDTLS_CIPHER_MODE_CBC */
8561#endif /* MBEDTLS_USE_PSA_CRYPTO */
8562
Neil Armstrong29c0c042022-03-17 17:47:28 +01008563#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8564 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8565 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008567#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008569
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8571 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8572 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008573
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 if ((status = psa_import_key(&attributes,
8575 mac_enc, mac_key_len,
8576 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008577 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008579 goto end;
8580 }
8581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8583 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008584#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008588 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8590 PSA_KEY_USAGE_VERIFY_HASH);
8591 } else {
8592 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8593 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008594
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 if ((status = psa_import_key(&attributes,
8596 mac_dec, mac_key_len,
8597 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008598 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008600 goto end;
8601 }
8602#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8604 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008605 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 }
8607 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8608 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008609 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008611#endif /* MBEDTLS_USE_PSA_CRYPTO */
8612 }
8613#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8614
8615 ((void) mac_dec);
8616 ((void) mac_enc);
8617
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008618end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8620 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008621}
8622
Valerio Settia08b1a42022-11-17 15:10:02 +01008623#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8624 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008625int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 psa_pake_operation_t *pake_ctx,
8627 const unsigned char *buf,
8628 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008629{
8630 psa_status_t status;
8631 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008632 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008633 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8634 * At round two perform a single cycle
8635 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008636 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008637
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 for (; remaining_steps > 0; remaining_steps--) {
8639 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008640 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008642 /* Length is stored at the first byte */
8643 size_t length = buf[input_offset];
8644 input_offset += 1;
8645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008647 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8648 }
8649
Gilles Peskine449bd832023-01-11 14:50:10 +01008650 status = psa_pake_input(pake_ctx, step,
8651 buf + input_offset, length);
8652 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008653 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008654 }
8655
8656 input_offset += length;
8657 }
8658 }
8659
Gilles Peskine449bd832023-01-11 14:50:10 +01008660 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008661 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008663
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008665}
8666
Valerio Setti6b3dab02022-11-17 17:14:54 +01008667int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 psa_pake_operation_t *pake_ctx,
8669 unsigned char *buf,
8670 size_t len, size_t *olen,
8671 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008672{
8673 psa_status_t status;
8674 size_t output_offset = 0;
8675 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008676 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008677 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8678 * At round two perform a single cycle
8679 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008681
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 for (; remaining_steps > 0; remaining_steps--) {
8683 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8684 step <= PSA_PAKE_STEP_ZK_PROOF;
8685 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008686 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008687 * For each step, prepend 1 byte with the length of the data as
8688 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008689 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 status = psa_pake_output(pake_ctx, step,
8691 buf + output_offset + 1,
8692 len - output_offset - 1,
8693 &output_len);
8694 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008695 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008696 }
8697
Valerio Setti99d88c12022-11-22 16:03:43 +01008698 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008699
8700 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008701 }
8702 }
8703
8704 *olen = output_offset;
8705
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008707}
Valerio Settia08b1a42022-11-17 15:10:02 +01008708#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8709
Jerry Yuee40f9d2022-02-17 14:55:16 +08008710#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008711int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8712 unsigned char *hash, size_t *hashlen,
8713 unsigned char *data, size_t data_len,
8714 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008715{
8716 psa_status_t status;
8717 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008718 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008719
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008721
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 if ((status = psa_hash_setup(&hash_operation,
8723 hash_alg)) != PSA_SUCCESS) {
8724 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008725 goto exit;
8726 }
8727
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8729 64)) != PSA_SUCCESS) {
8730 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008731 goto exit;
8732 }
8733
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 if ((status = psa_hash_update(&hash_operation,
8735 data, data_len)) != PSA_SUCCESS) {
8736 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008737 goto exit;
8738 }
8739
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8741 hashlen)) != PSA_SUCCESS) {
8742 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8743 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008744 }
8745
8746exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if (status != PSA_SUCCESS) {
8748 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8749 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8750 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008751 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008753 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8754 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008756 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008758 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760 }
8761 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763}
8764
8765#else
8766
Gilles Peskine449bd832023-01-11 14:50:10 +01008767int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8768 unsigned char *hash, size_t *hashlen,
8769 unsigned char *data, size_t data_len,
8770 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771{
8772 int ret = 0;
8773 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8775 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008778
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008780
8781 /*
8782 * digitally-signed struct {
8783 * opaque client_random[32];
8784 * opaque server_random[32];
8785 * ServerDHParams params;
8786 * };
8787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8789 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008790 goto exit;
8791 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008792 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8793 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008794 goto exit;
8795 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8797 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 goto exit;
8799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8801 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008802 goto exit;
8803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8805 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008806 goto exit;
8807 }
8808
8809exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008811
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 if (ret != 0) {
8813 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8814 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8815 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818}
8819#endif /* MBEDTLS_USE_PSA_CRYPTO */
8820
Jerry Yud9d91da2022-02-17 14:57:06 +08008821#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8822
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008823/* Find the preferred hash for a given signature algorithm. */
8824unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 mbedtls_ssl_context *ssl,
8826 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008827{
Gabor Mezei078e8032022-04-27 21:17:56 +02008828 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008829 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008830
Gilles Peskine449bd832023-01-11 14:50:10 +01008831 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8832 return MBEDTLS_SSL_HASH_NONE;
8833 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008836 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8838 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008839 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008840 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8841 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008842
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008843 mbedtls_md_type_t md_alg =
8844 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8845 if (md_alg == MBEDTLS_MD_NONE) {
8846 continue;
8847 }
8848
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008850#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008852 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008853 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008854
Gilles Peskine449bd832023-01-11 14:50:10 +01008855 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8856 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8857 PSA_ALG_ECDSA(psa_hash_alg),
8858 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008859 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008861
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8863 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8864 PSA_ALG_RSA_PKCS1V15_SIGN(
8865 psa_hash_alg),
8866 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008867 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008869 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008870#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008871
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008873 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008874 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008875
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008877}
8878
8879#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8880
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008881/* Serialization of TLS 1.2 sessions:
8882 *
8883 * struct {
8884 * uint64 start_time;
8885 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008886 * uint8 session_id_len; // at most 32
8887 * opaque session_id[32];
8888 * opaque master[48]; // fixed length in the standard
8889 * uint32 verify_result;
8890 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8891 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8892 * uint32 ticket_lifetime;
8893 * uint8 mfl_code; // up to 255 according to standard
8894 * uint8 encrypt_then_mac; // 0 or 1
8895 * } serialized_session_tls12;
8896 *
8897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008898static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8899 unsigned char *buf,
8900 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008901{
8902 unsigned char *p = buf;
8903 size_t used = 0;
8904
8905#if defined(MBEDTLS_HAVE_TIME)
8906 uint64_t start;
8907#endif
8908#if defined(MBEDTLS_X509_CRT_PARSE_C)
8909#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8910 size_t cert_len;
8911#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8912#endif /* MBEDTLS_X509_CRT_PARSE_C */
8913
8914 /*
8915 * Time
8916 */
8917#if defined(MBEDTLS_HAVE_TIME)
8918 used += 8;
8919
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921 start = (uint64_t) session->start;
8922
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008924 p += 8;
8925 }
8926#endif /* MBEDTLS_HAVE_TIME */
8927
8928 /*
8929 * Basic mandatory fields
8930 */
8931 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 + 1 /* id_len */
8933 + sizeof(session->id)
8934 + sizeof(session->master)
8935 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008936
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 if (used <= buf_len) {
8938 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008939 p += 2;
8940
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 *p++ = MBEDTLS_BYTE_0(session->id_len);
8942 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943 p += 32;
8944
Gilles Peskine449bd832023-01-11 14:50:10 +01008945 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008946 p += 48;
8947
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008949 p += 4;
8950 }
8951
8952 /*
8953 * Peer's end-entity certificate
8954 */
8955#if defined(MBEDTLS_X509_CRT_PARSE_C)
8956#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008958 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008960 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008962
8963 used += 3 + cert_len;
8964
Gilles Peskine449bd832023-01-11 14:50:10 +01008965 if (used <= buf_len) {
8966 *p++ = MBEDTLS_BYTE_2(cert_len);
8967 *p++ = MBEDTLS_BYTE_1(cert_len);
8968 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969
Gilles Peskine449bd832023-01-11 14:50:10 +01008970 if (session->peer_cert != NULL) {
8971 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008972 p += cert_len;
8973 }
8974 }
8975#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008979 *p++ = (unsigned char) session->peer_cert_digest_type;
8980 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 memcpy(p, session->peer_cert_digest,
8982 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008983 p += session->peer_cert_digest_len;
8984 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008986 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8989 *p++ = 0;
8990 }
8991 }
8992#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8993#endif /* MBEDTLS_X509_CRT_PARSE_C */
8994
8995 /*
8996 * Session ticket if any, plus associated data
8997 */
8998#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8999 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9000
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 if (used <= buf_len) {
9002 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9003 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9004 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009005
Gilles Peskine449bd832023-01-11 14:50:10 +01009006 if (session->ticket != NULL) {
9007 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009008 p += session->ticket_len;
9009 }
9010
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009012 p += 4;
9013 }
9014#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9015
9016 /*
9017 * Misc extension-related info
9018 */
9019#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9020 used += 1;
9021
Gilles Peskine449bd832023-01-11 14:50:10 +01009022 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009025#endif
9026
9027#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9028 used += 1;
9029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (used <= buf_len) {
9031 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9032 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009033#endif
9034
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009036}
9037
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009038MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009039static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9040 const unsigned char *buf,
9041 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042{
9043#if defined(MBEDTLS_HAVE_TIME)
9044 uint64_t start;
9045#endif
9046#if defined(MBEDTLS_X509_CRT_PARSE_C)
9047#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9048 size_t cert_len;
9049#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9050#endif /* MBEDTLS_X509_CRT_PARSE_C */
9051
9052 const unsigned char *p = buf;
9053 const unsigned char * const end = buf + len;
9054
9055 /*
9056 * Time
9057 */
9058#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 if (8 > (size_t) (end - p)) {
9060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9061 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009062
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009063 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 p += 8;
9065
9066 session->start = (time_t) start;
9067#endif /* MBEDTLS_HAVE_TIME */
9068
9069 /*
9070 * Basic mandatory fields
9071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009072 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9074 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077 p += 2;
9078
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009079 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081 p += 32;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084 p += 48;
9085
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009086 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009087 p += 4;
9088
9089 /* Immediately clear invalid pointer values that have been read, in case
9090 * we exit early before we replaced them with valid ones. */
9091#if defined(MBEDTLS_X509_CRT_PARSE_C)
9092#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9093 session->peer_cert = NULL;
9094#else
9095 session->peer_cert_digest = NULL;
9096#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9097#endif /* MBEDTLS_X509_CRT_PARSE_C */
9098#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9099 session->ticket = NULL;
9100#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9101
9102 /*
9103 * Peer certificate
9104 */
9105#if defined(MBEDTLS_X509_CRT_PARSE_C)
9106#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9107 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 if (3 > (size_t) (end - p)) {
9109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9110 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009111
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009113 p += 3;
9114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9117
Gilles Peskine449bd832023-01-11 14:50:10 +01009118 if (cert_len > (size_t) (end - p)) {
9119 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9120 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009121
Gilles Peskine449bd832023-01-11 14:50:10 +01009122 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
Gilles Peskine449bd832023-01-11 14:50:10 +01009124 if (session->peer_cert == NULL) {
9125 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9126 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9131 p, cert_len)) != 0) {
9132 mbedtls_x509_crt_free(session->peer_cert);
9133 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009134 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136 }
9137
9138 p += cert_len;
9139 }
9140#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9141 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009142 if (2 > (size_t) (end - p)) {
9143 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9144 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009145
9146 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9147 session->peer_cert_digest_len = (size_t) *p++;
9148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009150 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009151 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9152 if (md_info == NULL) {
9153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9154 }
9155 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9156 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9157 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009158
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9160 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9161 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009162
9163 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009164 mbedtls_calloc(1, session->peer_cert_digest_len);
9165 if (session->peer_cert_digest == NULL) {
9166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9167 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 memcpy(session->peer_cert_digest, p,
9170 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171 p += session->peer_cert_digest_len;
9172 }
9173#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9174#endif /* MBEDTLS_X509_CRT_PARSE_C */
9175
9176 /*
9177 * Session ticket and associated data
9178 */
9179#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009180 if (3 > (size_t) (end - p)) {
9181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9182 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009185 p += 3;
9186
Gilles Peskine449bd832023-01-11 14:50:10 +01009187 if (session->ticket_len != 0) {
9188 if (session->ticket_len > (size_t) (end - p)) {
9189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9190 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 session->ticket = mbedtls_calloc(1, session->ticket_len);
9193 if (session->ticket == NULL) {
9194 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9195 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009198 p += session->ticket_len;
9199 }
9200
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 if (4 > (size_t) (end - p)) {
9202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9203 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009205 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206 p += 4;
9207#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9208
9209 /*
9210 * Misc extension-related info
9211 */
9212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 if (1 > (size_t) (end - p)) {
9214 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9215 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009216
9217 session->mfl_code = *p++;
9218#endif
9219
9220#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 if (1 > (size_t) (end - p)) {
9222 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9223 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224
9225 session->encrypt_then_mac = *p++;
9226#endif
9227
9228 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 if (p != end) {
9230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9231 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009232
Gilles Peskine449bd832023-01-11 14:50:10 +01009233 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009234}
Jerry Yudc7bd172022-02-17 13:44:15 +08009235#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9236
XiaokangQian75d40ef2022-04-20 11:05:24 +00009237int mbedtls_ssl_validate_ciphersuite(
9238 const mbedtls_ssl_context *ssl,
9239 const mbedtls_ssl_ciphersuite_t *suite_info,
9240 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009242{
9243 (void) ssl;
9244
Gilles Peskine449bd832023-01-11 14:50:10 +01009245 if (suite_info == NULL) {
9246 return -1;
9247 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009248
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 if ((suite_info->min_tls_version > max_tls_version) ||
9250 (suite_info->max_tls_version < min_tls_version)) {
9251 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009252 }
9253
XiaokangQian060d8672022-04-21 09:24:56 +00009254#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009255#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009256#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9258 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009259#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9261 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009262#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009263 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009265 }
9266#endif
9267
9268 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9269#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009270 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9271 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9272 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009273 }
9274#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9275#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9276
Gilles Peskine449bd832023-01-11 14:50:10 +01009277 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009278}
9279
Ronald Crone68ab4f2022-10-05 12:46:29 +02009280#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009281/*
9282 * Function for writing a signature algorithm extension.
9283 *
9284 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9285 * value (TLS 1.3 RFC8446):
9286 * enum {
9287 * ....
9288 * ecdsa_secp256r1_sha256( 0x0403 ),
9289 * ecdsa_secp384r1_sha384( 0x0503 ),
9290 * ecdsa_secp521r1_sha512( 0x0603 ),
9291 * ....
9292 * } SignatureScheme;
9293 *
9294 * struct {
9295 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9296 * } SignatureSchemeList;
9297 *
9298 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9299 * value (TLS 1.2 RFC5246):
9300 * enum {
9301 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9302 * sha512(6), (255)
9303 * } HashAlgorithm;
9304 *
9305 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9306 * SignatureAlgorithm;
9307 *
9308 * struct {
9309 * HashAlgorithm hash;
9310 * SignatureAlgorithm signature;
9311 * } SignatureAndHashAlgorithm;
9312 *
9313 * SignatureAndHashAlgorithm
9314 * supported_signature_algorithms<2..2^16-2>;
9315 *
9316 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9317 * generalization of the TLS 1.2 signature algorithm extension.
9318 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9319 * `SignatureScheme` field of TLS 1.3
9320 *
9321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009322int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9323 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009324{
9325 unsigned char *p = buf;
9326 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9327 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9328
9329 *out_len = 0;
9330
Gilles Peskine449bd832023-01-11 14:50:10 +01009331 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009332
9333 /* Check if we have space for header and length field:
9334 * - extension_type (2 bytes)
9335 * - extension_data_length (2 bytes)
9336 * - supported_signature_algorithms_length (2 bytes)
9337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009338 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009339 p += 6;
9340
9341 /*
9342 * Write supported_signature_algorithms
9343 */
9344 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9346 if (sig_alg == NULL) {
9347 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9348 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009349
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9351 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9352 *sig_alg,
9353 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9354 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009355 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009356 }
9357 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9358 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009359 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009360 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9361 *sig_alg,
9362 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009363 }
9364
9365 /* Length of supported_signature_algorithms */
9366 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 if (supported_sig_alg_len == 0) {
9368 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9369 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009370 }
9371
Gilles Peskine449bd832023-01-11 14:50:10 +01009372 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9373 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9374 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009375
XiaokangQianeaf36512022-04-24 09:07:44 +00009376 *out_len = p - buf;
9377
9378#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009380#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009381
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009383}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009384#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009385
XiaokangQian40a35232022-05-07 09:02:40 +00009386#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009387/*
9388 * mbedtls_ssl_parse_server_name_ext
9389 *
9390 * Structure of server_name extension:
9391 *
9392 * enum {
9393 * host_name(0), (255)
9394 * } NameType;
9395 * opaque HostName<1..2^16-1>;
9396 *
9397 * struct {
9398 * NameType name_type;
9399 * select (name_type) {
9400 * case host_name: HostName;
9401 * } name;
9402 * } ServerName;
9403 * struct {
9404 * ServerName server_name_list<1..2^16-1>
9405 * } ServerNameList;
9406 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009407MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009408int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9409 const unsigned char *buf,
9410 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009411{
9412 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9413 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009414 size_t server_name_list_len, hostname_len;
9415 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009416
Gilles Peskine449bd832023-01-11 14:50:10 +01009417 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009418
Gilles Peskine449bd832023-01-11 14:50:10 +01009419 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9420 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009421 p += 2;
9422
Gilles Peskine449bd832023-01-11 14:50:10 +01009423 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009424 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 while (p < server_name_list_end) {
9426 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9427 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9428 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9429 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009430
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009432 /* sni_name is intended to be used only during the parsing of the
9433 * ClientHello message (it is reset to NULL before the end of
9434 * the message parsing). Thus it is ok to just point to the
9435 * reception buffer and not make a copy of it.
9436 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009437 ssl->handshake->sni_name = p + 3;
9438 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 if (ssl->conf->f_sni == NULL) {
9440 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009441 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9443 ssl, p + 3, hostname_len);
9444 if (ret != 0) {
9445 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9446 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9447 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9448 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9449 }
9450 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009451 }
9452
9453 p += hostname_len + 3;
9454 }
9455
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009457}
9458#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9459
XiaokangQianacb39922022-06-17 10:18:48 +00009460#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009461MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009462int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9463 const unsigned char *buf,
9464 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009465{
9466 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009467 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009468 const unsigned char *protocol_name_list;
9469 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009470 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009471
9472 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009473 if (ssl->conf->alpn_list == NULL) {
9474 return 0;
9475 }
XiaokangQianacb39922022-06-17 10:18:48 +00009476
9477 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009478 * RFC7301, section 3.1
9479 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009480 *
XiaokangQianc7403452022-06-23 03:24:12 +00009481 * struct {
9482 * ProtocolName protocol_name_list<2..2^16-1>
9483 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009484 */
9485
XiaokangQianc7403452022-06-23 03:24:12 +00009486 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009487 * protocol_name_list_len 2 bytes
9488 * protocol_name_len 1 bytes
9489 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009492
Gilles Peskine449bd832023-01-11 14:50:10 +01009493 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009494 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009495 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009496 protocol_name_list = p;
9497 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009498
9499 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009500 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009501 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9503 protocol_name_len);
9504 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009505 MBEDTLS_SSL_PEND_FATAL_ALERT(
9506 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009507 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9508 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009509 }
9510
9511 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009512 }
9513
9514 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9516 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009517 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009519 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 if (protocol_name_len == alpn_len &&
9521 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009522 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009524 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009525
9526 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009527 }
9528 }
9529
XiaokangQian95d5f542022-06-24 02:29:26 +00009530 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009531 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009532 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9533 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9534 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009535}
9536
Gilles Peskine449bd832023-01-11 14:50:10 +01009537int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9538 unsigned char *buf,
9539 unsigned char *end,
9540 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009541{
9542 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009543 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009544 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009545
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 if (ssl->alpn_chosen == NULL) {
9547 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009548 }
9549
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 protocol_name_len = strlen(ssl->alpn_chosen);
9551 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009552
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009554 /*
9555 * 0 . 1 ext identifier
9556 * 2 . 3 ext length
9557 * 4 . 5 protocol list length
9558 * 6 . 6 protocol name length
9559 * 7 . 7+n protocol name
9560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009562
XiaokangQian95d5f542022-06-24 02:29:26 +00009563 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009564
Gilles Peskine449bd832023-01-11 14:50:10 +01009565 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9566 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009567 /* Note: the length of the chosen protocol has been checked to be less
9568 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9569 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009570 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009571
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009573
9574#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009576#endif
9577
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009579}
9580#endif /* MBEDTLS_SSL_ALPN */
9581
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009582#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009583 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009584 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009585 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009586int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9587 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009588{
9589 /* Initialize to suppress unnecessary compiler warning */
9590 size_t hostname_len = 0;
9591
9592 /* Check if new hostname is valid before
9593 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 if (hostname != NULL) {
9595 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009596
Gilles Peskine449bd832023-01-11 14:50:10 +01009597 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9598 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9599 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009600 }
9601
9602 /* Now it's clear that we will overwrite the old hostname,
9603 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009604 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009605 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009607 }
9608
9609 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009611 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 } else {
9613 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9614 if (session->hostname == NULL) {
9615 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9616 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009617
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009619 }
9620
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009622}
Xiaokang Qian03409292022-10-12 02:49:52 +00009623#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9624 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009625 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009626 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009628#endif /* MBEDTLS_SSL_TLS_C */