blob: 2632574a716da4be54fbc1ed0ca6ee7c2edeb30b [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{
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002701#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002702 case MBEDTLS_CIPHER_AES_128_CBC:
2703 *alg = PSA_ALG_CBC_NO_PADDING;
2704 *key_type = PSA_KEY_TYPE_AES;
2705 *key_size = 128;
2706 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002707#endif
2708#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002709 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002711 *key_type = PSA_KEY_TYPE_AES;
2712 *key_size = 128;
2713 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002714#endif
2715#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002716 case MBEDTLS_CIPHER_AES_128_GCM:
2717 *alg = PSA_ALG_GCM;
2718 *key_type = PSA_KEY_TYPE_AES;
2719 *key_size = 128;
2720 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002721#endif
2722#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002723 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002725 *key_type = PSA_KEY_TYPE_AES;
2726 *key_size = 192;
2727 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002728#endif
2729#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730 case MBEDTLS_CIPHER_AES_192_GCM:
2731 *alg = PSA_ALG_GCM;
2732 *key_type = PSA_KEY_TYPE_AES;
2733 *key_size = 192;
2734 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002735#endif
2736#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002737 case MBEDTLS_CIPHER_AES_256_CBC:
2738 *alg = PSA_ALG_CBC_NO_PADDING;
2739 *key_type = PSA_KEY_TYPE_AES;
2740 *key_size = 256;
2741 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002742#endif
2743#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002744 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002746 *key_type = PSA_KEY_TYPE_AES;
2747 *key_size = 256;
2748 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002749#endif
2750#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 case MBEDTLS_CIPHER_AES_256_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_AES;
2754 *key_size = 256;
2755 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002756#endif
2757#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002758 case MBEDTLS_CIPHER_ARIA_128_CBC:
2759 *alg = PSA_ALG_CBC_NO_PADDING;
2760 *key_type = PSA_KEY_TYPE_ARIA;
2761 *key_size = 128;
2762 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002763#endif
2764#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002765 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002767 *key_type = PSA_KEY_TYPE_ARIA;
2768 *key_size = 128;
2769 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002770#endif
2771#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002772 case MBEDTLS_CIPHER_ARIA_128_GCM:
2773 *alg = PSA_ALG_GCM;
2774 *key_type = PSA_KEY_TYPE_ARIA;
2775 *key_size = 128;
2776 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002777#endif
2778#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002779 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002781 *key_type = PSA_KEY_TYPE_ARIA;
2782 *key_size = 192;
2783 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002784#endif
2785#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002786 case MBEDTLS_CIPHER_ARIA_192_GCM:
2787 *alg = PSA_ALG_GCM;
2788 *key_type = PSA_KEY_TYPE_ARIA;
2789 *key_size = 192;
2790 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002791#endif
2792#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002793 case MBEDTLS_CIPHER_ARIA_256_CBC:
2794 *alg = PSA_ALG_CBC_NO_PADDING;
2795 *key_type = PSA_KEY_TYPE_ARIA;
2796 *key_size = 256;
2797 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002798#endif
2799#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002802 *key_type = PSA_KEY_TYPE_ARIA;
2803 *key_size = 256;
2804 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002805#endif
2806#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002807 case MBEDTLS_CIPHER_ARIA_256_GCM:
2808 *alg = PSA_ALG_GCM;
2809 *key_type = PSA_KEY_TYPE_ARIA;
2810 *key_size = 256;
2811 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002812#endif
2813#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002814 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2815 *alg = PSA_ALG_CBC_NO_PADDING;
2816 *key_type = PSA_KEY_TYPE_CAMELLIA;
2817 *key_size = 128;
2818 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002819#endif
2820#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002821 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002823 *key_type = PSA_KEY_TYPE_CAMELLIA;
2824 *key_size = 128;
2825 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002826#endif
2827#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002828 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2829 *alg = PSA_ALG_GCM;
2830 *key_type = PSA_KEY_TYPE_CAMELLIA;
2831 *key_size = 128;
2832 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002833#endif
2834#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002835 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002837 *key_type = PSA_KEY_TYPE_CAMELLIA;
2838 *key_size = 192;
2839 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002840#endif
2841#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002842 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2843 *alg = PSA_ALG_GCM;
2844 *key_type = PSA_KEY_TYPE_CAMELLIA;
2845 *key_size = 192;
2846 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002847#endif
2848#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002849 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2850 *alg = PSA_ALG_CBC_NO_PADDING;
2851 *key_type = PSA_KEY_TYPE_CAMELLIA;
2852 *key_size = 256;
2853 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002854#endif
2855#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002856 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002858 *key_type = PSA_KEY_TYPE_CAMELLIA;
2859 *key_size = 256;
2860 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002861#endif
2862#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002863 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2864 *alg = PSA_ALG_GCM;
2865 *key_type = PSA_KEY_TYPE_CAMELLIA;
2866 *key_size = 256;
2867 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002868#endif
2869#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002870 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2871 *alg = PSA_ALG_CHACHA20_POLY1305;
2872 *key_type = PSA_KEY_TYPE_CHACHA20;
2873 *key_size = 256;
2874 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002875#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002876 case MBEDTLS_CIPHER_NULL:
2877 *alg = MBEDTLS_SSL_NULL_CIPHER;
2878 *key_type = 0;
2879 *key_size = 0;
2880 break;
2881 default:
2882 return PSA_ERROR_NOT_SUPPORTED;
2883 }
2884
2885 return PSA_SUCCESS;
2886}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002887#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002888
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002889#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002890int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2891 const unsigned char *dhm_P, size_t P_len,
2892 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002893{
Janos Follath865b3eb2019-12-16 11:46:15 +00002894 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 mbedtls_mpi_free(&conf->dhm_P);
2897 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2900 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2901 mbedtls_mpi_free(&conf->dhm_P);
2902 mbedtls_mpi_free(&conf->dhm_G);
2903 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002904 }
2905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002907}
Paul Bakker5121ce52009-01-03 21:22:43 +00002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002910{
Janos Follath865b3eb2019-12-16 11:46:15 +00002911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 mbedtls_mpi_free(&conf->dhm_P);
2914 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2917 &conf->dhm_P)) != 0 ||
2918 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2919 &conf->dhm_G)) != 0) {
2920 mbedtls_mpi_free(&conf->dhm_P);
2921 mbedtls_mpi_free(&conf->dhm_G);
2922 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002923 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002926}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002927#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002928
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002929#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2930/*
2931 * Set the minimum length for Diffie-Hellman parameters
2932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002933void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2934 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002935{
2936 conf->dhm_min_bitlen = bitlen;
2937}
2938#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2939
Ronald Crone68ab4f2022-10-05 12:46:29 +02002940#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002941#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002942/*
2943 * Set allowed/preferred hashes for handshake signatures
2944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2946 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002947{
2948 conf->sig_hashes = hashes;
2949}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002950#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002951
Jerry Yuf017ee42022-01-12 15:49:48 +08002952/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2954 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002955{
Jerry Yuf017ee42022-01-12 15:49:48 +08002956#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2957 conf->sig_hashes = NULL;
2958#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2959 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002960}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002961#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002962
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002963#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002964#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002965/*
2966 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002967 *
2968 * mbedtls_ssl_setup() takes the provided list
2969 * and translates it to a list of IANA TLS group identifiers,
2970 * stored in ssl->handshake->group_list.
2971 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002973void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2974 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002975{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002976 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002977 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002978}
Brett Warrene0edc842021-08-17 09:53:13 +01002979#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002980#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002981
Brett Warrene0edc842021-08-17 09:53:13 +01002982/*
2983 * Set the allowed groups
2984 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002985void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2986 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002987{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002988#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002989 conf->curve_list = NULL;
2990#endif
2991 conf->group_list = group_list;
2992}
2993
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002994#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002995int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002996{
Hanno Becker947194e2017-04-07 13:25:49 +01002997 /* Initialize to suppress unnecessary compiler warning */
2998 size_t hostname_len = 0;
2999
3000 /* Check if new hostname is valid before
3001 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 if (hostname != NULL) {
3003 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3007 }
Hanno Becker947194e2017-04-07 13:25:49 +01003008 }
3009
3010 /* Now it's clear that we will overwrite the old hostname,
3011 * so we can free it safely */
3012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003014 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003015 }
3016
3017 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003020 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 } else {
3022 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3023 if (ssl->hostname == NULL) {
3024 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3025 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003028
Hanno Becker947194e2017-04-07 13:25:49 +01003029 ssl->hostname[hostname_len] = '\0';
3030 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003033}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003034#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003035
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003036#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003037void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3038 int (*f_sni)(void *, mbedtls_ssl_context *,
3039 const unsigned char *, size_t),
3040 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003041{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003042 conf->f_sni = f_sni;
3043 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003044}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003048int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003049{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003050 size_t cur_len, tot_len;
3051 const char **p;
3052
3053 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003054 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3055 * MUST NOT be truncated."
3056 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003057 */
3058 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 for (p = protos; *p != NULL; p++) {
3060 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003061 tot_len += cur_len;
3062
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if ((cur_len == 0) ||
3064 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3065 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3067 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003068 }
3069
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003070 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003073}
3074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003076{
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003078}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003080
Johan Pascalb62bb512015-12-03 21:56:45 +01003081#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003082void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3083 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003084{
3085 conf->dtls_srtp_mki_support = support_mki_value;
3086}
3087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3089 unsigned char *mki_value,
3090 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003094 }
Ron Eldor591f1622018-01-22 12:30:04 +02003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3097 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003098 }
Ron Eldor591f1622018-01-22 12:30:04 +02003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003101 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003103}
3104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3106 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003107{
Johan Pascal253d0262020-09-22 13:04:45 +02003108 const mbedtls_ssl_srtp_profile *p;
3109 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003110
Johan Pascal253d0262020-09-22 13:04:45 +02003111 /* check the profiles list: all entry must be valid,
3112 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3114 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3115 p++) {
3116 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003117 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003119 /* unsupported value, stop parsing and set the size to an error value */
3120 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003121 }
3122 }
3123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3125 conf->dtls_srtp_profile_list = NULL;
3126 conf->dtls_srtp_profile_list_len = 0;
3127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003128 }
3129
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003130 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003131 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003134}
3135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3137 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003138{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003139 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3140 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003142 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003144 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3146 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003147 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003148}
Johan Pascalb62bb512015-12-03 21:56:45 +01003149#endif /* MBEDTLS_SSL_DTLS_SRTP */
3150
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303151#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003153{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003154 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003155}
3156
Gilles Peskine449bd832023-01-11 14:50:10 +01003157void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003158{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003159 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003160}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303161#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003162
Janos Follath088ce432017-04-10 12:42:31 +01003163#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003164void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3165 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003166{
3167 conf->cert_req_ca_list = cert_req_ca_list;
3168}
3169#endif
3170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003172void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003173{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003174 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003175}
3176#endif
3177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003179void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003180{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003181 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003182}
3183#endif
3184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003186int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003187{
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3189 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003191 }
3192
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003193 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003194
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003196}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003198
Gilles Peskine449bd832023-01-11 14:50:10 +01003199void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003200{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003201 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003202}
3203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003205void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003206{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003207 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003208}
3209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003211{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003212 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003213}
3214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3216 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003217{
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003219}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003223#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003224void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003225{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003226 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003227}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003228#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003229
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003230#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003231
Jerry Yud0766ec2022-09-22 10:46:57 +08003232#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003233void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3234 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003235{
Jerry Yud0766ec2022-09-22 10:46:57 +08003236 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003237}
3238#endif
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3241 mbedtls_ssl_ticket_write_t *f_ticket_write,
3242 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3243 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003244{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003245 conf->f_ticket_write = f_ticket_write;
3246 conf->f_ticket_parse = f_ticket_parse;
3247 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003248}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003249#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3253 mbedtls_ssl_export_keys_t *f_export_keys,
3254 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003255{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003256 ssl->f_export_keys = f_export_keys;
3257 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003258}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003259
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003260#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003261void mbedtls_ssl_conf_async_private_cb(
3262 mbedtls_ssl_config *conf,
3263 mbedtls_ssl_async_sign_t *f_async_sign,
3264 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3265 mbedtls_ssl_async_resume_t *f_async_resume,
3266 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003268{
3269 conf->f_async_sign_start = f_async_sign;
3270 conf->f_async_decrypt_start = f_async_decrypt;
3271 conf->f_async_resume = f_async_resume;
3272 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003273 conf->p_async_config_data = async_config_data;
3274}
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003277{
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003279}
3280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003282{
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 if (ssl->handshake == NULL) {
3284 return NULL;
3285 } else {
3286 return ssl->handshake->user_async_ctx;
3287 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003288}
3289
Gilles Peskine449bd832023-01-11 14:50:10 +01003290void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3291 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003292{
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003294 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003296}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003297#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003298
Paul Bakker5121ce52009-01-03 21:22:43 +00003299/*
3300 * SSL get accessors
3301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003302uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003303{
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 if (ssl->session != NULL) {
3305 return ssl->session->verify_result;
3306 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003307
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 if (ssl->session_negotiate != NULL) {
3309 return ssl->session_negotiate->verify_result;
3310 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003313}
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003316{
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 if (ssl == NULL || ssl->session == NULL) {
3318 return 0;
3319 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003322}
3323
Gilles Peskine449bd832023-01-11 14:50:10 +01003324const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003325{
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 if (ssl == NULL || ssl->session == NULL) {
3327 return NULL;
3328 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003329
Gilles Peskine449bd832023-01-11 14:50:10 +01003330 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003331}
3332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003334{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3337 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003338 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003340 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003342 }
3343 }
3344#endif
3345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003347 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003349 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003351 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003353 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003354}
3355
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003356#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003357size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003358{
David Horstmann95d516f2021-05-04 18:36:56 +01003359 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003360 size_t read_mfl;
3361
Jerry Yuddda0502022-12-01 19:43:12 +08003362#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003363 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3365 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3366 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003367 }
Jerry Yuddda0502022-12-01 19:43:12 +08003368#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003369
3370 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (ssl->session_out != NULL) {
3372 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3373 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003374 max_len = read_mfl;
3375 }
3376 }
3377
Jerry Yuddda0502022-12-01 19:43:12 +08003378 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 if (ssl->session_negotiate != NULL) {
3380 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3381 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003382 max_len = read_mfl;
3383 }
3384 }
3385
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003387}
3388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003390{
3391 size_t max_len;
3392
3393 /*
3394 * Assume mfl_code is correct since it was checked when set
3395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003396 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003397
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003398 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 if (ssl->session_out != NULL &&
3400 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3401 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003402 }
3403
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003404 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 if (ssl->session_negotiate != NULL &&
3406 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3407 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003408 }
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003411}
3412#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3413
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003415size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003416{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003417 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3419 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3420 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3421 return 0;
3422 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003423
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3425 return ssl->mtu;
3426 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 if (ssl->mtu == 0) {
3429 return ssl->handshake->mtu;
3430 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 return ssl->mtu < ssl->handshake->mtu ?
3433 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003434}
3435#endif /* MBEDTLS_SSL_PROTO_DTLS */
3436
Gilles Peskine449bd832023-01-11 14:50:10 +01003437int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438{
3439 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3440
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003441#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3442 !defined(MBEDTLS_SSL_PROTO_DTLS)
3443 (void) ssl;
3444#endif
3445
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003446#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003450 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003452#endif
3453
3454#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3456 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3457 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003458 const size_t overhead = (size_t) ret;
3459
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 if (ret < 0) {
3461 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003462 }
3463
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 if (mtu <= overhead) {
3465 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3466 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3467 }
3468
3469 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003470 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003472 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003473#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003474
Hanno Becker0defedb2018-08-10 12:35:02 +01003475#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3476 !defined(MBEDTLS_SSL_PROTO_DTLS)
3477 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003478#endif
3479
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003481}
3482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003484{
3485 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3486
3487#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3488 (void) ssl;
3489#endif
3490
3491#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003493
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003495 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003496 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003497#endif
3498
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003500}
3501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003503const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003504{
Gilles Peskine449bd832023-01-11 14:50:10 +01003505 if (ssl == NULL || ssl->session == NULL) {
3506 return NULL;
3507 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003508
Hanno Beckere6824572019-02-07 13:18:46 +00003509#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003510 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003511#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003513#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003514}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003518int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3519 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003520{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003521 int ret;
3522
Gilles Peskine449bd832023-01-11 14:50:10 +01003523 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003524 dst == NULL ||
3525 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003526 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003528 }
3529
Hanno Beckere810bbc2021-05-14 16:01:05 +01003530 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3531 * idempotent: Each session can only be exported once.
3532 *
3533 * (This is in preparation for TLS 1.3 support where we will
3534 * need the ability to export multiple sessions (aka tickets),
3535 * which will be achieved by calling mbedtls_ssl_get_session()
3536 * multiple times until it fails.)
3537 *
3538 * Check whether we have already exported the current session,
3539 * and fail if so.
3540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003541 if (ssl->session->exported == 1) {
3542 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3543 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003544
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3546 if (ret != 0) {
3547 return ret;
3548 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003549
3550 /* Remember that we've exported the session. */
3551 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003552 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003553}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003555
Paul Bakker5121ce52009-01-03 21:22:43 +00003556/*
Hanno Beckera835da52019-05-16 12:39:07 +01003557 * Define ticket header determining Mbed TLS version
3558 * and structure of the ticket.
3559 */
3560
Hanno Becker94ef3b32019-05-16 12:50:45 +01003561/*
Hanno Becker50b59662019-05-28 14:30:45 +01003562 * Define bitflag determining compile-time settings influencing
3563 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003564 */
3565
Hanno Becker50b59662019-05-28 14:30:45 +01003566#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003567#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003568#else
Hanno Becker3e088662019-05-29 11:10:18 +01003569#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003570#endif /* MBEDTLS_HAVE_TIME */
3571
3572#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003573#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003574#else
Hanno Becker3e088662019-05-29 11:10:18 +01003575#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003576#endif /* MBEDTLS_X509_CRT_PARSE_C */
3577
3578#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003579#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003580#else
Hanno Becker3e088662019-05-29 11:10:18 +01003581#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003582#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3583
3584#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003585#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003586#else
Hanno Becker3e088662019-05-29 11:10:18 +01003587#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003588#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3589
Hanno Becker94ef3b32019-05-16 12:50:45 +01003590#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003591#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003592#else
Hanno Becker3e088662019-05-29 11:10:18 +01003593#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003594#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3595
Hanno Becker94ef3b32019-05-16 12:50:45 +01003596#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3597#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3598#else
3599#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3600#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3601
Hanno Becker3e088662019-05-29 11:10:18 +01003602#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3603#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3604#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3605#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003606#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3607#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003608
Hanno Becker50b59662019-05-28 14:30:45 +01003609#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003610 ((uint16_t) ( \
3611 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3612 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3613 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3614 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3615 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3616 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3617 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003618
Hanno Beckerf8787072019-05-16 12:41:07 +01003619static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003620 MBEDTLS_VERSION_MAJOR,
3621 MBEDTLS_VERSION_MINOR,
3622 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003623 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3624 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003625};
Hanno Beckera835da52019-05-16 12:39:07 +01003626
3627/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003628 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003629 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003630 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003631 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003632 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003633 * opaque mbedtls_version[3]; // library version: major, minor, patch
3634 * opaque session_format[2]; // library-version specific 16-bit field
3635 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003636 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003637 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003638 * Note: When updating the format, remember to keep
3639 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003640 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003641 * // In this version, `session_format` determines
3642 * // the setting of those compile-time
3643 * // configuration options which influence
3644 * // the structure of mbedtls_ssl_session.
3645 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003646 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003647 * // - TLS 1.2 (0x0303)
3648 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003649 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003650 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003651 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003652 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003653 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003654 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003655 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003656 *
3657 * };
3658 *
3659 * } serialized_session;
3660 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003661 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003662
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003663MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003664static int ssl_session_save(const mbedtls_ssl_session *session,
3665 unsigned char omit_header,
3666 unsigned char *buf,
3667 size_t buf_len,
3668 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003669{
3670 unsigned char *p = buf;
3671 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003672 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003673#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3674 size_t out_len;
3675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3676#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003677 if (session == NULL) {
3678 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3679 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003680
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003682 /*
3683 * Add Mbed TLS version identifier
3684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003685 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003686
Gilles Peskine449bd832023-01-11 14:50:10 +01003687 if (used <= buf_len) {
3688 memcpy(p, ssl_serialized_session_header,
3689 sizeof(ssl_serialized_session_header));
3690 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003691 }
3692 }
3693
3694 /*
3695 * TLS version identifier
3696 */
3697 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 if (used <= buf_len) {
3699 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003700 }
3701
3702 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003703 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003704 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003705#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 case MBEDTLS_SSL_VERSION_TLS1_2:
3707 used += ssl_tls12_session_save(session, p, remaining_len);
3708 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003709#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3710
Jerry Yu251a12e2022-07-13 15:15:48 +08003711#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003712 case MBEDTLS_SSL_VERSION_TLS1_3:
3713 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3714 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3715 return ret;
3716 }
3717 used += out_len;
3718 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003719#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3720
Gilles Peskine449bd832023-01-11 14:50:10 +01003721 default:
3722 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003723 }
3724
3725 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003726 if (used > buf_len) {
3727 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3728 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003729
Gilles Peskine449bd832023-01-11 14:50:10 +01003730 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003731}
3732
3733/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003734 * Public wrapper for ssl_session_save()
3735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003736int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3737 unsigned char *buf,
3738 size_t buf_len,
3739 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003740{
Gilles Peskine449bd832023-01-11 14:50:10 +01003741 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003742}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003743
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003744/*
3745 * Deserialize session, see mbedtls_ssl_session_save() for format.
3746 *
3747 * This internal version is wrapped by a public function that cleans up in
3748 * case of error, and has an extra option omit_header.
3749 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003750MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003751static int ssl_session_load(mbedtls_ssl_session *session,
3752 unsigned char omit_header,
3753 const unsigned char *buf,
3754 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003755{
3756 const unsigned char *p = buf;
3757 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003758 size_t remaining_len;
3759
3760
Gilles Peskine449bd832023-01-11 14:50:10 +01003761 if (session == NULL) {
3762 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3763 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003764
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003766 /*
3767 * Check Mbed TLS version identifier
3768 */
3769
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003772 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003773
3774 if (memcmp(p, ssl_serialized_session_header,
3775 sizeof(ssl_serialized_session_header)) != 0) {
3776 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3777 }
3778 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003779 }
3780
3781 /*
3782 * TLS version identifier
3783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (1 > (size_t) (end - p)) {
3785 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3786 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003787 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003788
3789 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003790 remaining_len = (end - p);
3791 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003792#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003793 case MBEDTLS_SSL_VERSION_TLS1_2:
3794 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003795#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3796
Jerry Yu438ddd82022-07-07 06:55:50 +00003797#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 case MBEDTLS_SSL_VERSION_TLS1_3:
3799 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003800#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3801
Gilles Peskine449bd832023-01-11 14:50:10 +01003802 default:
3803 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003804 }
3805}
3806
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003807/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003808 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003809 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003810int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3811 const unsigned char *buf,
3812 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003813{
Gilles Peskine449bd832023-01-11 14:50:10 +01003814 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003815
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 if (ret != 0) {
3817 mbedtls_ssl_session_free(session);
3818 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003819
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003821}
3822
3823/*
Paul Bakker1961b702013-01-25 14:49:24 +01003824 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003825 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003826MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003827static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003828{
3829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3830
Ronald Cron66dbf912022-02-02 15:33:46 +01003831 /*
3832 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003833 * that were written into the output buffer by the previous handshake step,
3834 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003835 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3836 * We proceed to the next handshake step only when all data from the
3837 * previous one have been sent to the peer, thus we make sure that this is
3838 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3839 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3840 * we have to wait before to go ahead.
3841 * In the case of TLS 1.3, handshake step handlers do not send data to the
3842 * peer. Data are only sent here and through
3843 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003844 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3847 return ret;
3848 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003849
3850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003851 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3852 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3853 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3854 return ret;
3855 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003856 }
3857#endif /* MBEDTLS_SSL_PROTO_DTLS */
3858
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003860}
3861
Gilles Peskine449bd832023-01-11 14:50:10 +01003862int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003863{
Hanno Becker41934dd2021-08-07 19:13:43 +01003864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003865
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003867 ssl->conf == NULL ||
3868 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003871 }
3872
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 ret = ssl_prepare_handshake_step(ssl);
3874 if (ret != 0) {
3875 return ret;
3876 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003877
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 ret = mbedtls_ssl_handle_pending_alert(ssl);
3879 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003880 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 }
Jerry Yue7047812021-09-13 19:26:39 +08003882
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003883 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3884 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3885 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3886
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003887#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3889 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003890 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003891
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003893 case MBEDTLS_SSL_HELLO_REQUEST:
3894 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003895 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003896 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003897
Ronald Cron9f0fba32022-02-10 16:45:15 +01003898 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003900 break;
3901
3902 default:
3903#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3905 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3906 } else {
3907 ret = mbedtls_ssl_handshake_client_step(ssl);
3908 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003909#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003911#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003913#endif
3914 }
Jerry Yub9930e72021-08-06 17:11:51 +08003915 }
Ronald Cron6291b232023-03-08 15:51:25 +01003916#endif /* MBEDTLS_SSL_CLI_C */
3917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003918#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003920#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3921 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003922 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003923 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 ret = mbedtls_ssl_handshake_server_step(ssl);
3925 }
Ronald Cron6291b232023-03-08 15:51:25 +01003926#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3927 ret = mbedtls_ssl_handshake_server_step(ssl);
3928#else
3929 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003930#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003931 }
3932#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003933
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003935 /* handshake_step return error. And it is same
3936 * with alert_reason.
3937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (ssl->send_alert) {
3939 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003940 goto cleanup;
3941 }
3942 }
3943
3944cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003946}
3947
3948/*
3949 * Perform the SSL handshake
3950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003951int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003952{
3953 int ret = 0;
3954
Hanno Beckera817ea42020-10-20 15:20:23 +01003955 /* Sanity checks */
3956
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 if (ssl == NULL || ssl->conf == NULL) {
3958 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3959 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003960
Hanno Beckera817ea42020-10-20 15:20:23 +01003961#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3963 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3964 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3965 "mbedtls_ssl_set_timer_cb() for DTLS"));
3966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003967 }
3968#endif /* MBEDTLS_SSL_PROTO_DTLS */
3969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003971
Hanno Beckera817ea42020-10-20 15:20:23 +01003972 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3974 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003977 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 }
Paul Bakker1961b702013-01-25 14:49:24 +01003979 }
3980
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003982
Gilles Peskine449bd832023-01-11 14:50:10 +01003983 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003984}
3985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003986#if defined(MBEDTLS_SSL_RENEGOTIATION)
3987#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003988/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003989 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003990 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003991MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003992static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003993{
Janos Follath865b3eb2019-12-16 11:46:15 +00003994 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003997
3998 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4000 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4003 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4004 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004005 }
4006
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004008
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004010}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004011#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004012
4013/*
4014 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015 * - any side: calling mbedtls_ssl_renegotiate(),
4016 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4017 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004018 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004019 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004022int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004023{
Janos Follath865b3eb2019-12-16 11:46:15 +00004024 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 if ((ret = ssl_handshake_init(ssl)) != 0) {
4029 return ret;
4030 }
Paul Bakker48916f92012-09-16 19:57:18 +00004031
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004032 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4033 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4036 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004038 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004040 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004042 }
4043#endif
4044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004045 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4046 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004047
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4049 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4050 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004051 }
4052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004054
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004056}
4057
4058/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004059 * Renegotiate current connection on client,
4060 * or request renegotiation on server
4061 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004063{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004064 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 if (ssl == NULL || ssl->conf == NULL) {
4067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4068 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004070#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004071 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4073 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4075 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004077 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004078
4079 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 if (ssl->out_left != 0) {
4081 return mbedtls_ssl_flush_output(ssl);
4082 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004083
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004085 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004086#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004088#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004089 /*
4090 * On client, either start the renegotiation process or,
4091 * if already in progress, continue the handshake
4092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4094 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004097
4098 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4099 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4100 return ret;
4101 }
4102 } else {
4103 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4104 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4105 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004106 }
4107 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004108#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004111}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004112#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004115{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004116 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004119 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004121
Valerio Setti6f0441d2023-07-03 12:11:36 +02004122#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004123#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (ssl->handshake->group_list_heap_allocated) {
4125 mbedtls_free((void *) handshake->group_list);
4126 }
Brett Warrene0edc842021-08-17 09:53:13 +01004127 handshake->group_list = NULL;
4128#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004129#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004130
Ronald Crone68ab4f2022-10-05 12:46:29 +02004131#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004132#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (ssl->handshake->sig_algs_heap_allocated) {
4134 mbedtls_free((void *) handshake->sig_algs);
4135 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004136 handshake->sig_algs = NULL;
4137#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004138#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (ssl->handshake->certificate_request_context) {
4140 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004141 }
4142#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004143#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004144
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004145#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4147 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004148 handshake->async_in_progress = 0;
4149 }
4150#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4151
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004152#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004153#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004155#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004156 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004157#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004158#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004159#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004160#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004162#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004163 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004164#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004165#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004167#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004169#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004170#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004171 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004173#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004174
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004175#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004178 /*
4179 * Opaque keys are not stored in the handshake's data and it's the user
4180 * responsibility to destroy them. Clear ones, instead, are created by
4181 * the TLS library and should be destroyed at the same level
4182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4184 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004185 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004186 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4187#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004189#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004190#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004192 handshake->ecjpake_cache = NULL;
4193 handshake->ecjpake_cache_len = 0;
4194#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004195#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004196
Valerio Setti7aeec542023-07-05 18:57:21 +02004197#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004198 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004199 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004200 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004202#endif
4203
Ronald Cron73fe8df2022-10-05 14:31:43 +02004204#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004205#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004207 /* The maintenance of the external PSK key slot is the
4208 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (ssl->handshake->psk_opaque_is_internal) {
4210 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004211 ssl->handshake->psk_opaque_is_internal = 0;
4212 }
4213 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4214 }
Neil Armstronge952a302022-05-03 10:22:14 +02004215#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004217 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004218 }
Neil Armstronge952a302022-05-03 10:22:14 +02004219#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004220#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004222#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4223 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004224 /*
4225 * Free only the linked list wrapper, not the keys themselves
4226 * since the belong to the SNI callback
4227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004229#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004230
Gilles Peskineeccd8882020-03-10 12:19:08 +01004231#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4233 if (handshake->ecrs_peer_cert != NULL) {
4234 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4235 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004236 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004237#endif
4238
Hanno Becker75173122019-02-06 16:18:31 +00004239#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4240 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004242#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4243
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004244#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4246 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004247#endif /* MBEDTLS_SSL_CLI_C &&
4248 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004249
4250#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 mbedtls_ssl_flight_free(handshake->flight);
4252 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004253#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004254
Valerio Settiea59c432023-07-25 11:14:03 +02004255#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004256 if (handshake->xxdh_psa_privkey_is_external == 0) {
4257 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 }
Valerio Settiea59c432023-07-25 11:14:03 +02004259#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004260
Ronald Cron6f135e12021-12-08 16:57:54 +01004261#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 mbedtls_ssl_transform_free(handshake->transform_handshake);
4263 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004264#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4266 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004267#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004268#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004269
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004270
4271#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4272 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4273 * processes datagrams and the fact that a datagram is allowed to have
4274 * several records in it, it is possible that the I/O buffers are not
4275 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4277 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004278#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004279
Jerry Yuba9c7272021-10-30 11:54:10 +08004280 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 mbedtls_platform_zeroize(handshake,
4282 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004283}
4284
Gilles Peskine449bd832023-01-11 14:50:10 +01004285void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004286{
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004288 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004291#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004293#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004294
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004295#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004296#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4297 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004299#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004301#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004304}
4305
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004306#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004307
4308#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4309#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4310#else
4311#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4312#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4313
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004314#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004315
4316#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4317#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4318#else
4319#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4320#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4321
4322#if defined(MBEDTLS_SSL_ALPN)
4323#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4324#else
4325#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4326#endif /* MBEDTLS_SSL_ALPN */
4327
4328#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4329#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4330#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4331#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4332
4333#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 ((uint32_t) ( \
4335 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4336 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4337 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4338 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4339 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4340 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4341 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4342 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004343
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004344static unsigned char ssl_serialized_context_header[] = {
4345 MBEDTLS_VERSION_MAJOR,
4346 MBEDTLS_VERSION_MINOR,
4347 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4349 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4350 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4351 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4352 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004353};
4354
Paul Bakker5121ce52009-01-03 21:22:43 +00004355/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004356 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004357 *
4358 * The format of the serialized data is:
4359 * (in the presentation language of TLS, RFC 8446 section 3)
4360 *
4361 * // header
4362 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004363 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004364 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004365 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004366 * Note: When updating the format, remember to keep these
4367 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004368 *
4369 * // session sub-structure
4370 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4371 * // transform sub-structure
4372 * uint8 random[64]; // ServerHello.random+ClientHello.random
4373 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4374 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4375 * // fields from ssl_context
4376 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4377 * uint64 in_window_top; // DTLS: last validated record seq_num
4378 * uint64 in_window; // DTLS: bitmask for replay protection
4379 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4380 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4381 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4382 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4383 *
4384 * Note that many fields of the ssl_context or sub-structures are not
4385 * serialized, as they fall in one of the following categories:
4386 *
4387 * 1. forced value (eg in_left must be 0)
4388 * 2. pointer to dynamically-allocated memory (eg session, transform)
4389 * 3. value can be re-derived from other data (eg session keys from MS)
4390 * 4. value was temporary (eg content of input buffer)
4391 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004393int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4394 unsigned char *buf,
4395 size_t buf_len,
4396 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004397{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004398 unsigned char *p = buf;
4399 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004400 size_t session_len;
4401 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004402
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004403 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004404 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4405 * this function's documentation.
4406 *
4407 * These are due to assumptions/limitations in the implementation. Some of
4408 * them are likely to stay (no handshake in progress) some might go away
4409 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004410 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004411 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4413 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (ssl->handshake != NULL) {
4417 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4418 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004419 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004420 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (ssl->transform == NULL || ssl->session == NULL) {
4422 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004424 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004425 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (mbedtls_ssl_check_pending(ssl) != 0) {
4427 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004429 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 if (ssl->out_left != 0) {
4431 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004433 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004434 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4436 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004438 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004439 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4441 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4442 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004443 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004444 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4446 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4447 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004448 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004449 /* Renegotiation must not be enabled */
4450#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4452 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004454 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004455#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004456
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004457 /*
4458 * Version and format identifier
4459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (used <= buf_len) {
4463 memcpy(p, ssl_serialized_context_header,
4464 sizeof(ssl_serialized_context_header));
4465 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004466 }
4467
4468 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004469 * Session (length + data)
4470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4472 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4473 return ret;
4474 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004475
4476 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (used <= buf_len) {
4478 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004479 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 ret = ssl_session_save(ssl->session, 1,
4482 p, session_len, &session_len);
4483 if (ret != 0) {
4484 return ret;
4485 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004486
4487 p += session_len;
4488 }
4489
4490 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004491 * Transform
4492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 used += sizeof(ssl->transform->randbytes);
4494 if (used <= buf_len) {
4495 memcpy(p, ssl->transform->randbytes,
4496 sizeof(ssl->transform->randbytes));
4497 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004498 }
4499
4500#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4501 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004503 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004505 p += ssl->transform->in_cid_len;
4506
4507 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004509 p += ssl->transform->out_cid_len;
4510 }
4511#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4512
4513 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004514 * Saved fields from top-level ssl_context structure
4515 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004516 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (used <= buf_len) {
4518 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004519 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004520 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004521
4522#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4523 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 if (used <= buf_len) {
4525 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004526 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004527
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004529 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004530 }
4531#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4532
4533#if defined(MBEDTLS_SSL_PROTO_DTLS)
4534 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004536 *p++ = ssl->disable_datagram_packing;
4537 }
4538#endif /* MBEDTLS_SSL_PROTO_DTLS */
4539
Jerry Yuae0b2e22021-10-08 15:21:19 +08004540 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (used <= buf_len) {
4542 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004543 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004544 }
4545
4546#if defined(MBEDTLS_SSL_PROTO_DTLS)
4547 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (used <= buf_len) {
4549 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004550 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004551 }
4552#endif /* MBEDTLS_SSL_PROTO_DTLS */
4553
4554#if defined(MBEDTLS_SSL_ALPN)
4555 {
4556 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004558 : 0;
4559
4560 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004562 *p++ = alpn_len;
4563
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 if (ssl->alpn_chosen != NULL) {
4565 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004566 p += alpn_len;
4567 }
4568 }
4569 }
4570#endif /* MBEDTLS_SSL_ALPN */
4571
4572 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004573 * Done
4574 */
4575 *olen = used;
4576
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 if (used > buf_len) {
4578 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4579 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004582
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004584}
4585
4586/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004587 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004588 *
4589 * This internal version is wrapped by a public function that cleans up in
4590 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004591 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004592MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004593static int ssl_context_load(mbedtls_ssl_context *ssl,
4594 const unsigned char *buf,
4595 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004596{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004597 const unsigned char *p = buf;
4598 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004599 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004600 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004601#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004602 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004603#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004604
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004605 /*
4606 * The context should have been freshly setup or reset.
4607 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004608 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004609 * renegotiating, or if the user mistakenly loaded a session first.)
4610 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4612 ssl->session != NULL) {
4613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004614 }
4615
4616 /*
4617 * We can't check that the config matches the initial one, but we can at
4618 * least check it matches the requirements for serializing.
4619 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004620 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004621#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004622 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004623#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004624 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4625 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4626 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4627 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004629 }
4630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004632
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004633 /*
4634 * Check version identifier
4635 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004638 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004639
4640 if (memcmp(p, ssl_serialized_context_header,
4641 sizeof(ssl_serialized_context_header)) != 0) {
4642 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4643 }
4644 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004645
4646 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004647 * Session
4648 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if ((size_t) (end - p) < 4) {
4650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4651 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004652
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004653 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004654 p += 4;
4655
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004656 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004657 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004658 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004659 ssl->session_in = ssl->session;
4660 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004661 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004662
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if ((size_t) (end - p) < session_len) {
4664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4665 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 ret = ssl_session_load(ssl->session, 1, p, session_len);
4668 if (ret != 0) {
4669 mbedtls_ssl_session_free(ssl->session);
4670 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004671 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004672
4673 p += session_len;
4674
4675 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004676 * Transform
4677 */
4678
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004679 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004680 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004681#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004682 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004683 ssl->transform_in = ssl->transform;
4684 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004685 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004686#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004687
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004688#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4690 if (prf_func == NULL) {
4691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4692 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004693
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004694 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4697 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 ret = ssl_tls12_populate_transform(ssl->transform,
4700 ssl->session->ciphersuite,
4701 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004702#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004704#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 prf_func,
4706 p, /* currently pointing to randbytes */
4707 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4708 ssl->conf->endpoint,
4709 ssl);
4710 if (ret != 0) {
4711 return ret;
4712 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004713#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004715
4716#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4717 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if ((size_t) (end - p) < 1) {
4719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4720 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004721
4722 ssl->transform->in_cid_len = *p++;
4723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4726 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004729 p += ssl->transform->in_cid_len;
4730
4731 ssl->transform->out_cid_len = *p++;
4732
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4735 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004738 p += ssl->transform->out_cid_len;
4739#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4740
4741 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004742 * Saved fields from top-level ssl_context structure
4743 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if ((size_t) (end - p) < 4) {
4745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4746 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004747
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004748 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004749 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004750
4751#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if ((size_t) (end - p) < 16) {
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4754 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004755
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004756 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004757 p += 8;
4758
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004759 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760 p += 8;
4761#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4762
4763#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if ((size_t) (end - p) < 1) {
4765 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4766 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004767
4768 ssl->disable_datagram_packing = *p++;
4769#endif /* MBEDTLS_SSL_PROTO_DTLS */
4770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4773 }
4774 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4775 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004776
4777#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if ((size_t) (end - p) < 2) {
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4780 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004781
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004783 p += 2;
4784#endif /* MBEDTLS_SSL_PROTO_DTLS */
4785
4786#if defined(MBEDTLS_SSL_ALPN)
4787 {
4788 uint8_t alpn_len;
4789 const char **cur;
4790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if ((size_t) (end - p) < 1) {
4792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4793 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004794
4795 alpn_len = *p++;
4796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004798 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4800 if (strlen(*cur) == alpn_len &&
4801 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004802 ssl->alpn_chosen = *cur;
4803 break;
4804 }
4805 }
4806 }
4807
4808 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4811 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004812
4813 p += alpn_len;
4814 }
4815#endif /* MBEDTLS_SSL_ALPN */
4816
4817 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004818 * Forced fields from top-level ssl_context structure
4819 *
4820 * Most of them already set to the correct value by mbedtls_ssl_init() and
4821 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4822 */
4823 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004824 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004825
Hanno Becker361b10d2019-08-30 10:42:49 +01004826 /* Adjust pointers for header fields of outgoing records to
4827 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004829
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004830#if defined(MBEDTLS_SSL_PROTO_DTLS)
4831 ssl->in_epoch = 1;
4832#endif
4833
4834 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4835 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004836 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4837 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (ssl->handshake != NULL) {
4839 mbedtls_ssl_handshake_free(ssl);
4840 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004841 ssl->handshake = NULL;
4842 }
4843
4844 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004845 * Done - should have consumed entire buffer
4846 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (p != end) {
4848 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4849 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004852}
4853
4854/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004855 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4858 const unsigned char *buf,
4859 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004860{
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (ret != 0) {
4864 mbedtls_ssl_free(context);
4865 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004868}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004869#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004870
4871/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004872 * Free an SSL context
4873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004875{
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004877 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004883#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4884 size_t out_buf_len = ssl->out_buf_len;
4885#else
4886 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4887#endif
4888
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004889 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004890 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004891 }
4892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004894#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4895 size_t in_buf_len = ssl->in_buf_len;
4896#else
4897 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4898#endif
4899
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004900 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004901 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004902 }
4903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (ssl->transform) {
4905 mbedtls_ssl_transform_free(ssl->transform);
4906 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004907 }
4908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (ssl->handshake) {
4910 mbedtls_ssl_handshake_free(ssl);
4911 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004912
4913#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4915 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004916#endif
4917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 mbedtls_ssl_session_free(ssl->session_negotiate);
4919 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004920 }
4921
Ronald Cron6f135e12021-12-08 16:57:54 +01004922#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 mbedtls_ssl_transform_free(ssl->transform_application);
4924 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004925#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (ssl->session) {
4928 mbedtls_ssl_session_free(ssl->session);
4929 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004930 }
4931
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004932#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004934 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004935 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004936#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004937
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004938#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004940#endif
4941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004943
Paul Bakker86f04f42013-02-14 11:20:09 +01004944 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004946}
4947
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004948/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004949 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004951void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004952{
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004954}
4955
Gilles Peskineae270bf2021-06-02 00:05:29 +02004956/* The selection should be the same as mbedtls_x509_crt_profile_default in
4957 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004958 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004959 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004960 * about this list.
4961 */
Brett Warrene0edc842021-08-17 09:53:13 +01004962static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004963#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004964 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004965#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004966#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004967 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004968#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004969#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004970 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004971#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004972#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004973 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004974#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004975#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004976 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004977#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004978#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004979 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004980#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004981#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004982 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004983#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004984#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004985 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004986#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004987#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004988 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4989 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4990 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4991 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4992 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4993#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004994 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004995};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004996
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004997static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004998 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4999 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5000 0
5001};
5002
Ronald Crone68ab4f2022-10-05 12:46:29 +02005003#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005004
Jerry Yu909df7b2022-01-22 11:56:27 +08005005/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005006 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005007 * rules SHOULD be upheld.
5008 * - No duplicate entries.
5009 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005010 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005011 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005012 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005013static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005014
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005015#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005016 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005017 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005018 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005019 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5020#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005021
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005022#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005023 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005024 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005025 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005026 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5027#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005028
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005029#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005030 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005031 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005032 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005033 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5034#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005037 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005038 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005039#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005043 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005044 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005045#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005046 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005049 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005050 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005051#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005052 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005053
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005054#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005055 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005056#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005057
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005058#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005059 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005060#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005061
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005062#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005063 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005064#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005065
Gabor Mezei15b95a62022-05-09 16:37:58 +02005066 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005067};
5068
5069/* NOTICE: see above */
5070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5071static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005072#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005073#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005075#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005076#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5077 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5078#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005079#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005081#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005082#endif /* MBEDTLS_MD_CAN_SHA512*/
5083#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005084#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005086#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005087#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5088 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5089#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005090#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005092#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005093#endif /* MBEDTLS_MD_CAN_SHA384*/
5094#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005095#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005097#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005098#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5099 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5100#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005101#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005103#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005104#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005105 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005106};
5107#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5108/* NOTICE: see above */
5109static uint16_t ssl_preset_suiteb_sig_algs[] = {
5110
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005111#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005112 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005113 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005114 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005115 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5116#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005117
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005119 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005120 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005121 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005122 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5123#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005126 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005127 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005128#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005129 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005130
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005131#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005132 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005133#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005134
Gabor Mezei15b95a62022-05-09 16:37:58 +02005135 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005136};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005137
Jerry Yu909df7b2022-01-22 11:56:27 +08005138/* NOTICE: see above */
5139#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5140static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005141#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005142#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005144#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005145#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005147#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005148#endif /* MBEDTLS_MD_CAN_SHA256*/
5149#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005150#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005152#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005153#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005155#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005156#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005157 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005158};
Jerry Yu909df7b2022-01-22 11:56:27 +08005159#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5160
Ronald Crone68ab4f2022-10-05 12:46:29 +02005161#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005162
Brett Warrene0edc842021-08-17 09:53:13 +01005163static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005164#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005165 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005166#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005167#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005168 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005169#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005170 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005171};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005172
Ronald Crone68ab4f2022-10-05 12:46:29 +02005173#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005174/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005175 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005177static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005178{
5179 size_t i, j;
5180 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5183 for (j = 0; j < i; j++) {
5184 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005185 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 }
5187 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5188 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5189 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005190 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005191 }
5192 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005194}
5195
Ronald Crone68ab4f2022-10-05 12:46:29 +02005196#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005198/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005199 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005201int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5202 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005203{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005204#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005206#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005207
Ronald Crone68ab4f2022-10-05 12:46:29 +02005208#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5210 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5211 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005212 }
5213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5215 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5216 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005217 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005218
5219#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5221 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5222 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005223 }
5224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5226 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5227 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005228 }
5229#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005230#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005231
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005232 /* Use the functions here so that they are covered in tests,
5233 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 mbedtls_ssl_conf_endpoint(conf, endpoint);
5235 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005236
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005237 /*
5238 * Things that are common to all presets
5239 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005240#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005242 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5243#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5244 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5245#endif
5246 }
5247#endif
5248
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005249#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5250 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5251#endif
5252
5253#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5254 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5255#endif
5256
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005257#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005258 conf->f_cookie_write = ssl_cookie_write_dummy;
5259 conf->f_cookie_check = ssl_cookie_check_dummy;
5260#endif
5261
5262#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5263 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5264#endif
5265
Janos Follath088ce432017-04-10 12:42:31 +01005266#if defined(MBEDTLS_SSL_SRV_C)
5267 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005268 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005269#endif
5270
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271#if defined(MBEDTLS_SSL_PROTO_DTLS)
5272 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5273 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5274#endif
5275
5276#if defined(MBEDTLS_SSL_RENEGOTIATION)
5277 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 memset(conf->renego_period, 0x00, 2);
5279 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005280#endif
5281
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005282#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005284 const unsigned char dhm_p[] =
5285 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5286 const unsigned char dhm_g[] =
5287 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5290 dhm_p, sizeof(dhm_p),
5291 dhm_g, sizeof(dhm_g))) != 0) {
5292 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005293 }
5294 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005295#endif
5296
Ronald Cron6f135e12021-12-08 16:57:54 +01005297#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005298
5299#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005300 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005301#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005302 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005303#endif
5304#endif /* MBEDTLS_SSL_EARLY_DATA */
5305
Jerry Yud0766ec2022-09-22 10:46:57 +08005306#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005307 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005309#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005310 /*
5311 * Allow all TLS 1.3 key exchange modes by default.
5312 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005313 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005314#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005317#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005318 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005319 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005320#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005322#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005324#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005325 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5326 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005327#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5328 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5329 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5330#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5331 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5332 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5333#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005335#endif
5336 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005337
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005338 /*
5339 * Preset-specific defaults
5340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005342 /*
5343 * NSA Suite B
5344 */
5345 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005346
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005347 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005348
5349#if defined(MBEDTLS_X509_CRT_PARSE_C)
5350 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005351#endif
5352
Ronald Crone68ab4f2022-10-05 12:46:29 +02005353#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005354#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005356 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005358#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005360#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005361
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005362#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005363 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005364#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005365 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005366 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367
5368 /*
5369 * Default
5370 */
5371 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005372
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005373 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005374
5375#if defined(MBEDTLS_X509_CRT_PARSE_C)
5376 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5377#endif
5378
Ronald Crone68ab4f2022-10-05 12:46:29 +02005379#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005380#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005382 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005384#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005386#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005387
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005388#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005389 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005390#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005391 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005392
5393#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5394 conf->dhm_min_bitlen = 1024;
5395#endif
5396 }
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005399}
5400
5401/*
5402 * Free mbedtls_ssl_config
5403 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005404void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005405{
5406#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 mbedtls_mpi_free(&conf->dhm_P);
5408 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005409#endif
5410
Ronald Cron73fe8df2022-10-05 14:31:43 +02005411#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005414 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5415 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005416#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005418 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005419 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005420 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005421 }
5422
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005424 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005425 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005426 conf->psk_identity_len = 0;
5427 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005428#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005429
5430#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005432#endif
5433
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005435}
5436
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005437#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005438 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005439/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005441 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005442unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005443{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005444#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5446 return MBEDTLS_SSL_SIG_RSA;
5447 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005448#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005449#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5451 return MBEDTLS_SSL_SIG_ECDSA;
5452 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005453#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005455}
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005458{
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005460 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005462 case MBEDTLS_PK_ECDSA:
5463 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005465 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005467 }
5468}
5469
Gilles Peskine449bd832023-01-11 14:50:10 +01005470mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005471{
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473#if defined(MBEDTLS_RSA_C)
5474 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005476#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005477#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005480#endif
5481 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005483 }
5484}
Valerio Settie9646ec2023-08-02 20:02:28 +02005485#endif /* MBEDTLS_PK_C &&
5486 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005487
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005488/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005489 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005491mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005492{
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005494#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005497#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005498#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005499 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005501#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005502#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005503 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005505#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005506#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005507 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005509#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005510#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005513#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005514#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005517#endif
5518 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005520 }
5521}
5522
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523/*
5524 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005526unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527{
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005529#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005530 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005532#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005533#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005534 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005536#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005537#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005538 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005540#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005541#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005542 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005544#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005545#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005546 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005548#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005549#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005550 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005552#endif
5553 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005555 }
5556}
5557
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005558/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005559 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005560 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005561 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005562int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005563{
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005565
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 if (group_list == NULL) {
5567 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005568 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005569
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 for (; *group_list != 0; group_list++) {
5571 if (*group_list == tls_id) {
5572 return 0;
5573 }
5574 }
5575
5576 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005577}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005578
Valerio Setti49e69072023-06-27 17:27:51 +02005579#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005580/*
5581 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005584{
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005586
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005588 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005592}
Valerio Setti49e69072023-06-27 17:27:51 +02005593#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005594
Valerio Setti18c9fed2022-12-30 17:44:24 +01005595static const struct {
5596 uint16_t tls_id;
5597 mbedtls_ecp_group_id ecp_group_id;
5598 psa_ecc_family_t psa_family;
5599 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005600} tls_id_match_table[] =
5601{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005602#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005603 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005604#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005605#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005606 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005608#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005609 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005611#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005612 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005613#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005614#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005615 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005616#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005617#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005618 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005620#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005621 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005623#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005624 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005625#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005626#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005627 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005628#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005629#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005630 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005631#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005632#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005633 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005634#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005635#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005636 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005638#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005639 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005640#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005641 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005642};
5643
Gilles Peskine449bd832023-01-11 14:50:10 +01005644int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005645 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647{
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5649 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005650 if (type != NULL) {
5651 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 }
5653 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005654 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656 return PSA_SUCCESS;
5657 }
5658 }
5659
5660 return PSA_ERROR_NOT_SUPPORTED;
5661}
5662
Gilles Peskine449bd832023-01-11 14:50:10 +01005663mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005664{
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5666 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005667 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005669 }
5670
5671 return MBEDTLS_ECP_DP_NONE;
5672}
5673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005675{
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5677 i++) {
5678 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005679 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005681 }
5682
5683 return 0;
5684}
5685
Valerio Setti67419f02023-01-04 16:12:42 +01005686#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005687static const struct {
5688 uint16_t tls_id;
5689 const char *name;
5690} tls_id_curve_name_table[] =
5691{
Valerio Setti54e23792023-07-07 10:49:27 +02005692 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5693 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5694 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5695 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5696 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5697 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5698 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5699 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5700 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5701 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5702 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5703 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5704 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005705 { 0, NULL },
5706};
5707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005709{
Valerio Settiacd32c02023-06-29 18:06:29 +02005710 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5711 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5712 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005714 }
5715
5716 return NULL;
5717}
Valerio Setti67419f02023-01-04 16:12:42 +01005718#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005721int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5722 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5723 int cert_endpoint,
5724 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005725{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005726 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005727 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005728 const char *ext_oid;
5729 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005732 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734 case MBEDTLS_KEY_EXCHANGE_RSA:
5735 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005736 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005737 break;
5738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005739 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5740 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5741 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5742 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005743 break;
5744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005745 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5746 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005747 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005748 break;
5749
5750 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751 case MBEDTLS_KEY_EXCHANGE_NONE:
5752 case MBEDTLS_KEY_EXCHANGE_PSK:
5753 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5754 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005755 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005756 usage = 0;
5757 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005759 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5760 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005761 }
5762
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005764 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005765 ret = -1;
5766 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005767
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005769 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5771 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005774 }
5775
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005777 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005778 ret = -1;
5779 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005780
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005782}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005783#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005784
Jerry Yu148165c2021-09-24 23:20:59 +08005785#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005786int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5787 const mbedtls_md_type_t md,
5788 unsigned char *dst,
5789 size_t dst_len,
5790 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005791{
Ronald Cronf6893e12022-01-07 22:09:01 +01005792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5793 psa_hash_operation_t *hash_operation_to_clone;
5794 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5795
Jerry Yu148165c2021-09-24 23:20:59 +08005796 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005797
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005799#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 case MBEDTLS_MD_SHA384:
5801 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5802 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005803#endif
5804
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005805#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 case MBEDTLS_MD_SHA256:
5807 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5808 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005809#endif
5810
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 default:
5812 goto exit;
5813 }
5814
5815 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5816 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005817 goto exit;
5818 }
5819
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5821 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005822 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005824
5825exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005826#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5827 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005828 (void) ssl;
5829#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005830 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005831}
5832#else /* MBEDTLS_USE_PSA_CRYPTO */
5833
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005834#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005836static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5837 unsigned char *dst,
5838 size_t dst_len,
5839 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005840{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005841 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005842 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005843
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 if (dst_len < 48) {
5845 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5846 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005847
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005848 mbedtls_md_init(&sha384);
5849 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005850 if (ret != 0) {
5851 goto exit;
5852 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005853 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005854 if (ret != 0) {
5855 goto exit;
5856 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005857
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005858 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005859 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860 goto exit;
5861 }
5862
5863 *olen = 48;
5864
5865exit:
5866
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005867 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005869}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005870#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005871
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005874static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5875 unsigned char *dst,
5876 size_t dst_len,
5877 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005878{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005880 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (dst_len < 32) {
5883 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5884 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005885
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005886 mbedtls_md_init(&sha256);
5887 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5888 if (ret != 0) {
5889 goto exit;
5890 }
5891 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5892 if (ret != 0) {
5893 goto exit;
5894 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005895
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005896 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5897 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005898 goto exit;
5899 }
5900
5901 *olen = 32;
5902
5903exit:
5904
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005905 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005907}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005908#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005909
Gilles Peskine449bd832023-01-11 14:50:10 +01005910int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5911 const mbedtls_md_type_t md,
5912 unsigned char *dst,
5913 size_t dst_len,
5914 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005915{
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005917
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005918#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 case MBEDTLS_MD_SHA384:
5920 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005921#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005922
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005923#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 case MBEDTLS_MD_SHA256:
5925 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005926#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005927
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005929#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5930 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 (void) ssl;
5932 (void) dst;
5933 (void) dst_len;
5934 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005935#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005939}
XiaokangQian647719a2021-12-07 09:16:29 +00005940
Jerry Yu148165c2021-09-24 23:20:59 +08005941#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005942
Ronald Crone68ab4f2022-10-05 12:46:29 +02005943#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005944/* mbedtls_ssl_parse_sig_alg_ext()
5945 *
5946 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5947 * value (TLS 1.3 RFC8446):
5948 * enum {
5949 * ....
5950 * ecdsa_secp256r1_sha256( 0x0403 ),
5951 * ecdsa_secp384r1_sha384( 0x0503 ),
5952 * ecdsa_secp521r1_sha512( 0x0603 ),
5953 * ....
5954 * } SignatureScheme;
5955 *
5956 * struct {
5957 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5958 * } SignatureSchemeList;
5959 *
5960 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5961 * value (TLS 1.2 RFC5246):
5962 * enum {
5963 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5964 * sha512(6), (255)
5965 * } HashAlgorithm;
5966 *
5967 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5968 * SignatureAlgorithm;
5969 *
5970 * struct {
5971 * HashAlgorithm hash;
5972 * SignatureAlgorithm signature;
5973 * } SignatureAndHashAlgorithm;
5974 *
5975 * SignatureAndHashAlgorithm
5976 * supported_signature_algorithms<2..2^16-2>;
5977 *
5978 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5979 * generalization of the TLS 1.2 signature algorithm extension.
5980 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5981 * `SignatureScheme` field of TLS 1.3
5982 *
5983 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005984int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5985 const unsigned char *buf,
5986 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005987{
5988 const unsigned char *p = buf;
5989 size_t supported_sig_algs_len = 0;
5990 const unsigned char *supported_sig_algs_end;
5991 uint16_t sig_alg;
5992 uint32_t common_idx = 0;
5993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5995 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005996 p += 2;
5997
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 memset(ssl->handshake->received_sig_algs, 0,
5999 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006000
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006002 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 while (p < supported_sig_algs_end) {
6004 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6005 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006006 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6008 sig_alg,
6009 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006010#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6012 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6013 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006014 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006015 }
6016#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6019 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006022 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6023 common_idx += 1;
6024 }
6025 }
6026 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 if (p != end) {
6028 MBEDTLS_SSL_DEBUG_MSG(1,
6029 ("Signature algorithms extension length misaligned"));
6030 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6031 MBEDTLS_ERR_SSL_DECODE_ERROR);
6032 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006033 }
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 if (common_idx == 0) {
6036 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6037 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6038 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6039 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006040 }
6041
Gabor Mezei15b95a62022-05-09 16:37:58 +02006042 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006044}
6045
Ronald Crone68ab4f2022-10-05 12:46:29 +02006046#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006047
Jerry Yudc7bd172022-02-17 13:44:15 +08006048#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6049
6050#if defined(MBEDTLS_USE_PSA_CRYPTO)
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6053 mbedtls_svc_key_id_t key,
6054 psa_algorithm_t alg,
6055 const unsigned char *raw_psk, size_t raw_psk_length,
6056 const unsigned char *seed, size_t seed_length,
6057 const unsigned char *label, size_t label_length,
6058 const unsigned char *other_secret,
6059 size_t other_secret_length,
6060 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006061{
6062 psa_status_t status;
6063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 status = psa_key_derivation_setup(derivation, alg);
6065 if (status != PSA_SUCCESS) {
6066 return status;
6067 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6070 status = psa_key_derivation_input_bytes(derivation,
6071 PSA_KEY_DERIVATION_INPUT_SEED,
6072 seed, seed_length);
6073 if (status != PSA_SUCCESS) {
6074 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006075 }
6076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 if (other_secret != NULL) {
6078 status = psa_key_derivation_input_bytes(derivation,
6079 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6080 other_secret, other_secret_length);
6081 if (status != PSA_SUCCESS) {
6082 return status;
6083 }
6084 }
6085
6086 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006087 status = psa_key_derivation_input_bytes(
6088 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 raw_psk, raw_psk_length);
6090 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006091 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 if (status != PSA_SUCCESS) {
6095 return status;
6096 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 status = psa_key_derivation_input_bytes(derivation,
6099 PSA_KEY_DERIVATION_INPUT_LABEL,
6100 label, label_length);
6101 if (status != PSA_SUCCESS) {
6102 return status;
6103 }
6104 } else {
6105 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006106 }
6107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 status = psa_key_derivation_set_capacity(derivation, capacity);
6109 if (status != PSA_SUCCESS) {
6110 return status;
6111 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006114}
6115
Andrzej Kurek57d10632022-10-24 10:32:01 -04006116#if defined(PSA_WANT_ALG_SHA_384) || \
6117 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006118MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006119static int tls_prf_generic(mbedtls_md_type_t md_type,
6120 const unsigned char *secret, size_t slen,
6121 const char *label,
6122 const unsigned char *random, size_t rlen,
6123 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006124{
6125 psa_status_t status;
6126 psa_algorithm_t alg;
6127 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6128 psa_key_derivation_operation_t derivation =
6129 PSA_KEY_DERIVATION_OPERATION_INIT;
6130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006132 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006134 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006136
6137 /* Normally a "secret" should be long enough to be impossible to
6138 * find by brute force, and in particular should not be empty. But
6139 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6140 * and for this use case it makes sense to have a 0-length "secret".
6141 * Since the key API doesn't allow importing a key of length 0,
6142 * keep master_key=0, which setup_psa_key_derivation() understands
6143 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006145 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6147 psa_set_key_algorithm(&key_attributes, alg);
6148 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6151 if (status != PSA_SUCCESS) {
6152 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6153 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006154 }
6155
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 status = setup_psa_key_derivation(&derivation,
6157 master_key, alg,
6158 NULL, 0,
6159 random, rlen,
6160 (unsigned char const *) label,
6161 (size_t) strlen(label),
6162 NULL, 0,
6163 dlen);
6164 if (status != PSA_SUCCESS) {
6165 psa_key_derivation_abort(&derivation);
6166 psa_destroy_key(master_key);
6167 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006168 }
6169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6171 if (status != PSA_SUCCESS) {
6172 psa_key_derivation_abort(&derivation);
6173 psa_destroy_key(master_key);
6174 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 }
6176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 status = psa_key_derivation_abort(&derivation);
6178 if (status != PSA_SUCCESS) {
6179 psa_destroy_key(master_key);
6180 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006181 }
6182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 if (!mbedtls_svc_key_id_is_null(master_key)) {
6184 status = psa_destroy_key(master_key);
6185 }
6186 if (status != PSA_SUCCESS) {
6187 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6188 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006191}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006192#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006193#else /* MBEDTLS_USE_PSA_CRYPTO */
6194
Andrzej Kurek57d10632022-10-24 10:32:01 -04006195#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006196 (defined(MBEDTLS_MD_CAN_SHA256) || \
6197 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006198MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006199static int tls_prf_generic(mbedtls_md_type_t md_type,
6200 const unsigned char *secret, size_t slen,
6201 const char *label,
6202 const unsigned char *random, size_t rlen,
6203 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006204{
6205 size_t nb;
6206 size_t i, j, k, md_len;
6207 unsigned char *tmp;
6208 size_t tmp_len = 0;
6209 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6210 const mbedtls_md_info_t *md_info;
6211 mbedtls_md_context_t md_ctx;
6212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6213
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006215
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6217 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6218 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006219
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 tmp_len = md_len + strlen(label) + rlen;
6223 tmp = mbedtls_calloc(1, tmp_len);
6224 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6226 goto exit;
6227 }
6228
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 nb = strlen(label);
6230 memcpy(tmp + md_len, label, nb);
6231 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 nb += rlen;
6233
6234 /*
6235 * Compute P_<hash>(secret, label + random)[0..dlen]
6236 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6242 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006243 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
6245 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6246 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 }
6249 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6250 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 for (i = 0; i < dlen; i += md_len) {
6255 ret = mbedtls_md_hmac_reset(&md_ctx);
6256 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 }
6259 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6260 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006261 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 }
6263 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6264 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006265 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 ret = mbedtls_md_hmac_reset(&md_ctx);
6269 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 }
6272 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6273 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006274 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 }
6276 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6277 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006282
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006284 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006286 }
6287
6288exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if (tmp != NULL) {
6292 mbedtls_platform_zeroize(tmp, tmp_len);
6293 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006298
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006300}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006301#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006302#endif /* MBEDTLS_USE_PSA_CRYPTO */
6303
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006304#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006306static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6307 const char *label,
6308 const unsigned char *random, size_t rlen,
6309 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006310{
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6312 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006313}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006314#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006315
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006316#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006317MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006318static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6319 const char *label,
6320 const unsigned char *random, size_t rlen,
6321 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006322{
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6324 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006325}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006326#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006327
Jerry Yuf009d862022-02-17 14:01:37 +08006328/*
6329 * Set appropriate PRF function and other SSL / TLS1.2 functions
6330 *
6331 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006332 * - hash associated with the ciphersuite (only used by TLS 1.2)
6333 *
6334 * Outputs:
6335 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6336 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006337MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006338static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6339 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006340{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006341#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006343 handshake->tls_prf = tls_prf_sha384;
6344 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6345 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006347#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006348#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006349 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006350 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006351 handshake->tls_prf = tls_prf_sha256;
6352 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6353 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6354 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006355#else
Jerry Yuf009d862022-02-17 14:01:37 +08006356 {
Jerry Yuf009d862022-02-17 14:01:37 +08006357 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006358 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006360 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006361#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006364}
Jerry Yud6ab2352022-02-17 14:03:43 +08006365
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366/*
6367 * Compute master secret if needed
6368 *
6369 * Parameters:
6370 * [in/out] handshake
6371 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6372 * (PSA-PSK) ciphersuite_info, psk_opaque
6373 * [out] premaster (cleared)
6374 * [out] master
6375 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6376 * debug: conf->f_dbg, conf->p_dbg
6377 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006378 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006379 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006381static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6382 unsigned char *master,
6383 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006384{
6385 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6386
6387 /* cf. RFC 5246, Section 8.1:
6388 * "The master secret is always exactly 48 bytes in length." */
6389 size_t const master_secret_len = 48;
6390
6391#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6392 unsigned char session_hash[48];
6393#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6394
6395 /* The label for the KDF used for key expansion.
6396 * This is either "master secret" or "extended master secret"
6397 * depending on whether the Extended Master Secret extension
6398 * is used. */
6399 char const *lbl = "master secret";
6400
Przemek Stekielae4ed302022-04-05 17:15:55 +02006401 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006402 * - If the Extended Master Secret extension is not used,
6403 * this is ClientHello.Random + ServerHello.Random
6404 * (see Sect. 8.1 in RFC 5246).
6405 * - If the Extended Master Secret extension is used,
6406 * this is the transcript of the handshake so far.
6407 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006408 unsigned char const *seed = handshake->randbytes;
6409 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410
6411#if !defined(MBEDTLS_DEBUG_C) && \
6412 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6413 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006415 ssl = NULL; /* make sure we don't use it except for those cases */
6416 (void) ssl;
6417#endif
6418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 if (handshake->resume != 0) {
6420 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6421 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 }
6423
6424#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006427 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006428 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6429 if (ret != 0) {
6430 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6431 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6434 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006436#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437
Przemek Stekiel99114f32022-04-22 11:20:09 +02006438#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006439 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006441 /* Perform PSK-to-MS expansion in a single step. */
6442 psa_status_t status;
6443 psa_algorithm_t alg;
6444 mbedtls_svc_key_id_t psk;
6445 psa_key_derivation_operation_t derivation =
6446 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006447 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006450
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006452
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006456 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006459 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006463 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006464 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006465 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006466 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006467 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006468 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006469 other_secret_len = 48;
6470 other_secret = handshake->premaster + 2;
6471 break;
6472 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006473 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006474 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6475 other_secret = handshake->premaster + 2;
6476 break;
6477 default:
6478 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006479 }
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 status = setup_psa_key_derivation(&derivation, psk, alg,
6482 ssl->conf->psk, ssl->conf->psk_len,
6483 seed, seed_len,
6484 (unsigned char const *) lbl,
6485 (size_t) strlen(lbl),
6486 other_secret, other_secret_len,
6487 master_secret_len);
6488 if (status != PSA_SUCCESS) {
6489 psa_key_derivation_abort(&derivation);
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_key_derivation_output_bytes(&derivation,
6494 master,
6495 master_secret_len);
6496 if (status != PSA_SUCCESS) {
6497 psa_key_derivation_abort(&derivation);
6498 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006499 }
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 status = psa_key_derivation_abort(&derivation);
6502 if (status != PSA_SUCCESS) {
6503 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6504 }
6505 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006506#endif
6507 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006508#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6510 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006511 psa_status_t status;
6512 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6513 psa_key_derivation_operation_t derivation =
6514 PSA_KEY_DERIVATION_OPERATION_INIT;
6515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006517
6518 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 status = psa_key_derivation_setup(&derivation, alg);
6521 if (status != PSA_SUCCESS) {
6522 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006523 }
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 status = psa_key_derivation_set_capacity(&derivation,
6526 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6527 if (status != PSA_SUCCESS) {
6528 psa_key_derivation_abort(&derivation);
6529 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006530 }
6531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6533 &derivation);
6534 if (status != PSA_SUCCESS) {
6535 psa_key_derivation_abort(&derivation);
6536 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006537 }
6538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 status = psa_key_derivation_output_bytes(&derivation,
6540 handshake->premaster,
6541 handshake->pmslen);
6542 if (status != PSA_SUCCESS) {
6543 psa_key_derivation_abort(&derivation);
6544 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6545 }
6546
6547 status = psa_key_derivation_abort(&derivation);
6548 if (status != PSA_SUCCESS) {
6549 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006550 }
6551 }
6552#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6554 lbl, seed, seed_len,
6555 master,
6556 master_secret_len);
6557 if (ret != 0) {
6558 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6559 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006560 }
6561
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6563 handshake->premaster,
6564 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 mbedtls_platform_zeroize(handshake->premaster,
6567 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006568 }
6569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006571}
6572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006574{
6575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6576 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6577 ssl->handshake->ciphersuite_info;
6578
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006580
6581 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006583 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 if (ret != 0) {
6585 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6586 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006587 }
6588
6589 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 ret = ssl_compute_master(ssl->handshake,
6591 ssl->session_negotiate->master,
6592 ssl);
6593 if (ret != 0) {
6594 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6595 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006596 }
6597
6598 /* Swap the client and server random values:
6599 * - MS derivation wanted client+server (RFC 5246 8.1)
6600 * - key derivation wants server+client (RFC 5246 6.3) */
6601 {
6602 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 memcpy(tmp, ssl->handshake->randbytes, 64);
6604 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6605 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6606 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006607 }
6608
6609 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6611 ssl->session_negotiate->ciphersuite,
6612 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006613#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006615#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 ssl->handshake->tls_prf,
6617 ssl->handshake->randbytes,
6618 ssl->tls_version,
6619 ssl->conf->endpoint,
6620 ssl);
6621 if (ret != 0) {
6622 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6623 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006624 }
6625
6626 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6628 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006629
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006633}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006636{
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006638#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006639 case MBEDTLS_SSL_HASH_SHA384:
6640 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6641 break;
6642#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006643#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006644 case MBEDTLS_SSL_HASH_SHA256:
6645 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6646 break;
6647#endif
6648 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006650 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006651#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6652 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006653 (void) ssl;
6654#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006656}
6657
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006658#if defined(MBEDTLS_USE_PSA_CRYPTO)
6659static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6660 const psa_hash_operation_t *hs_op,
6661 size_t buffer_size,
6662 unsigned char *hash,
6663 size_t *hlen)
6664{
6665 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006666 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006667
6668#if !defined(MBEDTLS_DEBUG_C)
6669 (void) ssl;
6670#endif
6671 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006672 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006673 if (status != PSA_SUCCESS) {
6674 goto exit;
6675 }
6676
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006677 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678 if (status != PSA_SUCCESS) {
6679 goto exit;
6680 }
6681
6682 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6683 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6684
6685exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006686 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006687 return mbedtls_md_error_from_psa(status);
6688}
6689#else
6690static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6691 const mbedtls_md_context_t *hs_ctx,
6692 unsigned char *hash,
6693 size_t *hlen)
6694{
6695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006696 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006697
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006698 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006699
6700#if !defined(MBEDTLS_DEBUG_C)
6701 (void) ssl;
6702#endif
6703 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6704
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006705 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006706 if (ret != 0) {
6707 goto exit;
6708 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006709 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006710 if (ret != 0) {
6711 goto exit;
6712 }
6713
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006714 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006715 if (ret != 0) {
6716 goto exit;
6717 }
6718
6719 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6720
6721 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6722 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6723
6724exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006725 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006726 return ret;
6727}
6728#endif /* MBEDTLS_USE_PSA_CRYPTO */
6729
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006730#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006731int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6732 unsigned char *hash,
6733 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006734{
6735#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006736 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6737 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006738#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006739 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6740 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006741#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006742}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006743#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006744
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006745#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006746int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6747 unsigned char *hash,
6748 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006749{
6750#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006751 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6752 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006753#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006754 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6755 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006756#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006757}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006758#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006759
Neil Armstrong80f6f322022-05-03 17:56:38 +02006760#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6761 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006762int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006763{
6764 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006766 const unsigned char *psk = NULL;
6767 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006769
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006771 /*
6772 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006773 * checked before calling this function.
6774 *
6775 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006776 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006777 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6779 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6780 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006781 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006782 }
6783
6784 /*
6785 * PMS = struct {
6786 * opaque other_secret<0..2^16-1>;
6787 * opaque psk<0..2^16-1>;
6788 * };
6789 * with "other_secret" depending on the particular key exchange
6790 */
6791#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6793 if (end - p < 2) {
6794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6795 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006798 p += 2;
6799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 if (end < p || (size_t) (end - p) < psk_len) {
6801 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6802 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006805 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006807#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6808#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006810 /*
6811 * other_secret already set by the ClientKeyExchange message,
6812 * and is 48 bytes long
6813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if (end - p < 2) {
6815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6816 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006817
6818 *p++ = 0;
6819 *p++ = 48;
6820 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006822#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6823#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6826 size_t len;
6827
6828 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6830 p + 2, end - (p + 2), &len,
6831 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6832 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6833 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006834 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006836 p += 2 + len;
6837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6839 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006840#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006841#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6844 size_t zlen;
6845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6847 p + 2, end - (p + 2),
6848 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6849 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6850 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006851 }
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006854 p += 2 + zlen;
6855
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6857 MBEDTLS_DEBUG_ECDH_Z);
6858 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006859#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006860 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6862 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006863 }
6864
6865 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 if (end - p < 2) {
6867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6868 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006871 p += 2;
6872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 if (end < p || (size_t) (end - p) < psk_len) {
6874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6875 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006878 p += psk_len;
6879
6880 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006883}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006884#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006885
6886#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006887MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006888static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006889
6890#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006891int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006892{
6893 /* If renegotiation is not enforced, retransmit until we would reach max
6894 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006896 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6897 unsigned char doublings = 1;
6898
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006900 ++doublings;
6901 ratio >>= 1;
6902 }
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (++ssl->renego_records_seen > doublings) {
6905 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6906 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006907 }
6908 }
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006911}
6912#endif
6913#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006914
Jerry Yud9526692022-02-17 14:23:47 +08006915/*
6916 * Handshake functions
6917 */
6918#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6919/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006920int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006921{
6922 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6923 ssl->handshake->ciphersuite_info;
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6928 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006929 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006931 }
6932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6934 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006935}
6936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006938{
6939 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6940 ssl->handshake->ciphersuite_info;
6941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6945 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006946 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006948 }
6949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6951 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006952}
6953
6954#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6955/* Some certificate support -> implement write and parse */
6956
Gilles Peskine449bd832023-01-11 14:50:10 +01006957int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006958{
6959 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6960 size_t i, n;
6961 const mbedtls_x509_crt *crt;
6962 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6963 ssl->handshake->ciphersuite_info;
6964
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006966
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6968 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006969 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006971 }
6972
6973#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6975 if (ssl->handshake->client_auth == 0) {
6976 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006977 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006979 }
6980 }
6981#endif /* MBEDTLS_SSL_CLI_C */
6982#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6984 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006985 /* Should never happen because we shouldn't have picked the
6986 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006988 }
6989 }
6990#endif
6991
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006993
6994 /*
6995 * 0 . 0 handshake type
6996 * 1 . 3 handshake length
6997 * 4 . 6 length of all certs
6998 * 7 . 9 length of cert. 1
6999 * 10 . n-1 peer certificate
7000 * n . n+2 length of cert. 2
7001 * n+3 . ... upper level cert, etc.
7002 */
7003 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007007 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7009 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7010 " > %" MBEDTLS_PRINTF_SIZET,
7011 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7012 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007013 }
7014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7016 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7017 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007018
Gilles Peskine449bd832023-01-11 14:50:10 +01007019 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007020 i += n; crt = crt->next;
7021 }
7022
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7024 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7025 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007026
7027 ssl->out_msglen = i;
7028 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7029 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7030
7031 ssl->state++;
7032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7034 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7035 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007036 }
7037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007039
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007041}
7042
7043#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7044
7045#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007047static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7048 unsigned char *crt_buf,
7049 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007050{
7051 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 if (peer_crt == NULL) {
7054 return -1;
7055 }
Jerry Yud9526692022-02-17 14:23:47 +08007056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 if (peer_crt->raw.len != crt_buf_len) {
7058 return -1;
7059 }
Jerry Yud9526692022-02-17 14:23:47 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007062}
7063#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007064MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007065static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7066 unsigned char *crt_buf,
7067 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007068{
7069 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7070 unsigned char const * const peer_cert_digest =
7071 ssl->session->peer_cert_digest;
7072 mbedtls_md_type_t const peer_cert_digest_type =
7073 ssl->session->peer_cert_digest_type;
7074 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007076 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7077 size_t digest_len;
7078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (peer_cert_digest == NULL || digest_info == NULL) {
7080 return -1;
7081 }
Jerry Yud9526692022-02-17 14:23:47 +08007082
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 digest_len = mbedtls_md_get_size(digest_info);
7084 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7085 return -1;
7086 }
Jerry Yud9526692022-02-17 14:23:47 +08007087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7089 if (ret != 0) {
7090 return -1;
7091 }
Jerry Yud9526692022-02-17 14:23:47 +08007092
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007094}
7095#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7096#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7097
7098/*
7099 * Once the certificate message is read, parse it into a cert chain and
7100 * perform basic checks, but leave actual verification to the caller
7101 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007103static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7104 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007105{
7106 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7107#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007109#endif
7110 size_t i, n;
7111 uint8_t alert;
7112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7114 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7115 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7116 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7117 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007118 }
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7121 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7122 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7123 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007124 }
7125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7127 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7128 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7129 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7130 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007131 }
7132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007134
7135 /*
7136 * Same message structure as in mbedtls_ssl_write_certificate()
7137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 if (ssl->in_msg[i] != 0 ||
7141 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7142 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7143 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7144 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7145 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147
7148 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7149 i += 3;
7150
7151 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007153 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 if (i + 3 > ssl->in_hslen) {
7155 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7156 mbedtls_ssl_send_alert_message(ssl,
7157 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7158 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7159 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007160 }
7161 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7162 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 if (ssl->in_msg[i] != 0) {
7164 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7165 mbedtls_ssl_send_alert_message(ssl,
7166 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7167 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7168 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007169 }
7170
7171 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007173 | (unsigned int) ssl->in_msg[i + 2];
7174 i += 3;
7175
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (n < 128 || i + n > ssl->in_hslen) {
7177 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7178 mbedtls_ssl_send_alert_message(ssl,
7179 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7180 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7181 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007182 }
7183
7184 /* Check if we're handling the first CRT in the chain. */
7185#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007187 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007189 /* During client-side renegotiation, check that the server's
7190 * end-CRTs hasn't changed compared to the initial handshake,
7191 * mitigating the triple handshake attack. On success, reuse
7192 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7194 if (ssl_check_peer_crt_unchanged(ssl,
7195 &ssl->in_msg[i],
7196 n) != 0) {
7197 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7198 mbedtls_ssl_send_alert_message(ssl,
7199 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7200 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7201 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007202 }
7203
7204 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007206 }
7207#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7208
7209 /* Parse the next certificate in the chain. */
7210#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007212#else
7213 /* If we don't need to store the CRT chain permanently, parse
7214 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007216#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007218 case 0: /*ok*/
7219 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7220 /* Ignore certificate with an unknown algorithm: maybe a
7221 prior certificate was already trusted. */
7222 break;
7223
7224 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7225 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7226 goto crt_parse_der_failed;
7227
7228 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7229 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7230 goto crt_parse_der_failed;
7231
7232 default:
7233 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007234crt_parse_der_failed:
7235 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7236 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7237 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007238 }
7239
7240 i += n;
7241 }
7242
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7244 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007245}
7246
7247#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007248MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007249static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007250{
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7252 return -1;
7253 }
Jerry Yud9526692022-02-17 14:23:47 +08007254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007256 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7257 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7259 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7260 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007261 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007263}
7264#endif /* MBEDTLS_SSL_SRV_C */
7265
7266/* Check if a certificate message is expected.
7267 * Return either
7268 * - SSL_CERTIFICATE_EXPECTED, or
7269 * - SSL_CERTIFICATE_SKIP
7270 * indicating whether a Certificate message is expected or not.
7271 */
7272#define SSL_CERTIFICATE_EXPECTED 0
7273#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007274MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007275static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7276 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007277{
7278 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7279 ssl->handshake->ciphersuite_info;
7280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7282 return SSL_CERTIFICATE_SKIP;
7283 }
Jerry Yud9526692022-02-17 14:23:47 +08007284
7285#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7287 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7288 return SSL_CERTIFICATE_SKIP;
7289 }
Jerry Yud9526692022-02-17 14:23:47 +08007290
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007292 ssl->session_negotiate->verify_result =
7293 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007295 }
7296 }
7297#else
7298 ((void) authmode);
7299#endif /* MBEDTLS_SSL_SRV_C */
7300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007302}
7303
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007305static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7306 int authmode,
7307 mbedtls_x509_crt *chain,
7308 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007309{
7310 int ret = 0;
7311 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7312 ssl->handshake->ciphersuite_info;
7313 int have_ca_chain = 0;
7314
7315 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7316 void *p_vrfy;
7317
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7319 return 0;
7320 }
Jerry Yud9526692022-02-17 14:23:47 +08007321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (ssl->f_vrfy != NULL) {
7323 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007324 f_vrfy = ssl->f_vrfy;
7325 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 } else {
7327 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007328 f_vrfy = ssl->conf->f_vrfy;
7329 p_vrfy = ssl->conf->p_vrfy;
7330 }
7331
7332 /*
7333 * Main check: verify certificate
7334 */
7335#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007337 ((void) rs_ctx);
7338 have_ca_chain = 1;
7339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007341 ret = mbedtls_x509_crt_verify_with_ca_cb(
7342 chain,
7343 ssl->conf->f_ca_cb,
7344 ssl->conf->p_ca_cb,
7345 ssl->conf->cert_profile,
7346 ssl->hostname,
7347 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 f_vrfy, p_vrfy);
7349 } else
Jerry Yud9526692022-02-17 14:23:47 +08007350#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7351 {
7352 mbedtls_x509_crt *ca_chain;
7353 mbedtls_x509_crl *ca_crl;
7354
7355#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007357 ca_chain = ssl->handshake->sni_ca_chain;
7358 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 } else
Jerry Yud9526692022-02-17 14:23:47 +08007360#endif
7361 {
7362 ca_chain = ssl->conf->ca_chain;
7363 ca_crl = ssl->conf->ca_crl;
7364 }
7365
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007367 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 }
Jerry Yud9526692022-02-17 14:23:47 +08007369
7370 ret = mbedtls_x509_crt_verify_restartable(
7371 chain,
7372 ca_chain, ca_crl,
7373 ssl->conf->cert_profile,
7374 ssl->hostname,
7375 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007377 }
7378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (ret != 0) {
7380 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007381 }
7382
7383#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7385 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7386 }
Jerry Yud9526692022-02-17 14:23:47 +08007387#endif
7388
7389 /*
7390 * Secondary checks: always done, but change 'ret' only if it was 0
7391 */
7392
Valerio Settiacd32c02023-06-29 18:06:29 +02007393#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007394 {
7395 const mbedtls_pk_context *pk = &chain->pk;
7396
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007397 /* If certificate uses an EC key, make sure the curve is OK.
7398 * This is a public key, so it can't be opaque, so can_do() is a good
7399 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007401 /* and in the unlikely case the above assumption no longer holds
7402 * we are making sure that pk_ec() here does not return a NULL
7403 */
Valerio Settid0405092023-05-24 13:16:40 +02007404 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7405 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7406 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007408 }
Valerio Setti97207782023-05-18 18:59:06 +02007409 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007410 ssl->session_negotiate->verify_result |=
7411 MBEDTLS_X509_BADCERT_BAD_KEY;
7412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7414 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007415 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007417 }
Jerry Yud9526692022-02-17 14:23:47 +08007418 }
7419 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007420#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007421
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (mbedtls_ssl_check_cert_usage(chain,
7423 ciphersuite_info,
7424 !ssl->conf->endpoint,
7425 &ssl->session_negotiate->verify_result) != 0) {
7426 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7427 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 }
Jerry Yud9526692022-02-17 14:23:47 +08007430 }
7431
7432 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7433 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7434 * with details encoded in the verification flags. All other kinds
7435 * of error codes, including those from the user provided f_vrfy
7436 * functions, are treated as fatal and lead to a failure of
7437 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7439 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7440 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007441 ret = 0;
7442 }
7443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7445 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007446 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7447 }
7448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007450 uint8_t alert;
7451
7452 /* The certificate may have been rejected for several reasons.
7453 Pick one and send the corresponding alert. Which alert to send
7454 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007456 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007458 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007460 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007462 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007464 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007466 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007468 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007470 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007472 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007474 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007476 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 }
7478 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7479 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007480 }
7481
7482#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (ssl->session_negotiate->verify_result != 0) {
7484 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7485 (unsigned int) ssl->session_negotiate->verify_result));
7486 } else {
7487 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007488 }
7489#endif /* MBEDTLS_DEBUG_C */
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007492}
7493
7494#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007495MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007496static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7497 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007498{
7499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7500 /* Remember digest of the peer's end-CRT. */
7501 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7503 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7504 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7505 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7506 mbedtls_ssl_send_alert_message(ssl,
7507 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7508 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007511 }
7512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 ret = mbedtls_md(mbedtls_md_info_from_type(
7514 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7515 start, len,
7516 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007517
7518 ssl->session_negotiate->peer_cert_digest_type =
7519 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7520 ssl->session_negotiate->peer_cert_digest_len =
7521 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007524}
7525
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007526MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007527static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7528 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007529{
7530 unsigned char *end = start + len;
7531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7532
7533 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7535 ret = mbedtls_pk_parse_subpubkey(&start, end,
7536 &ssl->handshake->peer_pubkey);
7537 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007538 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007540 }
7541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007543}
7544#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007547{
7548 int ret = 0;
7549 int crt_expected;
7550#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7551 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7552 ? ssl->handshake->sni_authmode
7553 : ssl->conf->authmode;
7554#else
7555 const int authmode = ssl->conf->authmode;
7556#endif
7557 void *rs_ctx = NULL;
7558 mbedtls_x509_crt *chain = NULL;
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7563 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7564 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007565 goto exit;
7566 }
7567
7568#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (ssl->handshake->ecrs_enabled &&
7570 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007571 chain = ssl->handshake->ecrs_peer_cert;
7572 ssl->handshake->ecrs_peer_cert = NULL;
7573 goto crt_verify;
7574 }
7575#endif
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007578 /* mbedtls_ssl_read_record may have sent an alert already. We
7579 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007581 goto exit;
7582 }
7583
7584#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007586 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007589 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 }
Jerry Yud9526692022-02-17 14:23:47 +08007591
7592 goto exit;
7593 }
7594#endif /* MBEDTLS_SSL_SRV_C */
7595
7596 /* Clear existing peer CRT structure in case we tried to
7597 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7601 if (chain == NULL) {
7602 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7603 sizeof(mbedtls_x509_crt)));
7604 mbedtls_ssl_send_alert_message(ssl,
7605 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7606 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007607
7608 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7609 goto exit;
7610 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 ret = ssl_parse_certificate_chain(ssl, chain);
7614 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007615 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
Jerry Yud9526692022-02-17 14:23:47 +08007617
7618#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007620 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 }
Jerry Yud9526692022-02-17 14:23:47 +08007622
7623crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007625 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 }
Jerry Yud9526692022-02-17 14:23:47 +08007627#endif
7628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 ret = ssl_parse_certificate_verify(ssl, authmode,
7630 chain, rs_ctx);
7631 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007632 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 }
Jerry Yud9526692022-02-17 14:23:47 +08007634
7635#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7636 {
7637 unsigned char *crt_start, *pk_start;
7638 size_t crt_len, pk_len;
7639
7640 /* We parse the CRT chain without copying, so
7641 * these pointers point into the input buffer,
7642 * and are hence still valid after freeing the
7643 * CRT chain. */
7644
7645 crt_start = chain->raw.p;
7646 crt_len = chain->raw.len;
7647
7648 pk_start = chain->pk_raw.p;
7649 pk_len = chain->pk_raw.len;
7650
7651 /* Free the CRT structures before computing
7652 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 mbedtls_x509_crt_free(chain);
7654 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007655 chain = NULL;
7656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7658 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 }
Jerry Yud9526692022-02-17 14:23:47 +08007661
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7663 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007664 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 }
Jerry Yud9526692022-02-17 14:23:47 +08007666 }
7667#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7668 /* Pass ownership to session structure. */
7669 ssl->session_negotiate->peer_cert = chain;
7670 chain = NULL;
7671#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007674
7675exit:
7676
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007678 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 }
Jerry Yud9526692022-02-17 14:23:47 +08007680
7681#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007683 ssl->handshake->ecrs_peer_cert = chain;
7684 chain = NULL;
7685 }
7686#endif
7687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 if (chain != NULL) {
7689 mbedtls_x509_crt_free(chain);
7690 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007691 }
7692
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007694}
7695#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7696
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007697static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7698 unsigned char *padbuf, size_t hlen,
7699 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007700{
7701 int len = 12;
7702 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007703#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007704 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007705 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007706 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007707 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007708#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007710 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007711 mbedtls_md_context_t cloned_ctx;
7712 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007713#endif
7714
7715 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007719
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007721 ? "client finished"
7722 : "server finished";
7723
7724#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007725 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007726
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007727 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007729 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007730 }
7731
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007732 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007734 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007735 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007736 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007737#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007738 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007739
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007740 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007741 if (ret != 0) {
7742 goto exit;
7743 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007744 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007745 if (ret != 0) {
7746 goto exit;
7747 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007748
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007749 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007750 if (ret != 0) {
7751 goto exit;
7752 }
7753#endif /* MBEDTLS_USE_PSA_CRYPTO */
7754
7755 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7756
Jerry Yu615bd6f2022-02-17 14:25:15 +08007757 /*
7758 * TLSv1.2:
7759 * hash = PRF( master, finished_label,
7760 * Hash( handshake ) )[0.11]
7761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007763 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007766
Paul Elliottecb95be2023-08-11 16:41:04 +01007767 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007768
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007769 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007770
7771exit:
7772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007773 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007774 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007775#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007776 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007777 return ret;
7778#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007779}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007780
7781#if defined(MBEDTLS_MD_CAN_SHA256)
7782static int ssl_calc_finished_tls_sha256(
7783 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7784{
7785 unsigned char padbuf[32];
7786 return ssl_calc_finished_tls_generic(ssl,
7787#if defined(MBEDTLS_USE_PSA_CRYPTO)
7788 &ssl->handshake->fin_sha256_psa,
7789#else
7790 &ssl->handshake->fin_sha256,
7791#endif
7792 padbuf, sizeof(padbuf),
7793 buf, from);
7794}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007795#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007796
Jerry Yub7ba49e2022-02-17 14:25:53 +08007797
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007798#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007799static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007801{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007802 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007803 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007804#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007805 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007806#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007807 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007808#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007809 padbuf, sizeof(padbuf),
7810 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007811}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007812#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007813
Gilles Peskine449bd832023-01-11 14:50:10 +01007814void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007815{
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007817
7818 /*
7819 * Free our handshake params
7820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 mbedtls_ssl_handshake_free(ssl);
7822 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007823 ssl->handshake = NULL;
7824
7825 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007826 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007827 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 if (ssl->transform) {
7829 mbedtls_ssl_transform_free(ssl->transform);
7830 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007831 }
7832 ssl->transform = ssl->transform_negotiate;
7833 ssl->transform_negotiate = NULL;
7834
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007836}
7837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007839{
7840 int resume = ssl->handshake->resume;
7841
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007843
7844#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007846 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7847 ssl->renego_records_seen = 0;
7848 }
7849#endif
7850
7851 /*
7852 * Free the previous session and switch in the current one
7853 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007855#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7856 /* RFC 7366 3.1: keep the EtM state */
7857 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007859#endif
7860
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 mbedtls_ssl_session_free(ssl->session);
7862 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007863 }
7864 ssl->session = ssl->session_negotiate;
7865 ssl->session_negotiate = NULL;
7866
7867 /*
7868 * Add cache entry
7869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007871 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 resume == 0) {
7873 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7874 ssl->session->id,
7875 ssl->session->id_len,
7876 ssl->session) != 0) {
7877 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7878 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007879 }
7880
7881#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7883 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007884 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007886
7887 /* Keep last flight around in case we need to resend it:
7888 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7890 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007891#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007893
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007894 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007895
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007897}
7898
Gilles Peskine449bd832023-01-11 14:50:10 +01007899int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007900{
7901 int ret, hash_len;
7902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007906
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007907 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7908 if (ret != 0) {
7909 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7910 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007911
7912 /*
7913 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7914 * may define some other value. Currently (early 2016), no defined
7915 * ciphersuite does this (and this is unlikely to change as activity has
7916 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7917 */
7918 hash_len = 12;
7919
7920#if defined(MBEDTLS_SSL_RENEGOTIATION)
7921 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007923#endif
7924
7925 ssl->out_msglen = 4 + hash_len;
7926 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7927 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7928
7929 /*
7930 * In case of session resuming, invert the client and server
7931 * ChangeCipherSpec messages order.
7932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007934#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007936 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007938#endif
7939#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007943#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007945 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007947
7948 /*
7949 * Switch to our negotiated transform and session parameters for outbound
7950 * data.
7951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953
7954#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007956 unsigned char i;
7957
7958 /* Remember current epoch settings for resending */
7959 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7961 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962
7963 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007965
7966
7967 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 for (i = 2; i > 0; i--) {
7969 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007970 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 }
7972 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973
7974 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (i == 0) {
7976 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7977 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007978 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007980#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982
7983 ssl->transform_out = ssl->transform_negotiate;
7984 ssl->session_out = ssl->session_negotiate;
7985
7986#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7988 mbedtls_ssl_send_flight_completed(ssl);
7989 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007990#endif
7991
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7993 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7994 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007995 }
7996
7997#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7999 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8000 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8001 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008002 }
8003#endif
8004
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008006
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008008}
8009
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008010#define SSL_MAX_HASH_LEN 12
8011
Gilles Peskine449bd832023-01-11 14:50:10 +01008012int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008013{
8014 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8015 unsigned int hash_len = 12;
8016 unsigned char buf[SSL_MAX_HASH_LEN];
8017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008019
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008020 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8021 if (ret != 0) {
8022 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8023 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8026 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008027 goto exit;
8028 }
8029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8031 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8032 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8033 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008034 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8035 goto exit;
8036 }
8037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8039 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8040 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008041 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8042 goto exit;
8043 }
8044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8046 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8047 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8048 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8050 goto exit;
8051 }
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8054 buf, hash_len) != 0) {
8055 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8056 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8057 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008058 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8059 goto exit;
8060 }
8061
8062#if defined(MBEDTLS_SSL_RENEGOTIATION)
8063 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008065#endif
8066
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008068#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008070 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008072#endif
8073#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008075 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008077#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008079 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008081
8082#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8084 mbedtls_ssl_recv_flight_completed(ssl);
8085 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008086#endif
8087
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089
8090exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 mbedtls_platform_zeroize(buf, hash_len);
8092 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008093}
8094
Jerry Yu392112c2022-02-17 14:34:10 +08008095#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8096/*
8097 * Helper to get TLS 1.2 PRF from ciphersuite
8098 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8099 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008100static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008101{
Jerry Yu392112c2022-02-17 14:34:10 +08008102 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008104#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8106 return tls_prf_sha384;
8107 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008108#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008109#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008110 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8112 return tls_prf_sha256;
8113 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008114 }
8115#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008116#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8117 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008118 (void) ciphersuite_info;
8119#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008120
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008122}
8123#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008124
Gilles Peskine449bd832023-01-11 14:50:10 +01008125static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008126{
8127 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008128#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 if (tls_prf == tls_prf_sha384) {
8130 return MBEDTLS_SSL_TLS_PRF_SHA384;
8131 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008132#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008133#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 if (tls_prf == tls_prf_sha256) {
8135 return MBEDTLS_SSL_TLS_PRF_SHA256;
8136 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008137#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008139}
8140
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008141/*
8142 * Populate a transform structure with session keys and all the other
8143 * necessary information.
8144 *
8145 * Parameters:
8146 * - [in/out]: transform: structure to populate
8147 * [in] must be just initialised with mbedtls_ssl_transform_init()
8148 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8149 * - [in] ciphersuite
8150 * - [in] master
8151 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008152 * - [in] tls_prf: pointer to PRF to use for key derivation
8153 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008154 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008155 * - [in] endpoint: client or server
8156 * - [in] ssl: used for:
8157 * - ssl->conf->{f,p}_export_keys
8158 * [in] optionally used for:
8159 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8160 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008161MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008162static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8163 int ciphersuite,
8164 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008165#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008167#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 ssl_tls_prf_t tls_prf,
8169 const unsigned char randbytes[64],
8170 mbedtls_ssl_protocol_version tls_version,
8171 unsigned endpoint,
8172 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008173{
8174 int ret = 0;
8175 unsigned char keyblk[256];
8176 unsigned char *key1;
8177 unsigned char *key2;
8178 unsigned char *mac_enc;
8179 unsigned char *mac_dec;
8180 size_t mac_key_len = 0;
8181 size_t iv_copy_len;
8182 size_t keylen;
8183 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008184 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008185#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008186 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008187 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008188#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189
8190#if defined(MBEDTLS_USE_PSA_CRYPTO)
8191 psa_key_type_t key_type;
8192 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8193 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008194 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008195 size_t key_bits;
8196 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8197#endif
8198
8199#if !defined(MBEDTLS_DEBUG_C) && \
8200 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008202 ssl = NULL; /* make sure we don't use it except for these cases */
8203 (void) ssl;
8204 }
8205#endif
8206
8207 /*
8208 * Some data just needs copying into the structure
8209 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008210#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008211 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008212#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008213 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008214
8215#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008217#endif
8218
8219#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008221 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8222 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008224 }
8225#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8226
8227 /*
8228 * Get various info structures
8229 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8231 if (ciphersuite_info == NULL) {
8232 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8233 ciphersuite));
8234 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235 }
8236
Neil Armstrongab555e02022-04-04 11:07:59 +02008237 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008238#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008240#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008242
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008244 transform->taglen =
8245 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008247
8248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008249 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 transform->taglen,
8251 &alg,
8252 &key_type,
8253 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008254 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008256 goto end;
8257 }
8258#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008259 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 if (cipher_info == NULL) {
8261 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8262 ciphersuite_info->cipher));
8263 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008264 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008265#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008266
Neil Armstronge4512952022-03-08 09:08:22 +01008267#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008268 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008270 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 (unsigned) ciphersuite_info->mac));
8272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008273 }
8274#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008275 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 if (md_info == NULL) {
8277 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8278 (unsigned) ciphersuite_info->mac));
8279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280 }
Neil Armstronge4512952022-03-08 09:08:22 +01008281#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008282
8283#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8284 /* Copy own and peer's CID if the use of the CID
8285 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8287 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008288
8289 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8291 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8292 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008293
8294 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8296 ssl->handshake->peer_cid_len);
8297 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8298 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008299 }
8300#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8301
8302 /*
8303 * Compute key block using the PRF
8304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8306 if (ret != 0) {
8307 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8308 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008309 }
8310
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8312 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8313 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8314 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8315 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008316
8317 /*
8318 * Determine the appropriate key, IV and MAC length.
8319 */
8320
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008321#if defined(MBEDTLS_USE_PSA_CRYPTO)
8322 keylen = PSA_BITS_TO_BYTES(key_bits);
8323#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008325#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008326
Valerio Settie5707042023-10-11 11:54:42 +02008327#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008329 size_t explicit_ivlen;
8330
8331 transform->maclen = 0;
8332 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008333
8334 /* All modes haves 96-bit IVs, but the length of the static parts vary
8335 * with mode and version:
8336 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8337 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8338 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8339 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8340 * sequence number).
8341 */
8342 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008343
8344 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008347#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8349 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008350#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008351
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008353 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008357
8358 /* Minimum length of encrypted record */
8359 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8360 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 } else
Valerio Settie5707042023-10-11 11:54:42 +02008362#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008365 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008367#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008369#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008370 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008371#endif /* MBEDTLS_USE_PSA_CRYPTO */
8372
8373#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008374 /* Get MAC length */
8375 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8376#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008377 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8379 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8380 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008381 goto end;
8382 }
8383
8384 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008386#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008387 transform->maclen = mac_key_len;
8388
8389 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008390#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008392#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008393 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008394#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008395
8396 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008399 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008400 /*
8401 * GenericBlockCipher:
8402 * 1. if EtM is in use: one block plus MAC
8403 * otherwise: * first multiple of blocklen greater than maclen
8404 * 2. IV
8405 */
8406#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008408 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 + block_size;
8410 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008411#endif
8412 {
8413 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 + block_size
8415 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416 }
8417
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 } else {
8421 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8423 goto end;
8424 }
8425 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8428 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8430 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008431 }
8432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8434 (unsigned) keylen,
8435 (unsigned) transform->minlen,
8436 (unsigned) transform->ivlen,
8437 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438
8439 /*
8440 * Finally setup the cipher contexts, IVs and MAC secrets.
8441 */
8442#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008443 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008444 key1 = keyblk + mac_key_len * 2;
8445 key2 = keyblk + mac_key_len * 2 + keylen;
8446
8447 mac_enc = keyblk;
8448 mac_dec = keyblk + mac_key_len;
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 iv_copy_len = (transform->fixed_ivlen) ?
8451 transform->fixed_ivlen : transform->ivlen;
8452 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8453 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8454 iv_copy_len);
8455 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008456#endif /* MBEDTLS_SSL_CLI_C */
8457#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008459 key1 = keyblk + mac_key_len * 2 + keylen;
8460 key2 = keyblk + mac_key_len * 2;
8461
8462 mac_enc = keyblk + mac_key_len;
8463 mac_dec = keyblk;
8464
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 iv_copy_len = (transform->fixed_ivlen) ?
8466 transform->fixed_ivlen : transform->ivlen;
8467 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8468 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8469 iv_copy_len);
8470 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008471#endif /* MBEDTLS_SSL_SRV_C */
8472 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8475 goto end;
8476 }
8477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 if (ssl != NULL && ssl->f_export_keys != NULL) {
8479 ssl->f_export_keys(ssl->p_export_keys,
8480 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8481 master, 48,
8482 randbytes + 32,
8483 randbytes,
8484 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 }
8486
8487#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488 transform->psa_alg = alg;
8489
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8491 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8492 psa_set_key_algorithm(&attributes, alg);
8493 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008494
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if ((status = psa_import_key(&attributes,
8496 key1,
8497 PSA_BITS_TO_BYTES(key_bits),
8498 &transform->psa_key_enc)) != PSA_SUCCESS) {
8499 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008500 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008502 goto end;
8503 }
8504
Gilles Peskine449bd832023-01-11 14:50:10 +01008505 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008506
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if ((status = psa_import_key(&attributes,
8508 key2,
8509 PSA_BITS_TO_BYTES(key_bits),
8510 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008511 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008513 goto end;
8514 }
8515 }
8516#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8518 cipher_info)) != 0) {
8519 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008520 goto end;
8521 }
8522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8524 cipher_info)) != 0) {
8525 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008526 goto end;
8527 }
8528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8530 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8531 MBEDTLS_ENCRYPT)) != 0) {
8532 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008533 goto end;
8534 }
8535
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8537 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8538 MBEDTLS_DECRYPT)) != 0) {
8539 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008540 goto end;
8541 }
8542
8543#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8545 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8546 MBEDTLS_PADDING_NONE)) != 0) {
8547 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008548 goto end;
8549 }
8550
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8552 MBEDTLS_PADDING_NONE)) != 0) {
8553 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008554 goto end;
8555 }
8556 }
8557#endif /* MBEDTLS_CIPHER_MODE_CBC */
8558#endif /* MBEDTLS_USE_PSA_CRYPTO */
8559
Neil Armstrong29c0c042022-03-17 17:47:28 +01008560#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8561 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8562 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008564#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008566
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8568 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8569 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 if ((status = psa_import_key(&attributes,
8572 mac_enc, mac_key_len,
8573 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008574 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008576 goto end;
8577 }
8578
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8580 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008581#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008583#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008585 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8587 PSA_KEY_USAGE_VERIFY_HASH);
8588 } else {
8589 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8590 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 if ((status = psa_import_key(&attributes,
8593 mac_dec, mac_key_len,
8594 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008595 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008597 goto end;
8598 }
8599#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8601 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008602 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 }
8604 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8605 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008606 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008608#endif /* MBEDTLS_USE_PSA_CRYPTO */
8609 }
8610#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8611
8612 ((void) mac_dec);
8613 ((void) mac_enc);
8614
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008615end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8617 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008618}
8619
Valerio Settia08b1a42022-11-17 15:10:02 +01008620#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8621 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008622int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 psa_pake_operation_t *pake_ctx,
8624 const unsigned char *buf,
8625 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008626{
8627 psa_status_t status;
8628 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008629 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008630 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8631 * At round two perform a single cycle
8632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008634
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 for (; remaining_steps > 0; remaining_steps--) {
8636 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008637 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008639 /* Length is stored at the first byte */
8640 size_t length = buf[input_offset];
8641 input_offset += 1;
8642
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008644 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8645 }
8646
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 status = psa_pake_input(pake_ctx, step,
8648 buf + input_offset, length);
8649 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008650 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008651 }
8652
8653 input_offset += length;
8654 }
8655 }
8656
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008658 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008660
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008662}
8663
Valerio Setti6b3dab02022-11-17 17:14:54 +01008664int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 psa_pake_operation_t *pake_ctx,
8666 unsigned char *buf,
8667 size_t len, size_t *olen,
8668 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008669{
8670 psa_status_t status;
8671 size_t output_offset = 0;
8672 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008673 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008674 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8675 * At round two perform a single cycle
8676 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008677 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008678
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 for (; remaining_steps > 0; remaining_steps--) {
8680 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8681 step <= PSA_PAKE_STEP_ZK_PROOF;
8682 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008683 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008684 * For each step, prepend 1 byte with the length of the data as
8685 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 status = psa_pake_output(pake_ctx, step,
8688 buf + output_offset + 1,
8689 len - output_offset - 1,
8690 &output_len);
8691 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008692 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008693 }
8694
Valerio Setti99d88c12022-11-22 16:03:43 +01008695 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008696
8697 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008698 }
8699 }
8700
8701 *olen = output_offset;
8702
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008704}
Valerio Settia08b1a42022-11-17 15:10:02 +01008705#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8706
Jerry Yuee40f9d2022-02-17 14:55:16 +08008707#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008708int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8709 unsigned char *hash, size_t *hashlen,
8710 unsigned char *data, size_t data_len,
8711 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008712{
8713 psa_status_t status;
8714 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008715 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008716
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008718
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 if ((status = psa_hash_setup(&hash_operation,
8720 hash_alg)) != PSA_SUCCESS) {
8721 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008722 goto exit;
8723 }
8724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8726 64)) != PSA_SUCCESS) {
8727 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728 goto exit;
8729 }
8730
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 if ((status = psa_hash_update(&hash_operation,
8732 data, data_len)) != PSA_SUCCESS) {
8733 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008734 goto exit;
8735 }
8736
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8738 hashlen)) != PSA_SUCCESS) {
8739 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8740 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008741 }
8742
8743exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 if (status != PSA_SUCCESS) {
8745 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8746 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8747 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008748 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8751 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008753 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008756 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008757 }
8758 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008759 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008760}
8761
8762#else
8763
Gilles Peskine449bd832023-01-11 14:50:10 +01008764int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8765 unsigned char *hash, size_t *hashlen,
8766 unsigned char *data, size_t data_len,
8767 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768{
8769 int ret = 0;
8770 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008771 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8772 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008773
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008775
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008777
8778 /*
8779 * digitally-signed struct {
8780 * opaque client_random[32];
8781 * opaque server_random[32];
8782 * ServerDHParams params;
8783 * };
8784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8786 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008787 goto exit;
8788 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8790 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 goto exit;
8792 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008793 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8794 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008795 goto exit;
8796 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8798 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008799 goto exit;
8800 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008801 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8802 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008803 goto exit;
8804 }
8805
8806exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008808
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 if (ret != 0) {
8810 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8811 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8812 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008815}
8816#endif /* MBEDTLS_USE_PSA_CRYPTO */
8817
Jerry Yud9d91da2022-02-17 14:57:06 +08008818#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8819
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008820/* Find the preferred hash for a given signature algorithm. */
8821unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008822 mbedtls_ssl_context *ssl,
8823 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008824{
Gabor Mezei078e8032022-04-27 21:17:56 +02008825 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008826 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008827
Gilles Peskine449bd832023-01-11 14:50:10 +01008828 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8829 return MBEDTLS_SSL_HASH_NONE;
8830 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008831
Gilles Peskine449bd832023-01-11 14:50:10 +01008832 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008833 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8835 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008836 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8838 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008839
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008840 mbedtls_md_type_t md_alg =
8841 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8842 if (md_alg == MBEDTLS_MD_NONE) {
8843 continue;
8844 }
8845
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008847#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008849 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008850 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008851
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8853 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8854 PSA_ALG_ECDSA(psa_hash_alg),
8855 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008856 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008858
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8860 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8861 PSA_ALG_RSA_PKCS1V15_SIGN(
8862 psa_hash_alg),
8863 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008864 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008865 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008866 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008867#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008868
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008870 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008871 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008872
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008874}
8875
8876#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8877
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008878/* Serialization of TLS 1.2 sessions:
8879 *
8880 * struct {
8881 * uint64 start_time;
8882 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008883 * uint8 session_id_len; // at most 32
8884 * opaque session_id[32];
8885 * opaque master[48]; // fixed length in the standard
8886 * uint32 verify_result;
8887 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8888 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8889 * uint32 ticket_lifetime;
8890 * uint8 mfl_code; // up to 255 according to standard
8891 * uint8 encrypt_then_mac; // 0 or 1
8892 * } serialized_session_tls12;
8893 *
8894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008895static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8896 unsigned char *buf,
8897 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008898{
8899 unsigned char *p = buf;
8900 size_t used = 0;
8901
8902#if defined(MBEDTLS_HAVE_TIME)
8903 uint64_t start;
8904#endif
8905#if defined(MBEDTLS_X509_CRT_PARSE_C)
8906#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8907 size_t cert_len;
8908#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8909#endif /* MBEDTLS_X509_CRT_PARSE_C */
8910
8911 /*
8912 * Time
8913 */
8914#if defined(MBEDTLS_HAVE_TIME)
8915 used += 8;
8916
Gilles Peskine449bd832023-01-11 14:50:10 +01008917 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008918 start = (uint64_t) session->start;
8919
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008921 p += 8;
8922 }
8923#endif /* MBEDTLS_HAVE_TIME */
8924
8925 /*
8926 * Basic mandatory fields
8927 */
8928 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 + 1 /* id_len */
8930 + sizeof(session->id)
8931 + sizeof(session->master)
8932 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008933
Gilles Peskine449bd832023-01-11 14:50:10 +01008934 if (used <= buf_len) {
8935 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008936 p += 2;
8937
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 *p++ = MBEDTLS_BYTE_0(session->id_len);
8939 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008940 p += 32;
8941
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008943 p += 48;
8944
Gilles Peskine449bd832023-01-11 14:50:10 +01008945 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008946 p += 4;
8947 }
8948
8949 /*
8950 * Peer's end-entity certificate
8951 */
8952#if defined(MBEDTLS_X509_CRT_PARSE_C)
8953#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008955 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008958 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008959
8960 used += 3 + cert_len;
8961
Gilles Peskine449bd832023-01-11 14:50:10 +01008962 if (used <= buf_len) {
8963 *p++ = MBEDTLS_BYTE_2(cert_len);
8964 *p++ = MBEDTLS_BYTE_1(cert_len);
8965 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 if (session->peer_cert != NULL) {
8968 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008969 p += cert_len;
8970 }
8971 }
8972#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008974 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008976 *p++ = (unsigned char) session->peer_cert_digest_type;
8977 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 memcpy(p, session->peer_cert_digest,
8979 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 p += session->peer_cert_digest_len;
8981 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008982 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008983 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8986 *p++ = 0;
8987 }
8988 }
8989#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8990#endif /* MBEDTLS_X509_CRT_PARSE_C */
8991
8992 /*
8993 * Session ticket if any, plus associated data
8994 */
8995#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8996 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8997
Gilles Peskine449bd832023-01-11 14:50:10 +01008998 if (used <= buf_len) {
8999 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9000 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9001 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009002
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 if (session->ticket != NULL) {
9004 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009005 p += session->ticket_len;
9006 }
9007
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 p += 4;
9010 }
9011#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9012
9013 /*
9014 * Misc extension-related info
9015 */
9016#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9017 used += 1;
9018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022#endif
9023
9024#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9025 used += 1;
9026
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 if (used <= buf_len) {
9028 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9029 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009030#endif
9031
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009033}
9034
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009035MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009036static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9037 const unsigned char *buf,
9038 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009039{
9040#if defined(MBEDTLS_HAVE_TIME)
9041 uint64_t start;
9042#endif
9043#if defined(MBEDTLS_X509_CRT_PARSE_C)
9044#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9045 size_t cert_len;
9046#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9047#endif /* MBEDTLS_X509_CRT_PARSE_C */
9048
9049 const unsigned char *p = buf;
9050 const unsigned char * const end = buf + len;
9051
9052 /*
9053 * Time
9054 */
9055#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 if (8 > (size_t) (end - p)) {
9057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9058 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009060 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061 p += 8;
9062
9063 session->start = (time_t) start;
9064#endif /* MBEDTLS_HAVE_TIME */
9065
9066 /*
9067 * Basic mandatory fields
9068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009069 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9071 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009074 p += 2;
9075
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009076 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009078 p += 32;
9079
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081 p += 48;
9082
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009083 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084 p += 4;
9085
9086 /* Immediately clear invalid pointer values that have been read, in case
9087 * we exit early before we replaced them with valid ones. */
9088#if defined(MBEDTLS_X509_CRT_PARSE_C)
9089#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9090 session->peer_cert = NULL;
9091#else
9092 session->peer_cert_digest = NULL;
9093#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9094#endif /* MBEDTLS_X509_CRT_PARSE_C */
9095#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9096 session->ticket = NULL;
9097#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9098
9099 /*
9100 * Peer certificate
9101 */
9102#if defined(MBEDTLS_X509_CRT_PARSE_C)
9103#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9104 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 if (3 > (size_t) (end - p)) {
9106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9107 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009108
Gilles Peskine449bd832023-01-11 14:50:10 +01009109 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009110 p += 3;
9111
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009113 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9114
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 if (cert_len > (size_t) (end - p)) {
9116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9117 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009118
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009120
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 if (session->peer_cert == NULL) {
9122 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9123 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009124
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009126
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9128 p, cert_len)) != 0) {
9129 mbedtls_x509_crt_free(session->peer_cert);
9130 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009131 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009133 }
9134
9135 p += cert_len;
9136 }
9137#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9138 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009139 if (2 > (size_t) (end - p)) {
9140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9141 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142
9143 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9144 session->peer_cert_digest_len = (size_t) *p++;
9145
Gilles Peskine449bd832023-01-11 14:50:10 +01009146 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009147 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009148 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9149 if (md_info == NULL) {
9150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9151 }
9152 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9153 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9154 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009155
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9158 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009159
9160 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 mbedtls_calloc(1, session->peer_cert_digest_len);
9162 if (session->peer_cert_digest == NULL) {
9163 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9164 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 memcpy(session->peer_cert_digest, p,
9167 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009168 p += session->peer_cert_digest_len;
9169 }
9170#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9171#endif /* MBEDTLS_X509_CRT_PARSE_C */
9172
9173 /*
9174 * Session ticket and associated data
9175 */
9176#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (3 > (size_t) (end - p)) {
9178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9179 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009182 p += 3;
9183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if (session->ticket_len != 0) {
9185 if (session->ticket_len > (size_t) (end - p)) {
9186 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9187 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009188
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 session->ticket = mbedtls_calloc(1, session->ticket_len);
9190 if (session->ticket == NULL) {
9191 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9192 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009193
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009195 p += session->ticket_len;
9196 }
9197
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 if (4 > (size_t) (end - p)) {
9199 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9200 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009201
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009202 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009203 p += 4;
9204#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9205
9206 /*
9207 * Misc extension-related info
9208 */
9209#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (1 > (size_t) (end - p)) {
9211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9212 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009213
9214 session->mfl_code = *p++;
9215#endif
9216
9217#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 if (1 > (size_t) (end - p)) {
9219 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9220 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009221
9222 session->encrypt_then_mac = *p++;
9223#endif
9224
9225 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009226 if (p != end) {
9227 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9228 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009229
Gilles Peskine449bd832023-01-11 14:50:10 +01009230 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009231}
Jerry Yudc7bd172022-02-17 13:44:15 +08009232#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9233
XiaokangQian75d40ef2022-04-20 11:05:24 +00009234int mbedtls_ssl_validate_ciphersuite(
9235 const mbedtls_ssl_context *ssl,
9236 const mbedtls_ssl_ciphersuite_t *suite_info,
9237 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009238 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009239{
9240 (void) ssl;
9241
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 if (suite_info == NULL) {
9243 return -1;
9244 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009245
Gilles Peskine449bd832023-01-11 14:50:10 +01009246 if ((suite_info->min_tls_version > max_tls_version) ||
9247 (suite_info->max_tls_version < min_tls_version)) {
9248 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009249 }
9250
XiaokangQian060d8672022-04-21 09:24:56 +00009251#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009252#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009253#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009254 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9255 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009256#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9258 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009259#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009260 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009262 }
9263#endif
9264
9265 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9266#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009267 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9268 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9269 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009270 }
9271#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9272#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9273
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009275}
9276
Ronald Crone68ab4f2022-10-05 12:46:29 +02009277#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009278/*
9279 * Function for writing a signature algorithm extension.
9280 *
9281 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9282 * value (TLS 1.3 RFC8446):
9283 * enum {
9284 * ....
9285 * ecdsa_secp256r1_sha256( 0x0403 ),
9286 * ecdsa_secp384r1_sha384( 0x0503 ),
9287 * ecdsa_secp521r1_sha512( 0x0603 ),
9288 * ....
9289 * } SignatureScheme;
9290 *
9291 * struct {
9292 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9293 * } SignatureSchemeList;
9294 *
9295 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9296 * value (TLS 1.2 RFC5246):
9297 * enum {
9298 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9299 * sha512(6), (255)
9300 * } HashAlgorithm;
9301 *
9302 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9303 * SignatureAlgorithm;
9304 *
9305 * struct {
9306 * HashAlgorithm hash;
9307 * SignatureAlgorithm signature;
9308 * } SignatureAndHashAlgorithm;
9309 *
9310 * SignatureAndHashAlgorithm
9311 * supported_signature_algorithms<2..2^16-2>;
9312 *
9313 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9314 * generalization of the TLS 1.2 signature algorithm extension.
9315 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9316 * `SignatureScheme` field of TLS 1.3
9317 *
9318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009319int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9320 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009321{
9322 unsigned char *p = buf;
9323 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9324 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9325
9326 *out_len = 0;
9327
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009329
9330 /* Check if we have space for header and length field:
9331 * - extension_type (2 bytes)
9332 * - extension_data_length (2 bytes)
9333 * - supported_signature_algorithms_length (2 bytes)
9334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009335 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009336 p += 6;
9337
9338 /*
9339 * Write supported_signature_algorithms
9340 */
9341 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009342 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9343 if (sig_alg == NULL) {
9344 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9345 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009346
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9348 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9349 *sig_alg,
9350 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9351 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009352 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 }
9354 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9355 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009356 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009357 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9358 *sig_alg,
9359 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009360 }
9361
9362 /* Length of supported_signature_algorithms */
9363 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 if (supported_sig_alg_len == 0) {
9365 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9366 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009367 }
9368
Gilles Peskine449bd832023-01-11 14:50:10 +01009369 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9370 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9371 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009372
XiaokangQianeaf36512022-04-24 09:07:44 +00009373 *out_len = p - buf;
9374
9375#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009376 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009377#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009378
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009380}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009381#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009382
XiaokangQian40a35232022-05-07 09:02:40 +00009383#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009384/*
9385 * mbedtls_ssl_parse_server_name_ext
9386 *
9387 * Structure of server_name extension:
9388 *
9389 * enum {
9390 * host_name(0), (255)
9391 * } NameType;
9392 * opaque HostName<1..2^16-1>;
9393 *
9394 * struct {
9395 * NameType name_type;
9396 * select (name_type) {
9397 * case host_name: HostName;
9398 * } name;
9399 * } ServerName;
9400 * struct {
9401 * ServerName server_name_list<1..2^16-1>
9402 * } ServerNameList;
9403 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009404MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009405int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9406 const unsigned char *buf,
9407 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009408{
9409 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9410 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009411 size_t server_name_list_len, hostname_len;
9412 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009413
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009415
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9417 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009418 p += 2;
9419
Gilles Peskine449bd832023-01-11 14:50:10 +01009420 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009421 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 while (p < server_name_list_end) {
9423 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9424 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9425 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9426 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009427
Gilles Peskine449bd832023-01-11 14:50:10 +01009428 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009429 /* sni_name is intended to be used only during the parsing of the
9430 * ClientHello message (it is reset to NULL before the end of
9431 * the message parsing). Thus it is ok to just point to the
9432 * reception buffer and not make a copy of it.
9433 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009434 ssl->handshake->sni_name = p + 3;
9435 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009436 if (ssl->conf->f_sni == NULL) {
9437 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009438 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9440 ssl, p + 3, hostname_len);
9441 if (ret != 0) {
9442 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9443 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9444 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9445 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9446 }
9447 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009448 }
9449
9450 p += hostname_len + 3;
9451 }
9452
Gilles Peskine449bd832023-01-11 14:50:10 +01009453 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009454}
9455#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9456
XiaokangQianacb39922022-06-17 10:18:48 +00009457#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009459int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9460 const unsigned char *buf,
9461 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009462{
9463 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009464 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009465 const unsigned char *protocol_name_list;
9466 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009467 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009468
9469 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 if (ssl->conf->alpn_list == NULL) {
9471 return 0;
9472 }
XiaokangQianacb39922022-06-17 10:18:48 +00009473
9474 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009475 * RFC7301, section 3.1
9476 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009477 *
XiaokangQianc7403452022-06-23 03:24:12 +00009478 * struct {
9479 * ProtocolName protocol_name_list<2..2^16-1>
9480 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009481 */
9482
XiaokangQianc7403452022-06-23 03:24:12 +00009483 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009484 * protocol_name_list_len 2 bytes
9485 * protocol_name_len 1 bytes
9486 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009487 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009489
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009491 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009493 protocol_name_list = p;
9494 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009495
9496 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009498 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9500 protocol_name_len);
9501 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009502 MBEDTLS_SSL_PEND_FATAL_ALERT(
9503 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9505 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009506 }
9507
9508 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009509 }
9510
9511 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009512 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9513 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009514 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009516 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 if (protocol_name_len == alpn_len &&
9518 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009519 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009521 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009522
9523 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009524 }
9525 }
9526
XiaokangQian95d5f542022-06-24 02:29:26 +00009527 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009528 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009529 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9530 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9531 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009532}
9533
Gilles Peskine449bd832023-01-11 14:50:10 +01009534int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9535 unsigned char *buf,
9536 unsigned char *end,
9537 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009538{
9539 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009540 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009541 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009542
Gilles Peskine449bd832023-01-11 14:50:10 +01009543 if (ssl->alpn_chosen == NULL) {
9544 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009545 }
9546
Gilles Peskine449bd832023-01-11 14:50:10 +01009547 protocol_name_len = strlen(ssl->alpn_chosen);
9548 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009549
Gilles Peskine449bd832023-01-11 14:50:10 +01009550 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009551 /*
9552 * 0 . 1 ext identifier
9553 * 2 . 3 ext length
9554 * 4 . 5 protocol list length
9555 * 6 . 6 protocol name length
9556 * 7 . 7+n protocol name
9557 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009559
XiaokangQian95d5f542022-06-24 02:29:26 +00009560 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009561
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9563 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009564 /* Note: the length of the chosen protocol has been checked to be less
9565 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9566 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009568
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009570
9571#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009572 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009573#endif
9574
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009576}
9577#endif /* MBEDTLS_SSL_ALPN */
9578
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009579#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009580 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009581 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009582 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009583int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9584 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009585{
9586 /* Initialize to suppress unnecessary compiler warning */
9587 size_t hostname_len = 0;
9588
9589 /* Check if new hostname is valid before
9590 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009591 if (hostname != NULL) {
9592 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009593
Gilles Peskine449bd832023-01-11 14:50:10 +01009594 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9596 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009597 }
9598
9599 /* Now it's clear that we will overwrite the old hostname,
9600 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009602 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009604 }
9605
9606 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009608 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009609 } else {
9610 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9611 if (session->hostname == NULL) {
9612 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9613 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009614
Gilles Peskine449bd832023-01-11 14:50:10 +01009615 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009616 }
9617
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009619}
Xiaokang Qian03409292022-10-12 02:49:52 +00009620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9621 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009622 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009623 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009625#endif /* MBEDTLS_SSL_TLS_C */