blob: e1fb1283e6b38fe99fa0627541174c8ee8a54da1 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800309 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Jerry Yu60835a82021-08-04 10:13:52 +08001358 /* Space for further checks */
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001361}
1362
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001363/*
1364 * Setup an SSL context
1365 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1368 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001369{
Janos Follath865b3eb2019-12-16 11:46:15 +00001370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001371 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1372 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001374 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if ((ret = ssl_conf_check(ssl)) != 0) {
1377 return ret;
1378 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001379 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001380
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001382 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001383 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001384
1385 /* Set to NULL in case of an error condition */
1386 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001387
Darryl Greenb33cc762019-11-28 14:29:44 +00001388#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1389 ssl->in_buf_len = in_buf_len;
1390#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1392 if (ssl->in_buf == NULL) {
1393 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001394 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001395 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001396 }
1397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->out_buf_len = out_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1402 if (ssl->out_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001409
Johan Pascalb62bb512015-12-03 21:56:45 +01001410#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001412#endif
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419
1420error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_free(ssl->in_buf);
1422 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424 ssl->conf = NULL;
1425
Darryl Greenb33cc762019-11-28 14:29:44 +00001426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1427 ssl->in_buf_len = 0;
1428 ssl->out_buf_len = 0;
1429#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001430 ssl->in_buf = NULL;
1431 ssl->out_buf = NULL;
1432
1433 ssl->in_hdr = NULL;
1434 ssl->in_ctr = NULL;
1435 ssl->in_len = NULL;
1436 ssl->in_iv = NULL;
1437 ssl->in_msg = NULL;
1438
1439 ssl->out_hdr = NULL;
1440 ssl->out_ctr = NULL;
1441 ssl->out_len = NULL;
1442 ssl->out_iv = NULL;
1443 ssl->out_msg = NULL;
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
1448/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001449 * Reset an initialized and used SSL context for re-use while retaining
1450 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001451 *
1452 * If partial is non-zero, keep data in the input buffer and client ID.
1453 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1456 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457{
Darryl Greenb33cc762019-11-28 14:29:44 +00001458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1459 size_t in_buf_len = ssl->in_buf_len;
1460 size_t out_buf_len = ssl->out_buf_len;
1461#else
1462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1463 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1464#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001465
Hanno Beckerb0302c42021-08-03 09:39:42 +01001466#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1467 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001468#endif
1469
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001470 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474
1475 /* Reset incoming message parsing */
1476 ssl->in_offt = NULL;
1477 ssl->nb_zero = 0;
1478 ssl->in_msgtype = 0;
1479 ssl->in_msglen = 0;
1480 ssl->in_hslen = 0;
1481 ssl->keep_current_message = 0;
1482 ssl->transform_in = NULL;
1483
1484#if defined(MBEDTLS_SSL_PROTO_DTLS)
1485 ssl->next_record_offset = 0;
1486 ssl->in_epoch = 0;
1487#endif
1488
1489 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001491 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493 }
1494
Ronald Cronad8c17b2022-06-10 17:18:09 +02001495 ssl->send_alert = 0;
1496
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 /* Reset outgoing message writing */
1498 ssl->out_msgtype = 0;
1499 ssl->out_msglen = 0;
1500 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 memset(ssl->out_buf, 0, out_buf_len);
1502 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->transform_out = NULL;
1504
1505#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507#endif
1508
XiaokangQian2b01dc32022-01-21 02:53:13 +00001509#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (ssl->transform) {
1511 mbedtls_ssl_transform_free(ssl->transform);
1512 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform = NULL;
1514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1516
XiaokangQian2b01dc32022-01-21 02:53:13 +00001517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_transform_free(ssl->transform_application);
1519 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 ssl->transform_application = NULL;
1521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001523#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1525 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1530 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_handshake = NULL;
1532 }
1533
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538{
1539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1540
1541 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
1545 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_RENEGOTIATION)
1547 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001549
1550 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1552 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001557 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session) {
1559 mbedtls_ssl_session_free(ssl->session);
1560 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001561 ssl->session = NULL;
1562 }
1563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001565 ssl->alpn_chosen = NULL;
1566#endif
1567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001569 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (free_cli_id) {
1574 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001575 ssl->cli_id = NULL;
1576 ssl->cli_id_len = 0;
1577 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001578#endif
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if ((ret = ssl_handshake_init(ssl)) != 0) {
1581 return ret;
1582 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001585}
1586
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001587/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 * Reset an initialized and used SSL context for re-use while retaining
1589 * all application-set variables, function pointers and data.
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592{
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594}
1595
1596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 * SSL set accessors
1598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001601 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001602}
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607}
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613}
1614#endif
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1624 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001625{
1626 ssl->disable_datagram_packing = !allow_packing;
1627}
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1630 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->hs_timeout_min = min;
1633 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1644 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1645 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001647 conf->f_vrfy = f_vrfy;
1648 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1653 int (*f_rng)(void *, unsigned char *, size_t),
1654 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001656 conf->f_rng = f_rng;
1657 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1661 void (*f_dbg)(void *, int, const char *, int, const char *),
1662 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_dbg = f_dbg;
1665 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001666}
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1669 void *p_bio,
1670 mbedtls_ssl_send_t *f_send,
1671 mbedtls_ssl_recv_t *f_recv,
1672 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001673{
1674 ssl->p_bio = p_bio;
1675 ssl->f_send = f_send;
1676 ssl->f_recv = f_recv;
1677 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001678}
1679
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682{
1683 ssl->mtu = mtu;
1684}
1685#endif
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688{
1689 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690}
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1693 void *p_timer,
1694 mbedtls_ssl_set_timer_t *f_set_timer,
1695 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696{
1697 ssl->p_timer = p_timer;
1698 ssl->f_set_timer = f_set_timer;
1699 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001700
1701 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703}
1704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001706void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1707 void *p_cache,
1708 mbedtls_ssl_cache_get_t *f_get_cache,
1709 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001710{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001711 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723 session == NULL ||
1724 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (ssl->handshake->resume == 1) {
1730 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1731 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001732
Jerry Yu21092062022-10-10 21:21:31 +08001733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001735 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001739 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1741 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1742 session->ciphersuite));
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001744 }
Jerry Yu40afab62022-10-08 10:42:13 +08001745 }
Jerry Yu21092062022-10-10 21:21:31 +08001746#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1749 session)) != 0) {
1750 return ret;
1751 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001752
Paul Bakker0a597072012-09-25 21:55:46 +00001753 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1760 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001761{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001762 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001763}
1764
Ronald Cron6f135e12021-12-08 16:57:54 +01001765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1767 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001768{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001769 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001771
1772#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001773void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1774 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001775{
1776 conf->early_data_enabled = early_data_enabled;
1777}
Jerry Yucc4e0072022-11-22 17:22:22 +08001778
1779#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001780void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001782{
Jerry Yu39da9852022-12-06 16:58:36 +08001783 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001784}
1785#endif /* MBEDTLS_SSL_SRV_C */
1786
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1792 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001793{
1794 conf->cert_profile = profile;
1795}
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001798{
1799 mbedtls_ssl_key_cert *cur = key_cert, *next;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001802 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 cur = next;
1805 }
1806}
1807
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001808/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1811 mbedtls_x509_crt *cert,
1812 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001813{
niisato8ee24222018-06-25 19:05:48 +09001814 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1824 if (new_cert == NULL) {
1825 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1826 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
niisato8ee24222018-06-25 19:05:48 +09001828 new_cert->cert = cert;
1829 new_cert->key = key;
1830 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001834 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001836 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 }
niisato8ee24222018-06-25 19:05:48 +09001840 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844}
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849{
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851}
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001854 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001856{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 conf->ca_chain = ca_chain;
1858 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001859
1860#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1861 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1862 * cannot be used together. */
1863 conf->f_ca_cb = NULL;
1864 conf->p_ca_cb = NULL;
1865#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
Hanno Becker5adaad92019-03-27 16:54:37 +00001867
1868#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1871 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001872{
1873 conf->f_ca_cb = f_ca_cb;
1874 conf->p_ca_cb = p_ca_cb;
1875
1876 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1877 * cannot be used together. */
1878 conf->ca_chain = NULL;
1879 conf->ca_crl = NULL;
1880}
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001883
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001884#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1886 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001887{
1888 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001890}
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1893 mbedtls_x509_crt *own_cert,
1894 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895{
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1897 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1901 mbedtls_x509_crt *ca_chain,
1902 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001903{
1904 ssl->handshake->sni_ca_chain = ca_chain;
1905 ssl->handshake->sni_ca_crl = ca_crl;
1906}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001907
Glenn Strauss999ef702022-03-11 01:37:23 -05001908#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1910 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001911{
1912 ssl->handshake->dn_hints = crt;
1913}
1914#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1917 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918{
1919 ssl->handshake->sni_authmode = authmode;
1920}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1922
Hanno Becker8927c832019-04-03 12:52:50 +01001923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001924void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1926 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001927{
1928 ssl->f_vrfy = f_vrfy;
1929 ssl->p_vrfy = p_vrfy;
1930}
1931#endif
1932
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Valerio Setti016f6822022-12-09 14:17:50 +01001935#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001936static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1937static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1938
Valerio Setti016f6822022-12-09 14:17:50 +01001939static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 mbedtls_ssl_context *ssl,
1941 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001942{
1943 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001944 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001945 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001946 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1950 psa_pake_cs_set_primitive(&cipher_suite,
1951 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1952 PSA_ECC_FAMILY_SECP_R1,
1953 256));
1954 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1957 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001962 user = jpake_server_id;
1963 user_len = sizeof(jpake_server_id);
1964 peer = jpake_client_id;
1965 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_client_id;
1968 user_len = sizeof(jpake_client_id);
1969 peer = jpake_server_id;
1970 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001972
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1974 if (status != PSA_SUCCESS) {
1975 return status;
1976 }
1977
1978 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001980 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
1988 ssl->handshake->psa_pake_ctx_is_ok = 1;
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1994 const unsigned char *pw,
1995 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001996{
1997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1998 psa_status_t status;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (ssl->handshake == NULL || ssl->conf == NULL) {
2001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 /* Empty password is not valid */
2005 if ((pw == NULL) || (pw_len == 0)) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2007 }
2008
2009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2010 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2011 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2012
2013 status = psa_import_key(&attributes, pw, pw_len,
2014 &ssl->handshake->psa_pake_password);
2015 if (status != PSA_SUCCESS) {
2016 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2017 }
2018
2019 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2020 ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 psa_destroy_key(ssl->handshake->psa_pake_password);
2023 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2024 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2025 }
2026
2027 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002028}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2031 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033 psa_status_t status;
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (ssl->handshake == NULL || ssl->conf == NULL) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (mbedtls_svc_key_id_is_null(pwd)) {
2040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2041 }
2042
2043 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2044 if (status != PSA_SUCCESS) {
2045 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2046 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2047 }
2048
2049 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002050}
2051#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2053 const unsigned char *pw,
2054 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002055{
2056 mbedtls_ecjpake_role role;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ssl->handshake == NULL || ssl->conf == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061
Valerio Settic689ed82022-12-07 14:40:38 +01002062 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if ((pw == NULL) || (pw_len == 0)) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Valerio Settic689ed82022-12-07 14:40:38 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2074 role,
2075 MBEDTLS_MD_SHA256,
2076 MBEDTLS_ECP_DP_SECP256R1,
2077 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078}
Valerio Setti02c25b52022-11-15 14:08:42 +01002079#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002080#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002084{
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (conf->psk_identity == NULL ||
2086 conf->psk_identity_len == 0) {
2087 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002088 }
2089
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2092 return 1;
2093 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk != NULL && conf->psk_len != 0) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
2105 /* Remove reference to existing PSK, if any. */
2106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108 /* The maintenance of the PSK key slot is the
2109 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002114 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115 conf->psk = NULL;
2116 conf->psk_len = 0;
2117 }
2118
2119 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (conf->psk_identity != NULL) {
2121 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk_identity = NULL;
2123 conf->psk_identity_len = 0;
2124 }
2125}
2126
Hanno Becker7390c712018-11-15 13:33:04 +00002127/* This function assumes that PSK identity in the SSL config is unset.
2128 * It checks that the provided identity is well-formed and attempts
2129 * to make a copy of it in the SSL config.
2130 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002132static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2133 unsigned char const *psk_identity,
2134 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002135{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002136 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002138 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 (psk_identity_len >> 16) != 0 ||
2140 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2145 if (conf->psk_identity == NULL) {
2146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2147 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002148
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002149 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002153}
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2156 const unsigned char *psk, size_t psk_len,
2157 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002160
2161 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2163 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2164 }
Hanno Becker7390c712018-11-15 13:33:04 +00002165
2166 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (psk == NULL) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2169 }
2170 if (psk_len == 0) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2178 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002182
2183 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2185 if (ret != 0) {
2186 ssl_conf_remove_psk(conf);
2187 }
Hanno Becker7390c712018-11-15 13:33:04 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002193{
2194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002196 /* The maintenance of the external PSK key slot is the
2197 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->psk_opaque_is_internal) {
2199 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002200 ssl->handshake->psk_opaque_is_internal = 0;
2201 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002202 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203 }
Neil Armstronge952a302022-05-03 10:22:14 +02002204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002206 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 ssl->handshake->psk_len = 0;
2209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211}
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2214 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002215{
Neil Armstrong501c9322022-05-03 09:35:09 +02002216#if defined(MBEDTLS_USE_PSA_CRYPTO)
2217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002219 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (psk == NULL || ssl->handshake == NULL) {
2224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2225 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2229 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2236 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2237 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2238 } else {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2240 }
2241 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002242 }
2243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002244
Jerry Yu568ec252022-07-22 21:27:34 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2247 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2248 psa_set_key_usage_flags(&key_attributes,
2249 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 psa_set_key_algorithm(&key_attributes, alg);
2254 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2257 if (status != PSA_SUCCESS) {
2258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2259 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
2261 /* Allow calling psa_destroy_key() on psk remove */
2262 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002264#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
2269 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274}
2275
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002276#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002277int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2278 mbedtls_svc_key_id_t psk,
2279 const unsigned char *psk_identity,
2280 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281{
Janos Follath865b3eb2019-12-16 11:46:15 +00002282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002283
2284 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2287 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288
Hanno Becker7390c712018-11-15 13:33:04 +00002289 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_svc_key_id_is_null(psk)) {
2291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2292 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002293 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002294
2295 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2297 psk_identity_len);
2298 if (ret != 0) {
2299 ssl_conf_remove_psk(conf);
2300 }
Hanno Becker7390c712018-11-15 13:33:04 +00002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2306 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002307{
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((mbedtls_svc_key_id_is_null(psk)) ||
2309 (ssl->handshake == NULL)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316}
2317#endif /* MBEDTLS_USE_PSA_CRYPTO */
2318
Jerry Yu8897c072022-08-12 13:56:53 +08002319#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2321 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2322 size_t),
2323 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324{
2325 conf->f_psk = f_psk;
2326 conf->p_psk = p_psk;
2327}
Jerry Yu8897c072022-08-12 13:56:53 +08002328#endif /* MBEDTLS_SSL_SRV_C */
2329
Ronald Cron73fe8df2022-10-05 14:31:43 +02002330#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
2332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002333static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (alg == PSA_ALG_CBC_NO_PADDING) {
2338 return MBEDTLS_SSL_MODE_CBC;
2339 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (PSA_ALG_IS_AEAD(alg)) {
2342 return MBEDTLS_SSL_MODE_AEAD;
2343 }
2344 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002345}
2346
2347#else /* MBEDTLS_USE_PSA_CRYPTO */
2348
2349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002351{
2352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (mode == MBEDTLS_MODE_CBC) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2357
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358#if defined(MBEDTLS_GCM_C) || \
2359 defined(MBEDTLS_CCM_C) || \
2360 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mode == MBEDTLS_MODE_CHACHAPOLY) {
2364 return MBEDTLS_SSL_MODE_AEAD;
2365 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369}
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371
Gilles Peskinee108d982022-04-26 16:50:40 +02002372static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2373 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002375{
2376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2378 base_mode == MBEDTLS_SSL_MODE_CBC) {
2379 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002380 }
2381#else
2382 (void) encrypt_then_mac;
2383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385}
2386
Neil Armstrongab555e02022-04-04 11:07:59 +02002387mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002389{
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002395#endif
2396 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 encrypt_then_mac = transform->encrypt_then_mac;
2401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403}
2404
Neil Armstrongab555e02022-04-04 11:07:59 +02002405mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410{
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2412
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413#if defined(MBEDTLS_USE_PSA_CRYPTO)
2414 psa_status_t status;
2415 psa_algorithm_t alg;
2416 psa_key_type_t type;
2417 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002418 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2419 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (status == PSA_SUCCESS) {
2421 base_mode = mbedtls_ssl_get_base_mode(alg);
2422 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#else
2424 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002425 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 base_mode =
2428 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#endif /* MBEDTLS_USE_PSA_CRYPTO */
2432
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2434 int encrypt_then_mac = 0;
2435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437}
2438
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002439#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002440
2441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002442/* Serialization of TLS 1.3 sessions:
2443 *
2444 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002445 * opaque hostname<0..2^16-1>;
Jerry Yu342a5552023-11-10 14:23:39 +08002446 * uint64 ticket_reception_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002447 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002448 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * } ClientOnlyData;
2450 *
2451 * struct {
2452 * uint8 endpoint;
2453 * uint8 ciphersuite[2];
2454 * uint32 ticket_age_add;
2455 * uint8 ticket_flags;
2456 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002457 * uint32 max_early_data_size;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * select ( endpoint ) {
2459 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002460 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * };
2462 * } serialized_session_tls13;
2463 *
2464 */
2465#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002467static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2468 unsigned char *buf,
2469 size_t buf_len,
2470 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002471{
2472 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002473#if defined(MBEDTLS_SSL_CLI_C) && \
2474 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 size_t hostname_len = (session->hostname == NULL) ?
2476 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002477#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002478 size_t needed = 1 /* endpoint */
2479 + 2 /* ciphersuite */
2480 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002481 + 1 /* ticket_flags */
2482 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002483 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2486 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2487 }
Jerry Yu34191072022-08-18 10:32:09 +08002488 needed += session->resumption_key_len; /* resumption_key */
2489
Jerry Yu02e3a072022-12-12 15:13:20 +08002490#if defined(MBEDTLS_SSL_EARLY_DATA)
2491 needed += 4; /* max_early_data_size */
2492#endif
2493
Jerry Yu438ddd82022-07-07 06:55:50 +00002494#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002495 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002496#endif
2497
2498#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002500#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002501 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002503#endif
2504
Jerry Yu438ddd82022-07-07 06:55:50 +00002505 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002506 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002507
2508 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->ticket_len > SIZE_MAX - needed) {
2510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2511 }
Jerry Yu34191072022-08-18 10:32:09 +08002512
Jerry Yue28d9742022-08-18 15:44:03 +08002513 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002514 }
2515#endif /* MBEDTLS_SSL_CLI_C */
2516
Jerry Yue36fdd62022-08-17 21:31:36 +08002517 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (needed > buf_len) {
2519 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2520 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002521
2522 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2524 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002525 p[7] = session->ticket_flags;
2526
2527 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002528 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002531 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002532
Jerry Yu02e3a072022-12-12 15:13:20 +08002533#if defined(MBEDTLS_SSL_EARLY_DATA)
2534 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2535 p += 4;
2536#endif
2537
Jerry Yu438ddd82022-07-07 06:55:50 +00002538#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002540 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002541 p += 8;
2542 }
2543#endif /* MBEDTLS_HAVE_TIME */
2544
2545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002547#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 p += hostname_len;
2554 }
2555#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2556
Jerry Yu438ddd82022-07-07 06:55:50 +00002557#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002558 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += 8;
2560#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 4;
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (session->ticket != NULL && session->ticket_len > 0) {
2568 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += session->ticket_len;
2570 }
2571 }
2572#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002574}
2575
2576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2578 const unsigned char *buf,
2579 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002580{
2581 const unsigned char *p = buf;
2582 const unsigned char *end = buf + len;
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (end - p < 9) {
2585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2586 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002587 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2589 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->ticket_flags = p[7];
2591
2592 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002593 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002594 p += 9;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < session->resumption_key_len) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2602 }
2603 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002604 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002605
Jerry Yu02e3a072022-12-12 15:13:20 +08002606#if defined(MBEDTLS_SSL_EARLY_DATA)
2607 if (end - p < 4) {
2608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2609 }
2610 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2611 p += 4;
2612#endif
2613
Jerry Yu438ddd82022-07-07 06:55:50 +00002614#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2616 if (end - p < 8) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002619 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002620 p += 8;
2621 }
2622#endif /* MBEDTLS_HAVE_TIME */
2623
2624#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002626#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002627 size_t hostname_len;
2628 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 if (end - p < 2) {
2630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2631 }
2632 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002633 p += 2;
2634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 if (end - p < (long int) hostname_len) {
2636 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2637 }
2638 if (hostname_len > 0) {
2639 session->hostname = mbedtls_calloc(1, hostname_len);
2640 if (session->hostname == NULL) {
2641 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2642 }
2643 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002644 p += hostname_len;
2645 }
Yanray Wangfd256542023-11-22 10:32:03 +08002646#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002647
Jerry Yu438ddd82022-07-07 06:55:50 +00002648#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (end - p < 8) {
2650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2651 }
Jerry Yu342a5552023-11-10 14:23:39 +08002652 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002653 p += 8;
2654#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 if (end - p < 4) {
2656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2657 }
2658 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002659 p += 4;
2660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (end - p < 2) {
2662 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2663 }
2664 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002665 p += 2;
2666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (end - p < (long int) session->ticket_len) {
2668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2669 }
2670 if (session->ticket_len > 0) {
2671 session->ticket = mbedtls_calloc(1, session->ticket_len);
2672 if (session->ticket == NULL) {
2673 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2674 }
2675 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002676 p += session->ticket_len;
2677 }
2678 }
2679#endif /* MBEDTLS_SSL_CLI_C */
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002682
2683}
2684#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002685MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002686static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2687 unsigned char *buf,
2688 size_t buf_len,
2689 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002690{
2691 ((void) session);
2692 ((void) buf);
2693 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002694 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002696}
Jerry Yu438ddd82022-07-07 06:55:50 +00002697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2699 unsigned char *buf,
2700 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002701{
2702 ((void) session);
2703 ((void) buf);
2704 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002706}
2707#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002708#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2711 size_t taglen,
2712 psa_algorithm_t *alg,
2713 psa_key_type_t *key_type,
2714 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002715{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002716#if !defined(MBEDTLS_SSL_HAVE_CCM)
2717 (void) taglen;
2718#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002720#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002721 case MBEDTLS_CIPHER_AES_128_CBC:
2722 *alg = PSA_ALG_CBC_NO_PADDING;
2723 *key_type = PSA_KEY_TYPE_AES;
2724 *key_size = 128;
2725 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002726#endif
2727#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002728 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730 *key_type = PSA_KEY_TYPE_AES;
2731 *key_size = 128;
2732 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002733#endif
2734#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002735 case MBEDTLS_CIPHER_AES_128_GCM:
2736 *alg = PSA_ALG_GCM;
2737 *key_type = PSA_KEY_TYPE_AES;
2738 *key_size = 128;
2739 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002740#endif
2741#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002742 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002744 *key_type = PSA_KEY_TYPE_AES;
2745 *key_size = 192;
2746 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002747#endif
2748#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002749 case MBEDTLS_CIPHER_AES_192_GCM:
2750 *alg = PSA_ALG_GCM;
2751 *key_type = PSA_KEY_TYPE_AES;
2752 *key_size = 192;
2753 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002754#endif
2755#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002756 case MBEDTLS_CIPHER_AES_256_CBC:
2757 *alg = PSA_ALG_CBC_NO_PADDING;
2758 *key_type = PSA_KEY_TYPE_AES;
2759 *key_size = 256;
2760 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002761#endif
2762#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002763 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002765 *key_type = PSA_KEY_TYPE_AES;
2766 *key_size = 256;
2767 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002768#endif
2769#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002770 case MBEDTLS_CIPHER_AES_256_GCM:
2771 *alg = PSA_ALG_GCM;
2772 *key_type = PSA_KEY_TYPE_AES;
2773 *key_size = 256;
2774 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002775#endif
2776#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002777 case MBEDTLS_CIPHER_ARIA_128_CBC:
2778 *alg = PSA_ALG_CBC_NO_PADDING;
2779 *key_type = PSA_KEY_TYPE_ARIA;
2780 *key_size = 128;
2781 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002782#endif
2783#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002784 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002786 *key_type = PSA_KEY_TYPE_ARIA;
2787 *key_size = 128;
2788 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002789#endif
2790#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002791 case MBEDTLS_CIPHER_ARIA_128_GCM:
2792 *alg = PSA_ALG_GCM;
2793 *key_type = PSA_KEY_TYPE_ARIA;
2794 *key_size = 128;
2795 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002796#endif
2797#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002798 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002800 *key_type = PSA_KEY_TYPE_ARIA;
2801 *key_size = 192;
2802 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002803#endif
2804#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002805 case MBEDTLS_CIPHER_ARIA_192_GCM:
2806 *alg = PSA_ALG_GCM;
2807 *key_type = PSA_KEY_TYPE_ARIA;
2808 *key_size = 192;
2809 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002810#endif
2811#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002812 case MBEDTLS_CIPHER_ARIA_256_CBC:
2813 *alg = PSA_ALG_CBC_NO_PADDING;
2814 *key_type = PSA_KEY_TYPE_ARIA;
2815 *key_size = 256;
2816 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002817#endif
2818#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002819 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002821 *key_type = PSA_KEY_TYPE_ARIA;
2822 *key_size = 256;
2823 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002824#endif
2825#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002826 case MBEDTLS_CIPHER_ARIA_256_GCM:
2827 *alg = PSA_ALG_GCM;
2828 *key_type = PSA_KEY_TYPE_ARIA;
2829 *key_size = 256;
2830 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002831#endif
2832#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002833 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2834 *alg = PSA_ALG_CBC_NO_PADDING;
2835 *key_type = PSA_KEY_TYPE_CAMELLIA;
2836 *key_size = 128;
2837 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002838#endif
2839#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002840 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002842 *key_type = PSA_KEY_TYPE_CAMELLIA;
2843 *key_size = 128;
2844 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002845#endif
2846#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002847 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2848 *alg = PSA_ALG_GCM;
2849 *key_type = PSA_KEY_TYPE_CAMELLIA;
2850 *key_size = 128;
2851 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002852#endif
2853#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002854 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002856 *key_type = PSA_KEY_TYPE_CAMELLIA;
2857 *key_size = 192;
2858 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002859#endif
2860#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002861 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2862 *alg = PSA_ALG_GCM;
2863 *key_type = PSA_KEY_TYPE_CAMELLIA;
2864 *key_size = 192;
2865 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002866#endif
2867#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002868 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2869 *alg = PSA_ALG_CBC_NO_PADDING;
2870 *key_type = PSA_KEY_TYPE_CAMELLIA;
2871 *key_size = 256;
2872 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002873#endif
2874#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002875 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002877 *key_type = PSA_KEY_TYPE_CAMELLIA;
2878 *key_size = 256;
2879 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002880#endif
2881#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002882 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2883 *alg = PSA_ALG_GCM;
2884 *key_type = PSA_KEY_TYPE_CAMELLIA;
2885 *key_size = 256;
2886 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002887#endif
2888#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002889 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2890 *alg = PSA_ALG_CHACHA20_POLY1305;
2891 *key_type = PSA_KEY_TYPE_CHACHA20;
2892 *key_size = 256;
2893 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002894#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002895 case MBEDTLS_CIPHER_NULL:
2896 *alg = MBEDTLS_SSL_NULL_CIPHER;
2897 *key_type = 0;
2898 *key_size = 0;
2899 break;
2900 default:
2901 return PSA_ERROR_NOT_SUPPORTED;
2902 }
2903
2904 return PSA_SUCCESS;
2905}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002906#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002907
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002908#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002909int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2910 const unsigned char *dhm_P, size_t P_len,
2911 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002912{
Janos Follath865b3eb2019-12-16 11:46:15 +00002913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 mbedtls_mpi_free(&conf->dhm_P);
2916 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2919 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2920 mbedtls_mpi_free(&conf->dhm_P);
2921 mbedtls_mpi_free(&conf->dhm_G);
2922 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002923 }
2924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002926}
Paul Bakker5121ce52009-01-03 21:22:43 +00002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002929{
Janos Follath865b3eb2019-12-16 11:46:15 +00002930 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 mbedtls_mpi_free(&conf->dhm_P);
2933 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2936 &conf->dhm_P)) != 0 ||
2937 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2938 &conf->dhm_G)) != 0) {
2939 mbedtls_mpi_free(&conf->dhm_P);
2940 mbedtls_mpi_free(&conf->dhm_G);
2941 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002942 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002945}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002946#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002947
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002948#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2949/*
2950 * Set the minimum length for Diffie-Hellman parameters
2951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2953 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002954{
2955 conf->dhm_min_bitlen = bitlen;
2956}
2957#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2958
Ronald Crone68ab4f2022-10-05 12:46:29 +02002959#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002960#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002961/*
2962 * Set allowed/preferred hashes for handshake signatures
2963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002964void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2965 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002966{
2967 conf->sig_hashes = hashes;
2968}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002969#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002970
Jerry Yuf017ee42022-01-12 15:49:48 +08002971/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002972void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2973 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002974{
Jerry Yuf017ee42022-01-12 15:49:48 +08002975#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2976 conf->sig_hashes = NULL;
2977#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2978 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002979}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002980#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002981
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002982#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002983#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002984/*
2985 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002986 *
2987 * mbedtls_ssl_setup() takes the provided list
2988 * and translates it to a list of IANA TLS group identifiers,
2989 * stored in ssl->handshake->group_list.
2990 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002992void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2993 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002996 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002997}
Brett Warrene0edc842021-08-17 09:53:13 +01002998#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002999#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003000
Brett Warrene0edc842021-08-17 09:53:13 +01003001/*
3002 * Set the allowed groups
3003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003004void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3005 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003006{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003007#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003008 conf->curve_list = NULL;
3009#endif
3010 conf->group_list = group_list;
3011}
3012
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003013#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003014int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003015{
Hanno Becker947194e2017-04-07 13:25:49 +01003016 /* Initialize to suppress unnecessary compiler warning */
3017 size_t hostname_len = 0;
3018
3019 /* Check if new hostname is valid before
3020 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 if (hostname != NULL) {
3022 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3026 }
Hanno Becker947194e2017-04-07 13:25:49 +01003027 }
3028
3029 /* Now it's clear that we will overwrite the old hostname,
3030 * so we can free it safely */
3031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003033 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003034 }
3035
3036 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003039 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 } else {
3041 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3042 if (ssl->hostname == NULL) {
3043 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3044 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003047
Hanno Becker947194e2017-04-07 13:25:49 +01003048 ssl->hostname[hostname_len] = '\0';
3049 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003052}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003053#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003054
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003055#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003056void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3057 int (*f_sni)(void *, mbedtls_ssl_context *,
3058 const unsigned char *, size_t),
3059 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003060{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003061 conf->f_sni = f_sni;
3062 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003063}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003067int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003068{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003069 size_t cur_len, tot_len;
3070 const char **p;
3071
3072 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003073 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3074 * MUST NOT be truncated."
3075 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003076 */
3077 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 for (p = protos; *p != NULL; p++) {
3079 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003080 tot_len += cur_len;
3081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 if ((cur_len == 0) ||
3083 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3084 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3086 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003087 }
3088
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003089 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003092}
3093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003095{
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003097}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003099
Johan Pascalb62bb512015-12-03 21:56:45 +01003100#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003101void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3102 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003103{
3104 conf->dtls_srtp_mki_support = support_mki_value;
3105}
3106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3108 unsigned char *mki_value,
3109 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003110{
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003113 }
Ron Eldor591f1622018-01-22 12:30:04 +02003114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3116 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003117 }
Ron Eldor591f1622018-01-22 12:30:04 +02003118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003120 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003122}
3123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3125 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003126{
Johan Pascal253d0262020-09-22 13:04:45 +02003127 const mbedtls_ssl_srtp_profile *p;
3128 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003129
Johan Pascal253d0262020-09-22 13:04:45 +02003130 /* check the profiles list: all entry must be valid,
3131 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3133 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3134 p++) {
3135 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003136 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003138 /* unsupported value, stop parsing and set the size to an error value */
3139 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003140 }
3141 }
3142
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3144 conf->dtls_srtp_profile_list = NULL;
3145 conf->dtls_srtp_profile_list_len = 0;
3146 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003147 }
3148
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003149 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003150 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003151
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003153}
3154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3156 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003157{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003158 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3159 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003161 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003163 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3165 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003166 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003167}
Johan Pascalb62bb512015-12-03 21:56:45 +01003168#endif /* MBEDTLS_SSL_DTLS_SRTP */
3169
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303170#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003172{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003173 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003174}
3175
Gilles Peskine449bd832023-01-11 14:50:10 +01003176void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003177{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003178 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003179}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303180#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003181
Janos Follath088ce432017-04-10 12:42:31 +01003182#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003183void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3184 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003185{
3186 conf->cert_req_ca_list = cert_req_ca_list;
3187}
3188#endif
3189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003191void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003192{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003193 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003194}
3195#endif
3196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003199{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003200 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003201}
3202#endif
3203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003205int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003206{
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3208 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3209 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003210 }
3211
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003212 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003213
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003215}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003219{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003220 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003221}
3222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003224void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003225{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003226 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003227}
3228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003230{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003231 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003232}
3233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3235 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003236{
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003238}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003242#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003243void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003244{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003245 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003246}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003247#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003248
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003249#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003250
Jerry Yud0766ec2022-09-22 10:46:57 +08003251#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003252void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3253 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003254{
Jerry Yud0766ec2022-09-22 10:46:57 +08003255 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003256}
3257#endif
3258
Gilles Peskine449bd832023-01-11 14:50:10 +01003259void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3260 mbedtls_ssl_ticket_write_t *f_ticket_write,
3261 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3262 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003263{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003264 conf->f_ticket_write = f_ticket_write;
3265 conf->f_ticket_parse = f_ticket_parse;
3266 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003267}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003268#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003270
Gilles Peskine449bd832023-01-11 14:50:10 +01003271void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3272 mbedtls_ssl_export_keys_t *f_export_keys,
3273 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003274{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003275 ssl->f_export_keys = f_export_keys;
3276 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003277}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003278
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003279#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003280void mbedtls_ssl_conf_async_private_cb(
3281 mbedtls_ssl_config *conf,
3282 mbedtls_ssl_async_sign_t *f_async_sign,
3283 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3284 mbedtls_ssl_async_resume_t *f_async_resume,
3285 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003287{
3288 conf->f_async_sign_start = f_async_sign;
3289 conf->f_async_decrypt_start = f_async_decrypt;
3290 conf->f_async_resume = f_async_resume;
3291 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003292 conf->p_async_config_data = async_config_data;
3293}
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003296{
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003298}
3299
Gilles Peskine449bd832023-01-11 14:50:10 +01003300void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003301{
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 if (ssl->handshake == NULL) {
3303 return NULL;
3304 } else {
3305 return ssl->handshake->user_async_ctx;
3306 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003307}
3308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3310 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003313 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003315}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003316#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003317
Paul Bakker5121ce52009-01-03 21:22:43 +00003318/*
3319 * SSL get accessors
3320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003321uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003322{
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 if (ssl->session != NULL) {
3324 return ssl->session->verify_result;
3325 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003326
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 if (ssl->session_negotiate != NULL) {
3328 return ssl->session_negotiate->verify_result;
3329 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003330
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003332}
3333
Gilles Peskine449bd832023-01-11 14:50:10 +01003334int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003335{
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ssl == NULL || ssl->session == NULL) {
3337 return 0;
3338 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003339
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003341}
3342
Gilles Peskine449bd832023-01-11 14:50:10 +01003343const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003344{
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 if (ssl == NULL || ssl->session == NULL) {
3346 return NULL;
3347 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003350}
3351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003353{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3356 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003357 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003359 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003361 }
3362 }
3363#endif
3364
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003366 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003368 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003370 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003372 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003373}
3374
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003375#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003376size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003377{
David Horstmann95d516f2021-05-04 18:36:56 +01003378 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003379 size_t read_mfl;
3380
Jerry Yuddda0502022-12-01 19:43:12 +08003381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003382 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3384 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3385 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003386 }
Jerry Yuddda0502022-12-01 19:43:12 +08003387#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003388
3389 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 if (ssl->session_out != NULL) {
3391 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3392 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003393 max_len = read_mfl;
3394 }
3395 }
3396
Jerry Yuddda0502022-12-01 19:43:12 +08003397 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (ssl->session_negotiate != NULL) {
3399 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3400 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003401 max_len = read_mfl;
3402 }
3403 }
3404
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003406}
3407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003409{
3410 size_t max_len;
3411
3412 /*
3413 * Assume mfl_code is correct since it was checked when set
3414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003416
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003417 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (ssl->session_out != NULL &&
3419 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3420 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003421 }
3422
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003423 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003424 if (ssl->session_negotiate != NULL &&
3425 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3426 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003427 }
3428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003430}
3431#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3432
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003433#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003434size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003435{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003436 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003437 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3438 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3439 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3440 return 0;
3441 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3444 return ssl->mtu;
3445 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003446
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 if (ssl->mtu == 0) {
3448 return ssl->handshake->mtu;
3449 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003450
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 return ssl->mtu < ssl->handshake->mtu ?
3452 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003453}
3454#endif /* MBEDTLS_SSL_PROTO_DTLS */
3455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003457{
3458 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3459
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003460#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3461 !defined(MBEDTLS_SSL_PROTO_DTLS)
3462 (void) ssl;
3463#endif
3464
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003465#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003466 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003467
Gilles Peskine449bd832023-01-11 14:50:10 +01003468 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003469 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003470 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003471#endif
3472
3473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3475 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3476 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003477 const size_t overhead = (size_t) ret;
3478
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 if (ret < 0) {
3480 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003481 }
3482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 if (mtu <= overhead) {
3484 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3485 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3486 }
3487
3488 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003489 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003491 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003492#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003493
Hanno Becker0defedb2018-08-10 12:35:02 +01003494#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3495 !defined(MBEDTLS_SSL_PROTO_DTLS)
3496 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003497#endif
3498
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003500}
3501
Gilles Peskine449bd832023-01-11 14:50:10 +01003502int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003503{
3504 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3505
3506#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3507 (void) ssl;
3508#endif
3509
3510#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003512
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003514 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003516#endif
3517
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003519}
3520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003522const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003523{
Gilles Peskine449bd832023-01-11 14:50:10 +01003524 if (ssl == NULL || ssl->session == NULL) {
3525 return NULL;
3526 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003527
Hanno Beckere6824572019-02-07 13:18:46 +00003528#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003529 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003530#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003531 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003532#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003533}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003537int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3538 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003539{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003540 int ret;
3541
Gilles Peskine449bd832023-01-11 14:50:10 +01003542 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003543 dst == NULL ||
3544 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003545 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3546 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003547 }
3548
Hanno Beckere810bbc2021-05-14 16:01:05 +01003549 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3550 * idempotent: Each session can only be exported once.
3551 *
3552 * (This is in preparation for TLS 1.3 support where we will
3553 * need the ability to export multiple sessions (aka tickets),
3554 * which will be achieved by calling mbedtls_ssl_get_session()
3555 * multiple times until it fails.)
3556 *
3557 * Check whether we have already exported the current session,
3558 * and fail if so.
3559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003560 if (ssl->session->exported == 1) {
3561 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3562 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003563
Gilles Peskine449bd832023-01-11 14:50:10 +01003564 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3565 if (ret != 0) {
3566 return ret;
3567 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003568
3569 /* Remember that we've exported the session. */
3570 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003571 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003572}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003574
Paul Bakker5121ce52009-01-03 21:22:43 +00003575/*
Hanno Beckera835da52019-05-16 12:39:07 +01003576 * Define ticket header determining Mbed TLS version
3577 * and structure of the ticket.
3578 */
3579
Hanno Becker94ef3b32019-05-16 12:50:45 +01003580/*
Hanno Becker50b59662019-05-28 14:30:45 +01003581 * Define bitflag determining compile-time settings influencing
3582 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003583 */
3584
Hanno Becker50b59662019-05-28 14:30:45 +01003585#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003586#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003587#else
Hanno Becker3e088662019-05-29 11:10:18 +01003588#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003589#endif /* MBEDTLS_HAVE_TIME */
3590
3591#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003592#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003593#else
Hanno Becker3e088662019-05-29 11:10:18 +01003594#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003595#endif /* MBEDTLS_X509_CRT_PARSE_C */
3596
3597#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003598#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003599#else
Hanno Becker3e088662019-05-29 11:10:18 +01003600#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003601#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3602
3603#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003604#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003605#else
Hanno Becker3e088662019-05-29 11:10:18 +01003606#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003607#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3608
Hanno Becker94ef3b32019-05-16 12:50:45 +01003609#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003610#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003611#else
Hanno Becker3e088662019-05-29 11:10:18 +01003612#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003613#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3614
Hanno Becker94ef3b32019-05-16 12:50:45 +01003615#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3616#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3617#else
3618#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3619#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3620
Hanno Becker3e088662019-05-29 11:10:18 +01003621#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3622#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3623#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3624#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003625#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3626#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003627
Hanno Becker50b59662019-05-28 14:30:45 +01003628#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003629 ((uint16_t) ( \
3630 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3631 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3632 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3633 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3634 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3635 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3636 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003637
Hanno Beckerf8787072019-05-16 12:41:07 +01003638static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003639 MBEDTLS_VERSION_MAJOR,
3640 MBEDTLS_VERSION_MINOR,
3641 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003642 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3643 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003644};
Hanno Beckera835da52019-05-16 12:39:07 +01003645
3646/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003647 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003648 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003649 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003650 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003651 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003652 * opaque mbedtls_version[3]; // library version: major, minor, patch
3653 * opaque session_format[2]; // library-version specific 16-bit field
3654 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003655 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003656 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003657 * Note: When updating the format, remember to keep
3658 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003659 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003660 * // In this version, `session_format` determines
3661 * // the setting of those compile-time
3662 * // configuration options which influence
3663 * // the structure of mbedtls_ssl_session.
3664 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003665 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003666 * // - TLS 1.2 (0x0303)
3667 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003668 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003669 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003670 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003671 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003672 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003673 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003674 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003675 *
3676 * };
3677 *
3678 * } serialized_session;
3679 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003680 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003681
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003682MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003683static int ssl_session_save(const mbedtls_ssl_session *session,
3684 unsigned char omit_header,
3685 unsigned char *buf,
3686 size_t buf_len,
3687 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003688{
3689 unsigned char *p = buf;
3690 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003691 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003692#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3693 size_t out_len;
3694 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3695#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 if (session == NULL) {
3697 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3698 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003699
Gilles Peskine449bd832023-01-11 14:50:10 +01003700 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003701 /*
3702 * Add Mbed TLS version identifier
3703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003704 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003705
Gilles Peskine449bd832023-01-11 14:50:10 +01003706 if (used <= buf_len) {
3707 memcpy(p, ssl_serialized_session_header,
3708 sizeof(ssl_serialized_session_header));
3709 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003710 }
3711 }
3712
3713 /*
3714 * TLS version identifier
3715 */
3716 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003717 if (used <= buf_len) {
3718 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003719 }
3720
3721 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003722 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003723 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003724#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003725 case MBEDTLS_SSL_VERSION_TLS1_2:
3726 used += ssl_tls12_session_save(session, p, remaining_len);
3727 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003728#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3729
Jerry Yu251a12e2022-07-13 15:15:48 +08003730#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003731 case MBEDTLS_SSL_VERSION_TLS1_3:
3732 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3733 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3734 return ret;
3735 }
3736 used += out_len;
3737 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003738#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3739
Gilles Peskine449bd832023-01-11 14:50:10 +01003740 default:
3741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003742 }
3743
3744 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003745 if (used > buf_len) {
3746 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3747 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003748
Gilles Peskine449bd832023-01-11 14:50:10 +01003749 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003750}
3751
3752/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003753 * Public wrapper for ssl_session_save()
3754 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003755int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3756 unsigned char *buf,
3757 size_t buf_len,
3758 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003759{
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003761}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003762
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003763/*
3764 * Deserialize session, see mbedtls_ssl_session_save() for format.
3765 *
3766 * This internal version is wrapped by a public function that cleans up in
3767 * case of error, and has an extra option omit_header.
3768 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003769MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003770static int ssl_session_load(mbedtls_ssl_session *session,
3771 unsigned char omit_header,
3772 const unsigned char *buf,
3773 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003774{
3775 const unsigned char *p = buf;
3776 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003777 size_t remaining_len;
3778
3779
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 if (session == NULL) {
3781 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3782 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003785 /*
3786 * Check Mbed TLS version identifier
3787 */
3788
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3790 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003791 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003792
3793 if (memcmp(p, ssl_serialized_session_header,
3794 sizeof(ssl_serialized_session_header)) != 0) {
3795 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3796 }
3797 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003798 }
3799
3800 /*
3801 * TLS version identifier
3802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003803 if (1 > (size_t) (end - p)) {
3804 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3805 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003806 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003807
3808 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003809 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003810 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003811#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003812 case MBEDTLS_SSL_VERSION_TLS1_2:
3813 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003814#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3815
Jerry Yu438ddd82022-07-07 06:55:50 +00003816#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 case MBEDTLS_SSL_VERSION_TLS1_3:
3818 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003819#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3820
Gilles Peskine449bd832023-01-11 14:50:10 +01003821 default:
3822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003823 }
3824}
3825
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003826/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003827 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003829int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3830 const unsigned char *buf,
3831 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003832{
Gilles Peskine449bd832023-01-11 14:50:10 +01003833 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003834
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 if (ret != 0) {
3836 mbedtls_ssl_session_free(session);
3837 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003838
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003840}
3841
3842/*
Paul Bakker1961b702013-01-25 14:49:24 +01003843 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003844 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003845MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003846static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003847{
3848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3849
Ronald Cron66dbf912022-02-02 15:33:46 +01003850 /*
3851 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003852 * that were written into the output buffer by the previous handshake step,
3853 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003854 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3855 * We proceed to the next handshake step only when all data from the
3856 * previous one have been sent to the peer, thus we make sure that this is
3857 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3858 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3859 * we have to wait before to go ahead.
3860 * In the case of TLS 1.3, handshake step handlers do not send data to the
3861 * peer. Data are only sent here and through
3862 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003863 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003865 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3866 return ret;
3867 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003868
3869#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3871 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3872 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3873 return ret;
3874 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003875 }
3876#endif /* MBEDTLS_SSL_PROTO_DTLS */
3877
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003879}
3880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003882{
Hanno Becker41934dd2021-08-07 19:13:43 +01003883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003884
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003886 ssl->conf == NULL ||
3887 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003890 }
3891
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 ret = ssl_prepare_handshake_step(ssl);
3893 if (ret != 0) {
3894 return ret;
3895 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003896
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 ret = mbedtls_ssl_handle_pending_alert(ssl);
3898 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003899 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003900 }
Jerry Yue7047812021-09-13 19:26:39 +08003901
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003902 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3903 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3904 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003906#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3908 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003909 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003910
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003912 case MBEDTLS_SSL_HELLO_REQUEST:
3913 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003914 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003915 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003916
Ronald Cron9f0fba32022-02-10 16:45:15 +01003917 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003919 break;
3920
3921 default:
3922#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3924 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3925 } else {
3926 ret = mbedtls_ssl_handshake_client_step(ssl);
3927 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003928#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003930#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003932#endif
3933 }
Jerry Yub9930e72021-08-06 17:11:51 +08003934 }
Ronald Cron6291b232023-03-08 15:51:25 +01003935#endif /* MBEDTLS_SSL_CLI_C */
3936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003937#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003939#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3940 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003942 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 ret = mbedtls_ssl_handshake_server_step(ssl);
3944 }
Ronald Cron6291b232023-03-08 15:51:25 +01003945#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3946 ret = mbedtls_ssl_handshake_server_step(ssl);
3947#else
3948 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003949#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003950 }
3951#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003954 /* handshake_step return error. And it is same
3955 * with alert_reason.
3956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 if (ssl->send_alert) {
3958 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003959 goto cleanup;
3960 }
3961 }
3962
3963cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003965}
3966
3967/*
3968 * Perform the SSL handshake
3969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003970int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003971{
3972 int ret = 0;
3973
Hanno Beckera817ea42020-10-20 15:20:23 +01003974 /* Sanity checks */
3975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 if (ssl == NULL || ssl->conf == NULL) {
3977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3978 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003979
Hanno Beckera817ea42020-10-20 15:20:23 +01003980#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003981 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3982 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3983 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3984 "mbedtls_ssl_set_timer_cb() for DTLS"));
3985 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003986 }
3987#endif /* MBEDTLS_SSL_PROTO_DTLS */
3988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003990
Hanno Beckera817ea42020-10-20 15:20:23 +01003991 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3993 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003994
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003996 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 }
Paul Bakker1961b702013-01-25 14:49:24 +01003998 }
3999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004003}
4004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004005#if defined(MBEDTLS_SSL_RENEGOTIATION)
4006#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004007/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004008 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004009 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004010MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004011static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004012{
Janos Follath865b3eb2019-12-16 11:46:15 +00004013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004016
4017 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004018 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4019 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4022 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4023 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004024 }
4025
Gilles Peskine449bd832023-01-11 14:50:10 +01004026 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004029}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004030#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004031
4032/*
4033 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004034 * - any side: calling mbedtls_ssl_renegotiate(),
4035 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4036 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004037 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004038 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004039 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004041int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004042{
Janos Follath865b3eb2019-12-16 11:46:15 +00004043 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if ((ret = ssl_handshake_init(ssl)) != 0) {
4048 return ret;
4049 }
Paul Bakker48916f92012-09-16 19:57:18 +00004050
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004051 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4052 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004053#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4055 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4056 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004057 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004059 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004061 }
4062#endif
4063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004064 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4065 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4068 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4069 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004070 }
4071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004075}
4076
4077/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004078 * Renegotiate current connection on client,
4079 * or request renegotiation on server
4080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004081int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004082{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004083 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (ssl == NULL || ssl->conf == NULL) {
4086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4087 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004089#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004090 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4092 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4094 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004096 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004097
4098 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (ssl->out_left != 0) {
4100 return mbedtls_ssl_flush_output(ssl);
4101 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004104 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004105#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004107#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004108 /*
4109 * On client, either start the renegotiation process or,
4110 * if already in progress, continue the handshake
4111 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4113 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004116
4117 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4118 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4119 return ret;
4120 }
4121 } else {
4122 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4124 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004125 }
4126 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004127#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004130}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004134{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004135 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4136
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004138 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004140
Valerio Setti6f0441d2023-07-03 12:11:36 +02004141#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (ssl->handshake->group_list_heap_allocated) {
4144 mbedtls_free((void *) handshake->group_list);
4145 }
Brett Warrene0edc842021-08-17 09:53:13 +01004146 handshake->group_list = NULL;
4147#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004148#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004149
Ronald Crone68ab4f2022-10-05 12:46:29 +02004150#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004151#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (ssl->handshake->sig_algs_heap_allocated) {
4153 mbedtls_free((void *) handshake->sig_algs);
4154 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004155 handshake->sig_algs = NULL;
4156#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004157#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (ssl->handshake->certificate_request_context) {
4159 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004160 }
4161#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004162#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004163
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004164#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4166 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004167 handshake->async_in_progress = 0;
4168 }
4169#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4170
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004171#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004172#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004174#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004175 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004176#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004177#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004178#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004179#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004181#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004182 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004183#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004184#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004186#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004188#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004189#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004190 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004192#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004193
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004194#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004195#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004197 /*
4198 * Opaque keys are not stored in the handshake's data and it's the user
4199 * responsibility to destroy them. Clear ones, instead, are created by
4200 * the TLS library and should be destroyed at the same level
4201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4203 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004204 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004205 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4206#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004208#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004209#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004211 handshake->ecjpake_cache = NULL;
4212 handshake->ecjpake_cache_len = 0;
4213#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004214#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004215
Valerio Setti7aeec542023-07-05 18:57:21 +02004216#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004217 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004218 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004219 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004221#endif
4222
Ronald Cron73fe8df2022-10-05 14:31:43 +02004223#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004224#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004226 /* The maintenance of the external PSK key slot is the
4227 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (ssl->handshake->psk_opaque_is_internal) {
4229 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004230 ssl->handshake->psk_opaque_is_internal = 0;
4231 }
4232 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4233 }
Neil Armstronge952a302022-05-03 10:22:14 +02004234#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004235 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004236 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004237 }
Neil Armstronge952a302022-05-03 10:22:14 +02004238#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004239#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004241#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4242 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004243 /*
4244 * Free only the linked list wrapper, not the keys themselves
4245 * since the belong to the SNI callback
4246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004249
Gilles Peskineeccd8882020-03-10 12:19:08 +01004250#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4252 if (handshake->ecrs_peer_cert != NULL) {
4253 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4254 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004255 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004256#endif
4257
Hanno Becker75173122019-02-06 16:18:31 +00004258#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4259 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004261#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4262
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004263#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4265 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004266#endif /* MBEDTLS_SSL_CLI_C &&
4267 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004268
4269#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 mbedtls_ssl_flight_free(handshake->flight);
4271 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004272#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004273
Valerio Settiea59c432023-07-25 11:14:03 +02004274#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004275 if (handshake->xxdh_psa_privkey_is_external == 0) {
4276 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 }
Valerio Settiea59c432023-07-25 11:14:03 +02004278#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004279
Ronald Cron6f135e12021-12-08 16:57:54 +01004280#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 mbedtls_ssl_transform_free(handshake->transform_handshake);
4282 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004283#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4285 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004286#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004287#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004288
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004289
4290#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4291 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4292 * processes datagrams and the fact that a datagram is allowed to have
4293 * several records in it, it is possible that the I/O buffers are not
4294 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4296 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004297#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004298
Jerry Yuba9c7272021-10-30 11:54:10 +08004299 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 mbedtls_platform_zeroize(handshake,
4301 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004302}
4303
Gilles Peskine449bd832023-01-11 14:50:10 +01004304void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004305{
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004307 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004310#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004312#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004313
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004314#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004315#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4316 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004318#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004320#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004323}
4324
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004325#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004326
4327#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4328#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4329#else
4330#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4331#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4332
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004333#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004334
4335#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4336#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4337#else
4338#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4339#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4340
4341#if defined(MBEDTLS_SSL_ALPN)
4342#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4343#else
4344#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4345#endif /* MBEDTLS_SSL_ALPN */
4346
4347#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4348#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4349#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4350#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4351
4352#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 ((uint32_t) ( \
4354 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4355 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4356 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4357 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4358 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4359 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4360 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4361 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004362
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004363static unsigned char ssl_serialized_context_header[] = {
4364 MBEDTLS_VERSION_MAJOR,
4365 MBEDTLS_VERSION_MINOR,
4366 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4368 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4369 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4370 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4371 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004372};
4373
Paul Bakker5121ce52009-01-03 21:22:43 +00004374/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004375 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004376 *
4377 * The format of the serialized data is:
4378 * (in the presentation language of TLS, RFC 8446 section 3)
4379 *
4380 * // header
4381 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004382 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004383 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004384 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004385 * Note: When updating the format, remember to keep these
4386 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004387 *
4388 * // session sub-structure
4389 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4390 * // transform sub-structure
4391 * uint8 random[64]; // ServerHello.random+ClientHello.random
4392 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4393 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4394 * // fields from ssl_context
4395 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4396 * uint64 in_window_top; // DTLS: last validated record seq_num
4397 * uint64 in_window; // DTLS: bitmask for replay protection
4398 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4399 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4400 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4401 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4402 *
4403 * Note that many fields of the ssl_context or sub-structures are not
4404 * serialized, as they fall in one of the following categories:
4405 *
4406 * 1. forced value (eg in_left must be 0)
4407 * 2. pointer to dynamically-allocated memory (eg session, transform)
4408 * 3. value can be re-derived from other data (eg session keys from MS)
4409 * 4. value was temporary (eg content of input buffer)
4410 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4413 unsigned char *buf,
4414 size_t buf_len,
4415 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004416{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004417 unsigned char *p = buf;
4418 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004419 size_t session_len;
4420 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004421
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004422 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004423 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4424 * this function's documentation.
4425 *
4426 * These are due to assumptions/limitations in the implementation. Some of
4427 * them are likely to stay (no handshake in progress) some might go away
4428 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004429 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004430 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4432 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4433 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004434 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (ssl->handshake != NULL) {
4436 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
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 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 if (ssl->transform == NULL || ssl->session == NULL) {
4441 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
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 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (mbedtls_ssl_check_pending(ssl) != 0) {
4446 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4447 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004448 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (ssl->out_left != 0) {
4450 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4451 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004452 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004453 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4455 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004457 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004458 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4460 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004462 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004463 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4465 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004467 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004468 /* Renegotiation must not be enabled */
4469#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4471 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4472 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004473 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004474#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004475
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004476 /*
4477 * Version and format identifier
4478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (used <= buf_len) {
4482 memcpy(p, ssl_serialized_context_header,
4483 sizeof(ssl_serialized_context_header));
4484 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004485 }
4486
4487 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004488 * Session (length + data)
4489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4491 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4492 return ret;
4493 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004494
4495 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (used <= buf_len) {
4497 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004498 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 ret = ssl_session_save(ssl->session, 1,
4501 p, session_len, &session_len);
4502 if (ret != 0) {
4503 return ret;
4504 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004505
4506 p += session_len;
4507 }
4508
4509 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004510 * Transform
4511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 used += sizeof(ssl->transform->randbytes);
4513 if (used <= buf_len) {
4514 memcpy(p, ssl->transform->randbytes,
4515 sizeof(ssl->transform->randbytes));
4516 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004517 }
4518
4519#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004520 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004522 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004524 p += ssl->transform->in_cid_len;
4525
4526 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004528 p += ssl->transform->out_cid_len;
4529 }
4530#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4531
4532 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004533 * Saved fields from top-level ssl_context structure
4534 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004535 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (used <= buf_len) {
4537 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004538 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004539 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004540
4541#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4542 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 if (used <= buf_len) {
4544 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004545 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004548 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004549 }
4550#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4551
4552#if defined(MBEDTLS_SSL_PROTO_DTLS)
4553 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004555 *p++ = ssl->disable_datagram_packing;
4556 }
4557#endif /* MBEDTLS_SSL_PROTO_DTLS */
4558
Jerry Yuae0b2e22021-10-08 15:21:19 +08004559 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (used <= buf_len) {
4561 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004562 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004563 }
4564
4565#if defined(MBEDTLS_SSL_PROTO_DTLS)
4566 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (used <= buf_len) {
4568 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004569 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004570 }
4571#endif /* MBEDTLS_SSL_PROTO_DTLS */
4572
4573#if defined(MBEDTLS_SSL_ALPN)
4574 {
4575 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004577 : 0;
4578
4579 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004581 *p++ = alpn_len;
4582
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 if (ssl->alpn_chosen != NULL) {
4584 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004585 p += alpn_len;
4586 }
4587 }
4588 }
4589#endif /* MBEDTLS_SSL_ALPN */
4590
4591 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004592 * Done
4593 */
4594 *olen = used;
4595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (used > buf_len) {
4597 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4598 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004603}
4604
4605/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004606 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004607 *
4608 * This internal version is wrapped by a public function that cleans up in
4609 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004610 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004612static int ssl_context_load(mbedtls_ssl_context *ssl,
4613 const unsigned char *buf,
4614 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004615{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004616 const unsigned char *p = buf;
4617 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004618 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004620#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004621 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004622#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004623
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004624 /*
4625 * The context should have been freshly setup or reset.
4626 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004627 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004628 * renegotiating, or if the user mistakenly loaded a session first.)
4629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004630 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4631 ssl->session != NULL) {
4632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004633 }
4634
4635 /*
4636 * We can't check that the config matches the initial one, but we can at
4637 * least check it matches the requirements for serializing.
4638 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004639 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004640#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004641 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004642#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004643 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4644 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4645 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4646 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004648 }
4649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004651
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004652 /*
4653 * Check version identifier
4654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004657 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004658
4659 if (memcmp(p, ssl_serialized_context_header,
4660 sizeof(ssl_serialized_context_header)) != 0) {
4661 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4662 }
4663 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004664
4665 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004666 * Session
4667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if ((size_t) (end - p) < 4) {
4669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4670 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004671
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004672 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004673 p += 4;
4674
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004675 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004676 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004677 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004678 ssl->session_in = ssl->session;
4679 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004680 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if ((size_t) (end - p) < session_len) {
4683 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4684 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 ret = ssl_session_load(ssl->session, 1, p, session_len);
4687 if (ret != 0) {
4688 mbedtls_ssl_session_free(ssl->session);
4689 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004690 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004691
4692 p += session_len;
4693
4694 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695 * Transform
4696 */
4697
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004698 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004699 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004700#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004701 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004702 ssl->transform_in = ssl->transform;
4703 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004704 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004705#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004706
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004707#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4709 if (prf_func == NULL) {
4710 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4711 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004712
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004713 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4716 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 ret = ssl_tls12_populate_transform(ssl->transform,
4719 ssl->session->ciphersuite,
4720 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004721#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004723#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 prf_func,
4725 p, /* currently pointing to randbytes */
4726 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4727 ssl->conf->endpoint,
4728 ssl);
4729 if (ret != 0) {
4730 return ret;
4731 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004734
4735#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4736 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if ((size_t) (end - p) < 1) {
4738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4739 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004740
4741 ssl->transform->in_cid_len = *p++;
4742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4745 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004748 p += ssl->transform->in_cid_len;
4749
4750 ssl->transform->out_cid_len = *p++;
4751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4754 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004757 p += ssl->transform->out_cid_len;
4758#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4759
4760 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004761 * Saved fields from top-level ssl_context structure
4762 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 if ((size_t) (end - p) < 4) {
4764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4765 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004766
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004767 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004768 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004769
4770#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if ((size_t) (end - p) < 16) {
4772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4773 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004775 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004776 p += 8;
4777
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004778 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004779 p += 8;
4780#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4781
4782#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if ((size_t) (end - p) < 1) {
4784 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4785 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004786
4787 ssl->disable_datagram_packing = *p++;
4788#endif /* MBEDTLS_SSL_PROTO_DTLS */
4789
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4792 }
4793 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4794 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004795
4796#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if ((size_t) (end - p) < 2) {
4798 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4799 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004800
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004801 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004802 p += 2;
4803#endif /* MBEDTLS_SSL_PROTO_DTLS */
4804
4805#if defined(MBEDTLS_SSL_ALPN)
4806 {
4807 uint8_t alpn_len;
4808 const char **cur;
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if ((size_t) (end - p) < 1) {
4811 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4812 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004813
4814 alpn_len = *p++;
4815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004817 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4819 if (strlen(*cur) == alpn_len &&
4820 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004821 ssl->alpn_chosen = *cur;
4822 break;
4823 }
4824 }
4825 }
4826
4827 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4830 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004831
4832 p += alpn_len;
4833 }
4834#endif /* MBEDTLS_SSL_ALPN */
4835
4836 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004837 * Forced fields from top-level ssl_context structure
4838 *
4839 * Most of them already set to the correct value by mbedtls_ssl_init() and
4840 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4841 */
4842 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004843 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004844
Hanno Becker361b10d2019-08-30 10:42:49 +01004845 /* Adjust pointers for header fields of outgoing records to
4846 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004848
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004849#if defined(MBEDTLS_SSL_PROTO_DTLS)
4850 ssl->in_epoch = 1;
4851#endif
4852
4853 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4854 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004855 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4856 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if (ssl->handshake != NULL) {
4858 mbedtls_ssl_handshake_free(ssl);
4859 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004860 ssl->handshake = NULL;
4861 }
4862
4863 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004864 * Done - should have consumed entire buffer
4865 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (p != end) {
4867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4868 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004871}
4872
4873/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004874 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004876int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4877 const unsigned char *buf,
4878 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004879{
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (ret != 0) {
4883 mbedtls_ssl_free(context);
4884 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004887}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004888#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004889
4890/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004891 * Free an SSL context
4892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004894{
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004896 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004902#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4903 size_t out_buf_len = ssl->out_buf_len;
4904#else
4905 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4906#endif
4907
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004908 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004909 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 }
4911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004913#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4914 size_t in_buf_len = ssl->in_buf_len;
4915#else
4916 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4917#endif
4918
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004919 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004920 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004921 }
4922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (ssl->transform) {
4924 mbedtls_ssl_transform_free(ssl->transform);
4925 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004926 }
4927
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (ssl->handshake) {
4929 mbedtls_ssl_handshake_free(ssl);
4930 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004931
4932#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4934 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004935#endif
4936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 mbedtls_ssl_session_free(ssl->session_negotiate);
4938 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004939 }
4940
Ronald Cron6f135e12021-12-08 16:57:54 +01004941#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 mbedtls_ssl_transform_free(ssl->transform_application);
4943 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004944#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 if (ssl->session) {
4947 mbedtls_ssl_session_free(ssl->session);
4948 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004949 }
4950
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004951#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004953 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004954 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004955#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004956
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004957#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004959#endif
4960
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004962
Paul Bakker86f04f42013-02-14 11:20:09 +01004963 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004965}
4966
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004967/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004968 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004971{
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004973}
4974
Gilles Peskineae270bf2021-06-02 00:05:29 +02004975/* The selection should be the same as mbedtls_x509_crt_profile_default in
4976 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004977 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004978 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004979 * about this list.
4980 */
Brett Warrene0edc842021-08-17 09:53:13 +01004981static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004982#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004983 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004984#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004985#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004986 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004987#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004988#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004989 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004990#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004991#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004992 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004993#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004994#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004995 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004996#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004997#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004998 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004999#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005000#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005001 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005002#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005003#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005004 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005005#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005006#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005007 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5008 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5009 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5010 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5011 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5012#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005013 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005014};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005015
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005016static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005017 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5018 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5019 0
5020};
5021
Ronald Crone68ab4f2022-10-05 12:46:29 +02005022#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005023
Jerry Yu909df7b2022-01-22 11:56:27 +08005024/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005025 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005026 * rules SHOULD be upheld.
5027 * - No duplicate entries.
5028 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005029 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005030 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005031 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005032static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005033
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005034#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005035 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005036 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005037 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005038 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5039#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005040
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005041#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005042 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005043 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005044 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005045 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5046#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005047
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005048#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005049 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005050 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005051 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005052 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5053#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005056 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005057 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005058#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005059 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005062 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005063 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005064#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005065 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005068 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005069 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005070#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005071 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005072
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005073#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005074 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005075#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005076
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005077#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005078 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005080
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005081#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005082 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005084
Gabor Mezei15b95a62022-05-09 16:37:58 +02005085 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005086};
5087
5088/* NOTICE: see above */
5089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5090static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005091#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005092#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005094#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005095#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5096 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5097#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005098#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005100#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005101#endif /* MBEDTLS_MD_CAN_SHA512*/
5102#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005103#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005105#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005106#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5107 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5108#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005109#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005111#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005112#endif /* MBEDTLS_MD_CAN_SHA384*/
5113#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005114#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005116#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005117#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5118 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5119#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005120#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005122#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005123#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005124 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005125};
5126#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5127/* NOTICE: see above */
5128static uint16_t ssl_preset_suiteb_sig_algs[] = {
5129
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005130#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005131 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005132 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005133 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005134 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5135#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005136
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005137#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005138 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005139 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005140 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005141 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5142#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005145 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005146 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005147#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005148 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005149
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005150#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005151 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005152#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005153
Gabor Mezei15b95a62022-05-09 16:37:58 +02005154 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005155};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005156
Jerry Yu909df7b2022-01-22 11:56:27 +08005157/* NOTICE: see above */
5158#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5159static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005160#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005161#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005163#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005164#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005166#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005167#endif /* MBEDTLS_MD_CAN_SHA256*/
5168#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005169#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005171#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005172#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005174#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005175#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005176 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005177};
Jerry Yu909df7b2022-01-22 11:56:27 +08005178#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5179
Ronald Crone68ab4f2022-10-05 12:46:29 +02005180#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005181
Brett Warrene0edc842021-08-17 09:53:13 +01005182static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005183#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005184 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005185#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005186#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005187 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005188#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005189 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005190};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005191
Ronald Crone68ab4f2022-10-05 12:46:29 +02005192#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005193/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005194 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005195MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005196static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005197{
5198 size_t i, j;
5199 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5202 for (j = 0; j < i; j++) {
5203 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005204 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 }
5206 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5207 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5208 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005209 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005210 }
5211 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005213}
5214
Ronald Crone68ab4f2022-10-05 12:46:29 +02005215#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005216
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005217/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005218 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005219 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005220int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5221 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005222{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005223#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005225#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005226
Ronald Crone68ab4f2022-10-05 12:46:29 +02005227#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5229 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5230 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005231 }
5232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5234 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5235 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005236 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005237
5238#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5240 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5241 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005242 }
5243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5245 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5246 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005247 }
5248#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005249#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005250
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005251 /* Use the functions here so that they are covered in tests,
5252 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 mbedtls_ssl_conf_endpoint(conf, endpoint);
5254 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005255
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005256 /*
5257 * Things that are common to all presets
5258 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005259#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005261 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5262#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5263 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5264#endif
5265 }
5266#endif
5267
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005268#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5269 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5270#endif
5271
5272#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5273 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5274#endif
5275
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005276#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005277 conf->f_cookie_write = ssl_cookie_write_dummy;
5278 conf->f_cookie_check = ssl_cookie_check_dummy;
5279#endif
5280
5281#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5282 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5283#endif
5284
Janos Follath088ce432017-04-10 12:42:31 +01005285#if defined(MBEDTLS_SSL_SRV_C)
5286 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005287 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005288#endif
5289
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005290#if defined(MBEDTLS_SSL_PROTO_DTLS)
5291 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5292 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5293#endif
5294
5295#if defined(MBEDTLS_SSL_RENEGOTIATION)
5296 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 memset(conf->renego_period, 0x00, 2);
5298 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005299#endif
5300
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005301#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005303 const unsigned char dhm_p[] =
5304 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5305 const unsigned char dhm_g[] =
5306 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5309 dhm_p, sizeof(dhm_p),
5310 dhm_g, sizeof(dhm_g))) != 0) {
5311 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005312 }
5313 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005314#endif
5315
Ronald Cron6f135e12021-12-08 16:57:54 +01005316#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005317
5318#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005319 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005320#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005321 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005322#endif
5323#endif /* MBEDTLS_SSL_EARLY_DATA */
5324
Jerry Yud0766ec2022-09-22 10:46:57 +08005325#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005326 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005328#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005329 /*
5330 * Allow all TLS 1.3 key exchange modes by default.
5331 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005332 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005333#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005334
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005336#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005337 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005338 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005339#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005341#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005343#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005344 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5345 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005346#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5347 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5348 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5349#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5350 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5351 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5352#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005354#endif
5355 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005356
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005357 /*
5358 * Preset-specific defaults
5359 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005361 /*
5362 * NSA Suite B
5363 */
5364 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005365
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005366 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005367
5368#if defined(MBEDTLS_X509_CRT_PARSE_C)
5369 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005370#endif
5371
Ronald Crone68ab4f2022-10-05 12:46:29 +02005372#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005373#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005375 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005377#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005379#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005380
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005381#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005382 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005383#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005384 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005385 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005386
5387 /*
5388 * Default
5389 */
5390 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005391
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005392 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005393
5394#if defined(MBEDTLS_X509_CRT_PARSE_C)
5395 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5396#endif
5397
Ronald Crone68ab4f2022-10-05 12:46:29 +02005398#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005399#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005401 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005403#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005405#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005406
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005407#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005408 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005409#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005410 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005411
5412#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5413 conf->dhm_min_bitlen = 1024;
5414#endif
5415 }
5416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005418}
5419
5420/*
5421 * Free mbedtls_ssl_config
5422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005423void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005424{
5425#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 mbedtls_mpi_free(&conf->dhm_P);
5427 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005428#endif
5429
Ronald Cron73fe8df2022-10-05 14:31:43 +02005430#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005431#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005433 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5434 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005435#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005437 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005438 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005439 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005440 }
5441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005443 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005444 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005445 conf->psk_identity_len = 0;
5446 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005447#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005448
5449#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005451#endif
5452
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005454}
5455
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005456#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005457 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005458/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005461unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005462{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5465 return MBEDTLS_SSL_SIG_RSA;
5466 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005467#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005468#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5470 return MBEDTLS_SSL_SIG_ECDSA;
5471 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005472#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005474}
5475
Gilles Peskine449bd832023-01-11 14:50:10 +01005476unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005477{
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005479 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005481 case MBEDTLS_PK_ECDSA:
5482 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005484 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005486 }
5487}
5488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005490{
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492#if defined(MBEDTLS_RSA_C)
5493 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005495#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005496#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005499#endif
5500 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005502 }
5503}
Valerio Settie9646ec2023-08-02 20:02:28 +02005504#endif /* MBEDTLS_PK_C &&
5505 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005506
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005507/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005508 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005510mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005511{
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005513#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005514 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005516#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005517#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005518 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005520#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005521#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005524#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005525#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005528#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005529#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005532#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005533#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005534 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005536#endif
5537 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005539 }
5540}
5541
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005542/*
5543 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005545unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005546{
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005548#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005549 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005551#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005552#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005553 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005555#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005556#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005557 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005559#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005560#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005561 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005562 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005563#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005564#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005565 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005567#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005568#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005569 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005571#endif
5572 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005574 }
5575}
5576
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005577/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005578 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005579 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005581int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005582{
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005584
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (group_list == NULL) {
5586 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005587 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005588
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 for (; *group_list != 0; group_list++) {
5590 if (*group_list == tls_id) {
5591 return 0;
5592 }
5593 }
5594
5595 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005596}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005597
Valerio Setti49e69072023-06-27 17:27:51 +02005598#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005599/*
5600 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005603{
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005605
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005607 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005609
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005611}
Valerio Setti49e69072023-06-27 17:27:51 +02005612#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005613
Valerio Setti18c9fed2022-12-30 17:44:24 +01005614static const struct {
5615 uint16_t tls_id;
5616 mbedtls_ecp_group_id ecp_group_id;
5617 psa_ecc_family_t psa_family;
5618 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005619} tls_id_match_table[] =
5620{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005621#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005622 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005623#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005624#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005625 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005626#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005627#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005628 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005629#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005630#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005631 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005633#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005634 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005636#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005637 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005638#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005639#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005640 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005641#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005642#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005643 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005644#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005645#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005646 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005648#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005649 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005650#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005651#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005652 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005653#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005654#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005655 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005656#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005657#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005658 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005659#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005660 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005661};
5662
Gilles Peskine449bd832023-01-11 14:50:10 +01005663int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005664 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666{
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5668 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005669 if (type != NULL) {
5670 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 }
5672 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005673 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005675 return PSA_SUCCESS;
5676 }
5677 }
5678
5679 return PSA_ERROR_NOT_SUPPORTED;
5680}
5681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005683{
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5685 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005686 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005688 }
5689
5690 return MBEDTLS_ECP_DP_NONE;
5691}
5692
Gilles Peskine449bd832023-01-11 14:50:10 +01005693uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005694{
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5696 i++) {
5697 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005698 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005700 }
5701
5702 return 0;
5703}
5704
Valerio Setti67419f02023-01-04 16:12:42 +01005705#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005706static const struct {
5707 uint16_t tls_id;
5708 const char *name;
5709} tls_id_curve_name_table[] =
5710{
Valerio Setti54e23792023-07-07 10:49:27 +02005711 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5712 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5713 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5714 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5715 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5716 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5717 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5718 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5719 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5720 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5721 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5722 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5723 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005724 { 0, NULL },
5725};
5726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005728{
Valerio Settiacd32c02023-06-29 18:06:29 +02005729 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5730 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5731 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005733 }
5734
5735 return NULL;
5736}
Valerio Setti67419f02023-01-04 16:12:42 +01005737#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005739#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005740int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5741 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5742 int cert_endpoint,
5743 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005744{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005745 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005746 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005747 const char *ext_oid;
5748 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005749
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005751 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005753 case MBEDTLS_KEY_EXCHANGE_RSA:
5754 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005755 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005756 break;
5757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005758 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5759 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5760 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5761 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005762 break;
5763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005764 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5765 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005766 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005767 break;
5768
5769 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005770 case MBEDTLS_KEY_EXCHANGE_NONE:
5771 case MBEDTLS_KEY_EXCHANGE_PSK:
5772 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5773 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005774 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005775 usage = 0;
5776 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5779 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005780 }
5781
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005783 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005784 ret = -1;
5785 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005786
Gilles Peskine449bd832023-01-11 14:50:10 +01005787 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5790 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005793 }
5794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005796 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005797 ret = -1;
5798 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005799
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005801}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005803
Jerry Yu148165c2021-09-24 23:20:59 +08005804#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005805int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5806 const mbedtls_md_type_t md,
5807 unsigned char *dst,
5808 size_t dst_len,
5809 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005810{
Ronald Cronf6893e12022-01-07 22:09:01 +01005811 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5812 psa_hash_operation_t *hash_operation_to_clone;
5813 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5814
Jerry Yu148165c2021-09-24 23:20:59 +08005815 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005818#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 case MBEDTLS_MD_SHA384:
5820 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5821 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005822#endif
5823
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005824#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 case MBEDTLS_MD_SHA256:
5826 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5827 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005828#endif
5829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 default:
5831 goto exit;
5832 }
5833
5834 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5835 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005836 goto exit;
5837 }
5838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5840 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005841 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005843
5844exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005845#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5846 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005847 (void) ssl;
5848#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005849 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005850}
5851#else /* MBEDTLS_USE_PSA_CRYPTO */
5852
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005853#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005854MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005855static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5856 unsigned char *dst,
5857 size_t dst_len,
5858 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005859{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005861 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 if (dst_len < 48) {
5864 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5865 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005867 mbedtls_md_init(&sha384);
5868 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005869 if (ret != 0) {
5870 goto exit;
5871 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005872 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005873 if (ret != 0) {
5874 goto exit;
5875 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005876
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005877 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005878 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005879 goto exit;
5880 }
5881
5882 *olen = 48;
5883
5884exit:
5885
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005886 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005888}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005889#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005891#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005892MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005893static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5894 unsigned char *dst,
5895 size_t dst_len,
5896 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005897{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005898 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005899 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005900
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 if (dst_len < 32) {
5902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5903 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005904
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005905 mbedtls_md_init(&sha256);
5906 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5907 if (ret != 0) {
5908 goto exit;
5909 }
5910 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5911 if (ret != 0) {
5912 goto exit;
5913 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005914
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005915 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5916 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005917 goto exit;
5918 }
5919
5920 *olen = 32;
5921
5922exit:
5923
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005924 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005926}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005927#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5930 const mbedtls_md_type_t md,
5931 unsigned char *dst,
5932 size_t dst_len,
5933 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005934{
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005936
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005937#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 case MBEDTLS_MD_SHA384:
5939 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005940#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005941
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005942#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 case MBEDTLS_MD_SHA256:
5944 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005945#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005946
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005948#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5949 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 (void) ssl;
5951 (void) dst;
5952 (void) dst_len;
5953 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005954#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005956 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005958}
XiaokangQian647719a2021-12-07 09:16:29 +00005959
Jerry Yu148165c2021-09-24 23:20:59 +08005960#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005961
Ronald Crone68ab4f2022-10-05 12:46:29 +02005962#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005963/* mbedtls_ssl_parse_sig_alg_ext()
5964 *
5965 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5966 * value (TLS 1.3 RFC8446):
5967 * enum {
5968 * ....
5969 * ecdsa_secp256r1_sha256( 0x0403 ),
5970 * ecdsa_secp384r1_sha384( 0x0503 ),
5971 * ecdsa_secp521r1_sha512( 0x0603 ),
5972 * ....
5973 * } SignatureScheme;
5974 *
5975 * struct {
5976 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5977 * } SignatureSchemeList;
5978 *
5979 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5980 * value (TLS 1.2 RFC5246):
5981 * enum {
5982 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5983 * sha512(6), (255)
5984 * } HashAlgorithm;
5985 *
5986 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5987 * SignatureAlgorithm;
5988 *
5989 * struct {
5990 * HashAlgorithm hash;
5991 * SignatureAlgorithm signature;
5992 * } SignatureAndHashAlgorithm;
5993 *
5994 * SignatureAndHashAlgorithm
5995 * supported_signature_algorithms<2..2^16-2>;
5996 *
5997 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5998 * generalization of the TLS 1.2 signature algorithm extension.
5999 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6000 * `SignatureScheme` field of TLS 1.3
6001 *
6002 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006003int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6004 const unsigned char *buf,
6005 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006006{
6007 const unsigned char *p = buf;
6008 size_t supported_sig_algs_len = 0;
6009 const unsigned char *supported_sig_algs_end;
6010 uint16_t sig_alg;
6011 uint32_t common_idx = 0;
6012
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6014 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006015 p += 2;
6016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 memset(ssl->handshake->received_sig_algs, 0,
6018 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006021 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 while (p < supported_sig_algs_end) {
6023 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6024 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006025 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6027 sig_alg,
6028 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6031 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6032 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006033 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006034 }
6035#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6038 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006041 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6042 common_idx += 1;
6043 }
6044 }
6045 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 if (p != end) {
6047 MBEDTLS_SSL_DEBUG_MSG(1,
6048 ("Signature algorithms extension length misaligned"));
6049 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6050 MBEDTLS_ERR_SSL_DECODE_ERROR);
6051 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006052 }
6053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (common_idx == 0) {
6055 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6056 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6057 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6058 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006059 }
6060
Gabor Mezei15b95a62022-05-09 16:37:58 +02006061 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006063}
6064
Ronald Crone68ab4f2022-10-05 12:46:29 +02006065#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006066
Jerry Yudc7bd172022-02-17 13:44:15 +08006067#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6068
6069#if defined(MBEDTLS_USE_PSA_CRYPTO)
6070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6072 mbedtls_svc_key_id_t key,
6073 psa_algorithm_t alg,
6074 const unsigned char *raw_psk, size_t raw_psk_length,
6075 const unsigned char *seed, size_t seed_length,
6076 const unsigned char *label, size_t label_length,
6077 const unsigned char *other_secret,
6078 size_t other_secret_length,
6079 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006080{
6081 psa_status_t status;
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 status = psa_key_derivation_setup(derivation, alg);
6084 if (status != PSA_SUCCESS) {
6085 return status;
6086 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6089 status = psa_key_derivation_input_bytes(derivation,
6090 PSA_KEY_DERIVATION_INPUT_SEED,
6091 seed, seed_length);
6092 if (status != PSA_SUCCESS) {
6093 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006094 }
6095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (other_secret != NULL) {
6097 status = psa_key_derivation_input_bytes(derivation,
6098 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6099 other_secret, other_secret_length);
6100 if (status != PSA_SUCCESS) {
6101 return status;
6102 }
6103 }
6104
6105 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006106 status = psa_key_derivation_input_bytes(
6107 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 raw_psk, raw_psk_length);
6109 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006110 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006112 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (status != PSA_SUCCESS) {
6114 return status;
6115 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 status = psa_key_derivation_input_bytes(derivation,
6118 PSA_KEY_DERIVATION_INPUT_LABEL,
6119 label, label_length);
6120 if (status != PSA_SUCCESS) {
6121 return status;
6122 }
6123 } else {
6124 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006125 }
6126
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 status = psa_key_derivation_set_capacity(derivation, capacity);
6128 if (status != PSA_SUCCESS) {
6129 return status;
6130 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006133}
6134
Andrzej Kurek57d10632022-10-24 10:32:01 -04006135#if defined(PSA_WANT_ALG_SHA_384) || \
6136 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006138static int tls_prf_generic(mbedtls_md_type_t md_type,
6139 const unsigned char *secret, size_t slen,
6140 const char *label,
6141 const unsigned char *random, size_t rlen,
6142 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006143{
6144 psa_status_t status;
6145 psa_algorithm_t alg;
6146 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6147 psa_key_derivation_operation_t derivation =
6148 PSA_KEY_DERIVATION_OPERATION_INIT;
6149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006151 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006153 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006155
6156 /* Normally a "secret" should be long enough to be impossible to
6157 * find by brute force, and in particular should not be empty. But
6158 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6159 * and for this use case it makes sense to have a 0-length "secret".
6160 * Since the key API doesn't allow importing a key of length 0,
6161 * keep master_key=0, which setup_psa_key_derivation() understands
6162 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006164 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6166 psa_set_key_algorithm(&key_attributes, alg);
6167 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006168
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6170 if (status != PSA_SUCCESS) {
6171 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6172 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006173 }
6174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 status = setup_psa_key_derivation(&derivation,
6176 master_key, alg,
6177 NULL, 0,
6178 random, rlen,
6179 (unsigned char const *) label,
6180 (size_t) strlen(label),
6181 NULL, 0,
6182 dlen);
6183 if (status != PSA_SUCCESS) {
6184 psa_key_derivation_abort(&derivation);
6185 psa_destroy_key(master_key);
6186 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006187 }
6188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6190 if (status != PSA_SUCCESS) {
6191 psa_key_derivation_abort(&derivation);
6192 psa_destroy_key(master_key);
6193 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006194 }
6195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 status = psa_key_derivation_abort(&derivation);
6197 if (status != PSA_SUCCESS) {
6198 psa_destroy_key(master_key);
6199 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006200 }
6201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (!mbedtls_svc_key_id_is_null(master_key)) {
6203 status = psa_destroy_key(master_key);
6204 }
6205 if (status != PSA_SUCCESS) {
6206 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006210}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006211#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006212#else /* MBEDTLS_USE_PSA_CRYPTO */
6213
Andrzej Kurek57d10632022-10-24 10:32:01 -04006214#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006215 (defined(MBEDTLS_MD_CAN_SHA256) || \
6216 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006218static int tls_prf_generic(mbedtls_md_type_t md_type,
6219 const unsigned char *secret, size_t slen,
6220 const char *label,
6221 const unsigned char *random, size_t rlen,
6222 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006223{
6224 size_t nb;
6225 size_t i, j, k, md_len;
6226 unsigned char *tmp;
6227 size_t tmp_len = 0;
6228 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6229 const mbedtls_md_info_t *md_info;
6230 mbedtls_md_context_t md_ctx;
6231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6232
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6236 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6237 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006238
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 tmp_len = md_len + strlen(label) + rlen;
6242 tmp = mbedtls_calloc(1, tmp_len);
6243 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006244 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6245 goto exit;
6246 }
6247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 nb = strlen(label);
6249 memcpy(tmp + md_len, label, nb);
6250 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006251 nb += rlen;
6252
6253 /*
6254 * Compute P_<hash>(secret, label + random)[0..dlen]
6255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6261 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006262 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 }
6264 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6265 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 }
6268 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6269 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 for (i = 0; i < dlen; i += md_len) {
6274 ret = mbedtls_md_hmac_reset(&md_ctx);
6275 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006276 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 }
6278 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6279 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006280 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 }
6282 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6283 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006284 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 ret = mbedtls_md_hmac_reset(&md_ctx);
6288 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006289 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 }
6291 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6292 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006293 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 }
6295 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6296 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006297 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006303 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006304 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006305 }
6306
6307exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006309
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (tmp != NULL) {
6311 mbedtls_platform_zeroize(tmp, tmp_len);
6312 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006317
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006319}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006320#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006321#endif /* MBEDTLS_USE_PSA_CRYPTO */
6322
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006323#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006325static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6326 const char *label,
6327 const unsigned char *random, size_t rlen,
6328 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006329{
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6331 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006332}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006333#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006334
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006335#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006337static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6338 const char *label,
6339 const unsigned char *random, size_t rlen,
6340 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006341{
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6343 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006344}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006345#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006346
Jerry Yuf009d862022-02-17 14:01:37 +08006347/*
6348 * Set appropriate PRF function and other SSL / TLS1.2 functions
6349 *
6350 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006351 * - hash associated with the ciphersuite (only used by TLS 1.2)
6352 *
6353 * Outputs:
6354 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6355 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006356MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006357static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6358 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006359{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006360#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006361 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006362 handshake->tls_prf = tls_prf_sha384;
6363 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6364 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006366#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006367#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006368 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006369 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006370 handshake->tls_prf = tls_prf_sha256;
6371 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6372 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6373 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006374#else
Jerry Yuf009d862022-02-17 14:01:37 +08006375 {
Jerry Yuf009d862022-02-17 14:01:37 +08006376 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006377 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006379 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006380#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006383}
Jerry Yud6ab2352022-02-17 14:03:43 +08006384
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385/*
6386 * Compute master secret if needed
6387 *
6388 * Parameters:
6389 * [in/out] handshake
6390 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6391 * (PSA-PSK) ciphersuite_info, psk_opaque
6392 * [out] premaster (cleared)
6393 * [out] master
6394 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6395 * debug: conf->f_dbg, conf->p_dbg
6396 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006397 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006400static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6401 unsigned char *master,
6402 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403{
6404 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6405
6406 /* cf. RFC 5246, Section 8.1:
6407 * "The master secret is always exactly 48 bytes in length." */
6408 size_t const master_secret_len = 48;
6409
6410#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6411 unsigned char session_hash[48];
6412#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6413
6414 /* The label for the KDF used for key expansion.
6415 * This is either "master secret" or "extended master secret"
6416 * depending on whether the Extended Master Secret extension
6417 * is used. */
6418 char const *lbl = "master secret";
6419
Przemek Stekielae4ed302022-04-05 17:15:55 +02006420 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421 * - If the Extended Master Secret extension is not used,
6422 * this is ClientHello.Random + ServerHello.Random
6423 * (see Sect. 8.1 in RFC 5246).
6424 * - If the Extended Master Secret extension is used,
6425 * this is the transcript of the handshake so far.
6426 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006427 unsigned char const *seed = handshake->randbytes;
6428 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429
6430#if !defined(MBEDTLS_DEBUG_C) && \
6431 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6432 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006434 ssl = NULL; /* make sure we don't use it except for those cases */
6435 (void) ssl;
6436#endif
6437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (handshake->resume != 0) {
6439 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6440 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006441 }
6442
6443#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006445 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006446 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006447 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6448 if (ret != 0) {
6449 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6450 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6453 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006455#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006456
Przemek Stekiel99114f32022-04-22 11:20:09 +02006457#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006458 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006460 /* Perform PSK-to-MS expansion in a single step. */
6461 psa_status_t status;
6462 psa_algorithm_t alg;
6463 mbedtls_svc_key_id_t psk;
6464 psa_key_derivation_operation_t derivation =
6465 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006466 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006475 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006477
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006478 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006482 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006483 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006484 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006485 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006486 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006487 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006488 other_secret_len = 48;
6489 other_secret = handshake->premaster + 2;
6490 break;
6491 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006492 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006493 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6494 other_secret = handshake->premaster + 2;
6495 break;
6496 default:
6497 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = setup_psa_key_derivation(&derivation, psk, alg,
6501 ssl->conf->psk, ssl->conf->psk_len,
6502 seed, seed_len,
6503 (unsigned char const *) lbl,
6504 (size_t) strlen(lbl),
6505 other_secret, other_secret_len,
6506 master_secret_len);
6507 if (status != PSA_SUCCESS) {
6508 psa_key_derivation_abort(&derivation);
6509 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006510 }
6511
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 status = psa_key_derivation_output_bytes(&derivation,
6513 master,
6514 master_secret_len);
6515 if (status != PSA_SUCCESS) {
6516 psa_key_derivation_abort(&derivation);
6517 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006518 }
6519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 status = psa_key_derivation_abort(&derivation);
6521 if (status != PSA_SUCCESS) {
6522 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6523 }
6524 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525#endif
6526 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006527#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6529 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006530 psa_status_t status;
6531 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6532 psa_key_derivation_operation_t derivation =
6533 PSA_KEY_DERIVATION_OPERATION_INIT;
6534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006536
6537 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 status = psa_key_derivation_setup(&derivation, alg);
6540 if (status != PSA_SUCCESS) {
6541 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006542 }
6543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 status = psa_key_derivation_set_capacity(&derivation,
6545 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6546 if (status != PSA_SUCCESS) {
6547 psa_key_derivation_abort(&derivation);
6548 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006549 }
6550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6552 &derivation);
6553 if (status != PSA_SUCCESS) {
6554 psa_key_derivation_abort(&derivation);
6555 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006556 }
6557
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 status = psa_key_derivation_output_bytes(&derivation,
6559 handshake->premaster,
6560 handshake->pmslen);
6561 if (status != PSA_SUCCESS) {
6562 psa_key_derivation_abort(&derivation);
6563 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6564 }
6565
6566 status = psa_key_derivation_abort(&derivation);
6567 if (status != PSA_SUCCESS) {
6568 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006569 }
6570 }
6571#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6573 lbl, seed, seed_len,
6574 master,
6575 master_secret_len);
6576 if (ret != 0) {
6577 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6578 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006579 }
6580
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6582 handshake->premaster,
6583 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006584
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 mbedtls_platform_zeroize(handshake->premaster,
6586 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006587 }
6588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006590}
6591
Gilles Peskine449bd832023-01-11 14:50:10 +01006592int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006593{
6594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6595 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6596 ssl->handshake->ciphersuite_info;
6597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006599
6600 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006602 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 if (ret != 0) {
6604 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6605 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006606 }
6607
6608 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 ret = ssl_compute_master(ssl->handshake,
6610 ssl->session_negotiate->master,
6611 ssl);
6612 if (ret != 0) {
6613 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6614 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006615 }
6616
6617 /* Swap the client and server random values:
6618 * - MS derivation wanted client+server (RFC 5246 8.1)
6619 * - key derivation wants server+client (RFC 5246 6.3) */
6620 {
6621 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 memcpy(tmp, ssl->handshake->randbytes, 64);
6623 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6624 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6625 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006626 }
6627
6628 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6630 ssl->session_negotiate->ciphersuite,
6631 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006632#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006634#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 ssl->handshake->tls_prf,
6636 ssl->handshake->randbytes,
6637 ssl->tls_version,
6638 ssl->conf->endpoint,
6639 ssl);
6640 if (ret != 0) {
6641 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6642 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006643 }
6644
6645 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6647 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006648
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006650
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006652}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006653
Gilles Peskine449bd832023-01-11 14:50:10 +01006654int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006655{
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006657#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006658 case MBEDTLS_SSL_HASH_SHA384:
6659 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6660 break;
6661#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006662#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006663 case MBEDTLS_SSL_HASH_SHA256:
6664 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6665 break;
6666#endif
6667 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006669 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006670#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6671 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006672 (void) ssl;
6673#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006675}
6676
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006677#if defined(MBEDTLS_USE_PSA_CRYPTO)
6678static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6679 const psa_hash_operation_t *hs_op,
6680 size_t buffer_size,
6681 unsigned char *hash,
6682 size_t *hlen)
6683{
6684 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006685 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006686
6687#if !defined(MBEDTLS_DEBUG_C)
6688 (void) ssl;
6689#endif
6690 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006691 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006692 if (status != PSA_SUCCESS) {
6693 goto exit;
6694 }
6695
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006696 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006697 if (status != PSA_SUCCESS) {
6698 goto exit;
6699 }
6700
6701 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6702 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6703
6704exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006705 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006706 return mbedtls_md_error_from_psa(status);
6707}
6708#else
6709static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6710 const mbedtls_md_context_t *hs_ctx,
6711 unsigned char *hash,
6712 size_t *hlen)
6713{
6714 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006715 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006716
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006717 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006718
6719#if !defined(MBEDTLS_DEBUG_C)
6720 (void) ssl;
6721#endif
6722 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6723
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006724 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006725 if (ret != 0) {
6726 goto exit;
6727 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006728 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006729 if (ret != 0) {
6730 goto exit;
6731 }
6732
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006733 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006734 if (ret != 0) {
6735 goto exit;
6736 }
6737
6738 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6739
6740 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6741 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6742
6743exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006744 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006745 return ret;
6746}
6747#endif /* MBEDTLS_USE_PSA_CRYPTO */
6748
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006749#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006750int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6751 unsigned char *hash,
6752 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006753{
6754#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006755 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6756 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006757#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6759 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006760#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006761}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006762#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006763
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006764#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006765int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6766 unsigned char *hash,
6767 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006768{
6769#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006770 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6771 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006772#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006773 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6774 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006775#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006776}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006777#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006778
Neil Armstrong80f6f322022-05-03 17:56:38 +02006779#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6780 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006781int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006782{
6783 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006785 const unsigned char *psk = NULL;
6786 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006790 /*
6791 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006792 * checked before calling this function.
6793 *
6794 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006795 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6799 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006800 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006801 }
6802
6803 /*
6804 * PMS = struct {
6805 * opaque other_secret<0..2^16-1>;
6806 * opaque psk<0..2^16-1>;
6807 * };
6808 * with "other_secret" depending on the particular key exchange
6809 */
6810#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6812 if (end - p < 2) {
6813 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6814 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006817 p += 2;
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 if (end < p || (size_t) (end - p) < psk_len) {
6820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6821 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006824 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006826#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6827#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 /*
6830 * other_secret already set by the ClientKeyExchange message,
6831 * and is 48 bytes long
6832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 if (end - p < 2) {
6834 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6835 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006836
6837 *p++ = 0;
6838 *p++ = 48;
6839 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006841#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6842#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6845 size_t len;
6846
6847 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006848 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006849 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6851 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6852 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006853 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006855 p += 2 + len;
6856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6858 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006859#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006860#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6863 size_t zlen;
6864
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006866 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6868 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6869 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006870 }
6871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006873 p += 2 + zlen;
6874
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6876 MBEDTLS_DEBUG_ECDH_Z);
6877 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006878#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006879 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6881 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006882 }
6883
6884 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 if (end - p < 2) {
6886 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6887 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006890 p += 2;
6891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 if (end < p || (size_t) (end - p) < psk_len) {
6893 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6894 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006897 p += psk_len;
6898
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006899 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006902}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006903#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006904
6905#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006906MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006907static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006908
6909#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006910int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006911{
6912 /* If renegotiation is not enforced, retransmit until we would reach max
6913 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006915 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6916 unsigned char doublings = 1;
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006919 ++doublings;
6920 ratio >>= 1;
6921 }
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 if (++ssl->renego_records_seen > doublings) {
6924 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6925 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006926 }
6927 }
6928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006930}
6931#endif
6932#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006933
Jerry Yud9526692022-02-17 14:23:47 +08006934/*
6935 * Handshake functions
6936 */
6937#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6938/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006939int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006940{
6941 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6942 ssl->handshake->ciphersuite_info;
6943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006945
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6947 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006948 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006950 }
6951
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6953 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006954}
6955
Gilles Peskine449bd832023-01-11 14:50:10 +01006956int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006957{
6958 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6959 ssl->handshake->ciphersuite_info;
6960
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006962
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6964 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006965 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006967 }
6968
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6970 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006971}
6972
6973#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6974/* Some certificate support -> implement write and parse */
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006977{
6978 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6979 size_t i, n;
6980 const mbedtls_x509_crt *crt;
6981 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6982 ssl->handshake->ciphersuite_info;
6983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006985
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6987 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006988 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006990 }
6991
6992#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6994 if (ssl->handshake->client_auth == 0) {
6995 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006996 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006998 }
6999 }
7000#endif /* MBEDTLS_SSL_CLI_C */
7001#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007002 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7003 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007004 /* Should never happen because we shouldn't have picked the
7005 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007007 }
7008 }
7009#endif
7010
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007012
7013 /*
7014 * 0 . 0 handshake type
7015 * 1 . 3 handshake length
7016 * 4 . 6 length of all certs
7017 * 7 . 9 length of cert. 1
7018 * 10 . n-1 peer certificate
7019 * n . n+2 length of cert. 2
7020 * n+3 . ... upper level cert, etc.
7021 */
7022 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007024
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007026 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7028 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7029 " > %" MBEDTLS_PRINTF_SIZET,
7030 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7031 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007032 }
7033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7035 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7036 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007039 i += n; crt = crt->next;
7040 }
7041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7043 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7044 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007045
7046 ssl->out_msglen = i;
7047 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7048 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7049
7050 ssl->state++;
7051
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7053 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7054 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007055 }
7056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007058
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007060}
7061
7062#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7063
7064#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007065MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007066static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7067 unsigned char *crt_buf,
7068 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007069{
7070 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 if (peer_crt == NULL) {
7073 return -1;
7074 }
Jerry Yud9526692022-02-17 14:23:47 +08007075
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 if (peer_crt->raw.len != crt_buf_len) {
7077 return -1;
7078 }
Jerry Yud9526692022-02-17 14:23:47 +08007079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007081}
7082#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007083MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007084static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7085 unsigned char *crt_buf,
7086 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007087{
7088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7089 unsigned char const * const peer_cert_digest =
7090 ssl->session->peer_cert_digest;
7091 mbedtls_md_type_t const peer_cert_digest_type =
7092 ssl->session->peer_cert_digest_type;
7093 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007095 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7096 size_t digest_len;
7097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 if (peer_cert_digest == NULL || digest_info == NULL) {
7099 return -1;
7100 }
Jerry Yud9526692022-02-17 14:23:47 +08007101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 digest_len = mbedtls_md_get_size(digest_info);
7103 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7104 return -1;
7105 }
Jerry Yud9526692022-02-17 14:23:47 +08007106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7108 if (ret != 0) {
7109 return -1;
7110 }
Jerry Yud9526692022-02-17 14:23:47 +08007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007113}
7114#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7115#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7116
7117/*
7118 * Once the certificate message is read, parse it into a cert chain and
7119 * perform basic checks, but leave actual verification to the caller
7120 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007121MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007122static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7123 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007124{
7125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7126#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007128#endif
7129 size_t i, n;
7130 uint8_t alert;
7131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7133 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7134 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7135 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7136 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007137 }
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7140 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7141 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7142 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007143 }
7144
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7146 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7147 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7148 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7149 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007150 }
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007153
7154 /*
7155 * Same message structure as in mbedtls_ssl_write_certificate()
7156 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007157 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 if (ssl->in_msg[i] != 0 ||
7160 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7161 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7162 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7163 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7164 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007165 }
7166
7167 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7168 i += 3;
7169
7170 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007172 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 if (i + 3 > ssl->in_hslen) {
7174 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7175 mbedtls_ssl_send_alert_message(ssl,
7176 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7177 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7178 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007179 }
7180 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7181 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 if (ssl->in_msg[i] != 0) {
7183 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7184 mbedtls_ssl_send_alert_message(ssl,
7185 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7186 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7187 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007188 }
7189
7190 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007191 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007192 i += 3;
7193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 if (n < 128 || i + n > ssl->in_hslen) {
7195 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7196 mbedtls_ssl_send_alert_message(ssl,
7197 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7198 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7199 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007200 }
7201
7202 /* Check if we're handling the first CRT in the chain. */
7203#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007205 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007207 /* During client-side renegotiation, check that the server's
7208 * end-CRTs hasn't changed compared to the initial handshake,
7209 * mitigating the triple handshake attack. On success, reuse
7210 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7212 if (ssl_check_peer_crt_unchanged(ssl,
7213 &ssl->in_msg[i],
7214 n) != 0) {
7215 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7216 mbedtls_ssl_send_alert_message(ssl,
7217 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7218 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7219 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007220 }
7221
7222 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007224 }
7225#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7226
7227 /* Parse the next certificate in the chain. */
7228#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007230#else
7231 /* If we don't need to store the CRT chain permanently, parse
7232 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007234#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007236 case 0: /*ok*/
7237 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7238 /* Ignore certificate with an unknown algorithm: maybe a
7239 prior certificate was already trusted. */
7240 break;
7241
7242 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7243 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7244 goto crt_parse_der_failed;
7245
7246 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7247 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7248 goto crt_parse_der_failed;
7249
7250 default:
7251 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007252crt_parse_der_failed:
7253 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7254 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7255 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007256 }
7257
7258 i += n;
7259 }
7260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7262 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007263}
7264
7265#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007266MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007267static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007268{
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7270 return -1;
7271 }
Jerry Yud9526692022-02-17 14:23:47 +08007272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007274 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7275 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7277 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7278 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007279 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007281}
7282#endif /* MBEDTLS_SSL_SRV_C */
7283
7284/* Check if a certificate message is expected.
7285 * Return either
7286 * - SSL_CERTIFICATE_EXPECTED, or
7287 * - SSL_CERTIFICATE_SKIP
7288 * indicating whether a Certificate message is expected or not.
7289 */
7290#define SSL_CERTIFICATE_EXPECTED 0
7291#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007293static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7294 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007295{
7296 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7297 ssl->handshake->ciphersuite_info;
7298
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7300 return SSL_CERTIFICATE_SKIP;
7301 }
Jerry Yud9526692022-02-17 14:23:47 +08007302
7303#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7305 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7306 return SSL_CERTIFICATE_SKIP;
7307 }
Jerry Yud9526692022-02-17 14:23:47 +08007308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007310 ssl->session_negotiate->verify_result =
7311 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007313 }
7314 }
7315#else
7316 ((void) authmode);
7317#endif /* MBEDTLS_SSL_SRV_C */
7318
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007320}
7321
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007322MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007323static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7324 int authmode,
7325 mbedtls_x509_crt *chain,
7326 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007327{
7328 int ret = 0;
7329 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7330 ssl->handshake->ciphersuite_info;
7331 int have_ca_chain = 0;
7332
7333 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7334 void *p_vrfy;
7335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7337 return 0;
7338 }
Jerry Yud9526692022-02-17 14:23:47 +08007339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 if (ssl->f_vrfy != NULL) {
7341 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007342 f_vrfy = ssl->f_vrfy;
7343 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 } else {
7345 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007346 f_vrfy = ssl->conf->f_vrfy;
7347 p_vrfy = ssl->conf->p_vrfy;
7348 }
7349
7350 /*
7351 * Main check: verify certificate
7352 */
7353#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007355 ((void) rs_ctx);
7356 have_ca_chain = 1;
7357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007359 ret = mbedtls_x509_crt_verify_with_ca_cb(
7360 chain,
7361 ssl->conf->f_ca_cb,
7362 ssl->conf->p_ca_cb,
7363 ssl->conf->cert_profile,
7364 ssl->hostname,
7365 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 f_vrfy, p_vrfy);
7367 } else
Jerry Yud9526692022-02-17 14:23:47 +08007368#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7369 {
7370 mbedtls_x509_crt *ca_chain;
7371 mbedtls_x509_crl *ca_crl;
7372
7373#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007375 ca_chain = ssl->handshake->sni_ca_chain;
7376 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 } else
Jerry Yud9526692022-02-17 14:23:47 +08007378#endif
7379 {
7380 ca_chain = ssl->conf->ca_chain;
7381 ca_crl = ssl->conf->ca_crl;
7382 }
7383
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007385 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 }
Jerry Yud9526692022-02-17 14:23:47 +08007387
7388 ret = mbedtls_x509_crt_verify_restartable(
7389 chain,
7390 ca_chain, ca_crl,
7391 ssl->conf->cert_profile,
7392 ssl->hostname,
7393 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007395 }
7396
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (ret != 0) {
7398 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007399 }
7400
7401#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7403 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7404 }
Jerry Yud9526692022-02-17 14:23:47 +08007405#endif
7406
7407 /*
7408 * Secondary checks: always done, but change 'ret' only if it was 0
7409 */
7410
Valerio Settiacd32c02023-06-29 18:06:29 +02007411#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007412 {
7413 const mbedtls_pk_context *pk = &chain->pk;
7414
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007415 /* If certificate uses an EC key, make sure the curve is OK.
7416 * This is a public key, so it can't be opaque, so can_do() is a good
7417 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007419 /* and in the unlikely case the above assumption no longer holds
7420 * we are making sure that pk_ec() here does not return a NULL
7421 */
Valerio Settif9362b72023-11-29 08:42:27 +01007422 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007423 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7424 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007426 }
Valerio Setti97207782023-05-18 18:59:06 +02007427 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007428 ssl->session_negotiate->verify_result |=
7429 MBEDTLS_X509_BADCERT_BAD_KEY;
7430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7432 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007433 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007435 }
Jerry Yud9526692022-02-17 14:23:47 +08007436 }
7437 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007438#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007439
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if (mbedtls_ssl_check_cert_usage(chain,
7441 ciphersuite_info,
7442 !ssl->conf->endpoint,
7443 &ssl->session_negotiate->verify_result) != 0) {
7444 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7445 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007446 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 }
Jerry Yud9526692022-02-17 14:23:47 +08007448 }
7449
7450 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7451 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7452 * with details encoded in the verification flags. All other kinds
7453 * of error codes, including those from the user provided f_vrfy
7454 * functions, are treated as fatal and lead to a failure of
7455 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7457 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7458 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007459 ret = 0;
7460 }
7461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7463 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007464 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7465 }
7466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007468 uint8_t alert;
7469
7470 /* The certificate may have been rejected for several reasons.
7471 Pick one and send the corresponding alert. Which alert to send
7472 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007474 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007476 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007478 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007480 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007482 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007484 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007486 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007488 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007490 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007492 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007494 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 }
7496 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7497 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007498 }
7499
7500#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (ssl->session_negotiate->verify_result != 0) {
7502 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7503 (unsigned int) ssl->session_negotiate->verify_result));
7504 } else {
7505 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007506 }
7507#endif /* MBEDTLS_DEBUG_C */
7508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007510}
7511
7512#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007514static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7515 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007516{
7517 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7518 /* Remember digest of the peer's end-CRT. */
7519 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7521 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7522 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7523 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7524 mbedtls_ssl_send_alert_message(ssl,
7525 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7526 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007529 }
7530
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 ret = mbedtls_md(mbedtls_md_info_from_type(
7532 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7533 start, len,
7534 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007535
7536 ssl->session_negotiate->peer_cert_digest_type =
7537 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7538 ssl->session_negotiate->peer_cert_digest_len =
7539 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007542}
7543
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007544MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007545static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7546 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007547{
7548 unsigned char *end = start + len;
7549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7550
7551 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7553 ret = mbedtls_pk_parse_subpubkey(&start, end,
7554 &ssl->handshake->peer_pubkey);
7555 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007556 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007558 }
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007561}
7562#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007565{
7566 int ret = 0;
7567 int crt_expected;
7568#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7569 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7570 ? ssl->handshake->sni_authmode
7571 : ssl->conf->authmode;
7572#else
7573 const int authmode = ssl->conf->authmode;
7574#endif
7575 void *rs_ctx = NULL;
7576 mbedtls_x509_crt *chain = NULL;
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7581 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7582 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007583 goto exit;
7584 }
7585
7586#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->handshake->ecrs_enabled &&
7588 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007589 chain = ssl->handshake->ecrs_peer_cert;
7590 ssl->handshake->ecrs_peer_cert = NULL;
7591 goto crt_verify;
7592 }
7593#endif
7594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007596 /* mbedtls_ssl_read_record may have sent an alert already. We
7597 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007599 goto exit;
7600 }
7601
7602#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007604 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7605
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007607 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 }
Jerry Yud9526692022-02-17 14:23:47 +08007609
7610 goto exit;
7611 }
7612#endif /* MBEDTLS_SSL_SRV_C */
7613
7614 /* Clear existing peer CRT structure in case we tried to
7615 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7619 if (chain == NULL) {
7620 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7621 sizeof(mbedtls_x509_crt)));
7622 mbedtls_ssl_send_alert_message(ssl,
7623 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7624 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007625
7626 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7627 goto exit;
7628 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 ret = ssl_parse_certificate_chain(ssl, chain);
7632 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007633 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 }
Jerry Yud9526692022-02-17 14:23:47 +08007635
7636#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007638 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 }
Jerry Yud9526692022-02-17 14:23:47 +08007640
7641crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007643 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 }
Jerry Yud9526692022-02-17 14:23:47 +08007645#endif
7646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 ret = ssl_parse_certificate_verify(ssl, authmode,
7648 chain, rs_ctx);
7649 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007650 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 }
Jerry Yud9526692022-02-17 14:23:47 +08007652
7653#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7654 {
7655 unsigned char *crt_start, *pk_start;
7656 size_t crt_len, pk_len;
7657
7658 /* We parse the CRT chain without copying, so
7659 * these pointers point into the input buffer,
7660 * and are hence still valid after freeing the
7661 * CRT chain. */
7662
7663 crt_start = chain->raw.p;
7664 crt_len = chain->raw.len;
7665
7666 pk_start = chain->pk_raw.p;
7667 pk_len = chain->pk_raw.len;
7668
7669 /* Free the CRT structures before computing
7670 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 mbedtls_x509_crt_free(chain);
7672 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007673 chain = NULL;
7674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7676 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007677 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 }
Jerry Yud9526692022-02-17 14:23:47 +08007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7681 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007682 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 }
Jerry Yud9526692022-02-17 14:23:47 +08007684 }
7685#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7686 /* Pass ownership to session structure. */
7687 ssl->session_negotiate->peer_cert = chain;
7688 chain = NULL;
7689#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007692
7693exit:
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007696 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
7699#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007700 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007701 ssl->handshake->ecrs_peer_cert = chain;
7702 chain = NULL;
7703 }
7704#endif
7705
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (chain != NULL) {
7707 mbedtls_x509_crt_free(chain);
7708 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007709 }
7710
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007712}
7713#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7714
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007715static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7716 unsigned char *padbuf, size_t hlen,
7717 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007718{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007719 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007720 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007721#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007722 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007723 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007724 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007725 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007726#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007727 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007728 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007729 mbedtls_md_context_t cloned_ctx;
7730 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007731#endif
7732
7733 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007735 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007737
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007739 ? "client finished"
7740 : "server finished";
7741
7742#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007743 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007744
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007745 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007747 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007748 }
7749
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007750 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007752 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007753 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007754 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007755#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007756 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007757
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007758 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007759 if (ret != 0) {
7760 goto exit;
7761 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007762 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007763 if (ret != 0) {
7764 goto exit;
7765 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007766
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007767 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007768 if (ret != 0) {
7769 goto exit;
7770 }
7771#endif /* MBEDTLS_USE_PSA_CRYPTO */
7772
7773 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7774
Jerry Yu615bd6f2022-02-17 14:25:15 +08007775 /*
7776 * TLSv1.2:
7777 * hash = PRF( master, finished_label,
7778 * Hash( handshake ) )[0.11]
7779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007781 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007784
Paul Elliottecb95be2023-08-11 16:41:04 +01007785 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007786
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007787 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007788
7789exit:
7790#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007791 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007792 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007793#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007794 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007795 return ret;
7796#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007797}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007798
7799#if defined(MBEDTLS_MD_CAN_SHA256)
7800static int ssl_calc_finished_tls_sha256(
7801 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7802{
7803 unsigned char padbuf[32];
7804 return ssl_calc_finished_tls_generic(ssl,
7805#if defined(MBEDTLS_USE_PSA_CRYPTO)
7806 &ssl->handshake->fin_sha256_psa,
7807#else
7808 &ssl->handshake->fin_sha256,
7809#endif
7810 padbuf, sizeof(padbuf),
7811 buf, from);
7812}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007813#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007814
Jerry Yub7ba49e2022-02-17 14:25:53 +08007815
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007816#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007817static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007819{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007820 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007821 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007823 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007824#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007825 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007826#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007827 padbuf, sizeof(padbuf),
7828 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007829}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007830#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007831
Gilles Peskine449bd832023-01-11 14:50:10 +01007832void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007833{
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007835
7836 /*
7837 * Free our handshake params
7838 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 mbedtls_ssl_handshake_free(ssl);
7840 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007841 ssl->handshake = NULL;
7842
7843 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007844 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 if (ssl->transform) {
7847 mbedtls_ssl_transform_free(ssl->transform);
7848 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007849 }
7850 ssl->transform = ssl->transform_negotiate;
7851 ssl->transform_negotiate = NULL;
7852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007854}
7855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007857{
7858 int resume = ssl->handshake->resume;
7859
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007861
7862#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007864 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7865 ssl->renego_records_seen = 0;
7866 }
7867#endif
7868
7869 /*
7870 * Free the previous session and switch in the current one
7871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007873#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7874 /* RFC 7366 3.1: keep the EtM state */
7875 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007877#endif
7878
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 mbedtls_ssl_session_free(ssl->session);
7880 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007881 }
7882 ssl->session = ssl->session_negotiate;
7883 ssl->session_negotiate = NULL;
7884
7885 /*
7886 * Add cache entry
7887 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007889 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 resume == 0) {
7891 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7892 ssl->session->id,
7893 ssl->session->id_len,
7894 ssl->session) != 0) {
7895 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7896 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007897 }
7898
7899#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7901 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007902 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007904
7905 /* Keep last flight around in case we need to resend it:
7906 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7908 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007909#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007911
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007912 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007913
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007915}
7916
Gilles Peskine449bd832023-01-11 14:50:10 +01007917int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007918{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007919 int ret;
7920 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007925
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007926 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7927 if (ret != 0) {
7928 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7929 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007930
7931 /*
7932 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7933 * may define some other value. Currently (early 2016), no defined
7934 * ciphersuite does this (and this is unlikely to change as activity has
7935 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7936 */
7937 hash_len = 12;
7938
7939#if defined(MBEDTLS_SSL_RENEGOTIATION)
7940 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007942#endif
7943
7944 ssl->out_msglen = 4 + hash_len;
7945 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7946 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7947
7948 /*
7949 * In case of session resuming, invert the client and server
7950 * ChangeCipherSpec messages order.
7951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007955 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007957#endif
7958#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007960 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007962#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007964 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007966
7967 /*
7968 * Switch to our negotiated transform and session parameters for outbound
7969 * data.
7970 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007972
7973#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975 unsigned char i;
7976
7977 /* Remember current epoch settings for resending */
7978 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7980 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007981
7982 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007984
7985
7986 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 for (i = 2; i > 0; i--) {
7988 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007989 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 }
7991 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007992
7993 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (i == 0) {
7995 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7996 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007997 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007999#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008001
8002 ssl->transform_out = ssl->transform_negotiate;
8003 ssl->session_out = ssl->session_negotiate;
8004
8005#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8007 mbedtls_ssl_send_flight_completed(ssl);
8008 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009#endif
8010
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8012 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8013 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008014 }
8015
8016#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8018 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8019 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8020 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008021 }
8022#endif
8023
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008025
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027}
8028
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008029#define SSL_MAX_HASH_LEN 12
8030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008032{
8033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8034 unsigned int hash_len = 12;
8035 unsigned char buf[SSL_MAX_HASH_LEN];
8036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008038
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008039 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8040 if (ret != 0) {
8041 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8042 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008043
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8045 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008046 goto exit;
8047 }
8048
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8050 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8051 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8052 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008053 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8054 goto exit;
8055 }
8056
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8058 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8059 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008060 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8061 goto exit;
8062 }
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8065 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8066 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8067 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008068 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8069 goto exit;
8070 }
8071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8073 buf, hash_len) != 0) {
8074 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8075 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8076 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008077 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8078 goto exit;
8079 }
8080
8081#if defined(MBEDTLS_SSL_RENEGOTIATION)
8082 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008084#endif
8085
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008087#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008089 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008091#endif
8092#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008094 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008096#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008098 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008100
8101#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8103 mbedtls_ssl_recv_flight_completed(ssl);
8104 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008105#endif
8106
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008108
8109exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 mbedtls_platform_zeroize(buf, hash_len);
8111 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008112}
8113
Jerry Yu392112c2022-02-17 14:34:10 +08008114#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8115/*
8116 * Helper to get TLS 1.2 PRF from ciphersuite
8117 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008119static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008120{
Jerry Yu392112c2022-02-17 14:34:10 +08008121 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008123#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8125 return tls_prf_sha384;
8126 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008127#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008128#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008129 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008130 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8131 return tls_prf_sha256;
8132 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008133 }
8134#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008135#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8136 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008137 (void) ciphersuite_info;
8138#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008139
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008141}
8142#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008143
Gilles Peskine449bd832023-01-11 14:50:10 +01008144static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008145{
8146 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008147#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 if (tls_prf == tls_prf_sha384) {
8149 return MBEDTLS_SSL_TLS_PRF_SHA384;
8150 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008151#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008152#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 if (tls_prf == tls_prf_sha256) {
8154 return MBEDTLS_SSL_TLS_PRF_SHA256;
8155 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008156#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008158}
8159
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008160/*
8161 * Populate a transform structure with session keys and all the other
8162 * necessary information.
8163 *
8164 * Parameters:
8165 * - [in/out]: transform: structure to populate
8166 * [in] must be just initialised with mbedtls_ssl_transform_init()
8167 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8168 * - [in] ciphersuite
8169 * - [in] master
8170 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008171 * - [in] tls_prf: pointer to PRF to use for key derivation
8172 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008173 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008174 * - [in] endpoint: client or server
8175 * - [in] ssl: used for:
8176 * - ssl->conf->{f,p}_export_keys
8177 * [in] optionally used for:
8178 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8179 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008181static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8182 int ciphersuite,
8183 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008184#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008186#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 ssl_tls_prf_t tls_prf,
8188 const unsigned char randbytes[64],
8189 mbedtls_ssl_protocol_version tls_version,
8190 unsigned endpoint,
8191 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192{
8193 int ret = 0;
8194 unsigned char keyblk[256];
8195 unsigned char *key1;
8196 unsigned char *key2;
8197 unsigned char *mac_enc;
8198 unsigned char *mac_dec;
8199 size_t mac_key_len = 0;
8200 size_t iv_copy_len;
8201 size_t keylen;
8202 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008203 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008204#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008205 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008206 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008207#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008208
8209#if defined(MBEDTLS_USE_PSA_CRYPTO)
8210 psa_key_type_t key_type;
8211 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8212 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008213 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008214 size_t key_bits;
8215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8216#endif
8217
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008218 /*
8219 * Some data just needs copying into the structure
8220 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008221#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008222 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008223#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008224 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008225
8226#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008228#endif
8229
8230#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8233 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008235 }
8236#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8237
8238 /*
8239 * Get various info structures
8240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8242 if (ciphersuite_info == NULL) {
8243 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8244 ciphersuite));
8245 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008246 }
8247
Neil Armstrongab555e02022-04-04 11:07:59 +02008248 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008249#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008251#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008255 transform->taglen =
8256 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008258
8259#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008260 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 transform->taglen,
8262 &alg,
8263 &key_type,
8264 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008265 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008267 goto end;
8268 }
8269#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008270 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 if (cipher_info == NULL) {
8272 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8273 ciphersuite_info->cipher));
8274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008275 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008276#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277
Neil Armstronge4512952022-03-08 09:08:22 +01008278#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008279 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008281 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 (unsigned) ciphersuite_info->mac));
8283 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008284 }
8285#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008286 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 if (md_info == NULL) {
8288 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8289 (unsigned) ciphersuite_info->mac));
8290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008291 }
Neil Armstronge4512952022-03-08 09:08:22 +01008292#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008293
8294#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8295 /* Copy own and peer's CID if the use of the CID
8296 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8298 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008299
8300 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8302 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8303 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008304
8305 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8307 ssl->handshake->peer_cid_len);
8308 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8309 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008310 }
8311#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8312
8313 /*
8314 * Compute key block using the PRF
8315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8317 if (ret != 0) {
8318 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8319 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008320 }
8321
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8323 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8324 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8325 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8326 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008327
8328 /*
8329 * Determine the appropriate key, IV and MAC length.
8330 */
8331
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008332#if defined(MBEDTLS_USE_PSA_CRYPTO)
8333 keylen = PSA_BITS_TO_BYTES(key_bits);
8334#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008336#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008337
Valerio Settie5707042023-10-11 11:54:42 +02008338#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008340 size_t explicit_ivlen;
8341
8342 transform->maclen = 0;
8343 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008344
8345 /* All modes haves 96-bit IVs, but the length of the static parts vary
8346 * with mode and version:
8347 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8348 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8349 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8350 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8351 * sequence number).
8352 */
8353 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008354
8355 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008356#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008358#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8360 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008361#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008362
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008364 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368
8369 /* Minimum length of encrypted record */
8370 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8371 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 } else
Valerio Settie5707042023-10-11 11:54:42 +02008373#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008376 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008378#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008380#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008381 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008382#endif /* MBEDTLS_USE_PSA_CRYPTO */
8383
8384#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008385 /* Get MAC length */
8386 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8387#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008388 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8390 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8391 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008392 goto end;
8393 }
8394
8395 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008398 transform->maclen = mac_key_len;
8399
8400 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008401#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008403#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008404 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008405#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008406
8407 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008408 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008409 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008411 /*
8412 * GenericBlockCipher:
8413 * 1. if EtM is in use: one block plus MAC
8414 * otherwise: * first multiple of blocklen greater than maclen
8415 * 2. IV
8416 */
8417#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008419 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 + block_size;
8421 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422#endif
8423 {
8424 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 + block_size
8426 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 }
8428
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008430 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 } else {
8432 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008433 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8434 goto end;
8435 }
8436 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008438#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8439 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8441 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 }
8443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8445 (unsigned) keylen,
8446 (unsigned) transform->minlen,
8447 (unsigned) transform->ivlen,
8448 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008449
8450 /*
8451 * Finally setup the cipher contexts, IVs and MAC secrets.
8452 */
8453#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008455 key1 = keyblk + mac_key_len * 2;
8456 key2 = keyblk + mac_key_len * 2 + keylen;
8457
8458 mac_enc = keyblk;
8459 mac_dec = keyblk + mac_key_len;
8460
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 iv_copy_len = (transform->fixed_ivlen) ?
8462 transform->fixed_ivlen : transform->ivlen;
8463 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8464 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8465 iv_copy_len);
8466 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008467#endif /* MBEDTLS_SSL_CLI_C */
8468#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008470 key1 = keyblk + mac_key_len * 2 + keylen;
8471 key2 = keyblk + mac_key_len * 2;
8472
8473 mac_enc = keyblk + mac_key_len;
8474 mac_dec = keyblk;
8475
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 iv_copy_len = (transform->fixed_ivlen) ?
8477 transform->fixed_ivlen : transform->ivlen;
8478 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8479 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8480 iv_copy_len);
8481 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008482#endif /* MBEDTLS_SSL_SRV_C */
8483 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008484 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008485 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8486 goto end;
8487 }
8488
Paul Elliott4fb19552023-10-18 12:15:30 +01008489 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 ssl->f_export_keys(ssl->p_export_keys,
8491 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8492 master, 48,
8493 randbytes + 32,
8494 randbytes,
8495 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008496 }
8497
8498#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008499 transform->psa_alg = alg;
8500
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8502 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8503 psa_set_key_algorithm(&attributes, alg);
8504 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if ((status = psa_import_key(&attributes,
8507 key1,
8508 PSA_BITS_TO_BYTES(key_bits),
8509 &transform->psa_key_enc)) != PSA_SUCCESS) {
8510 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 if ((status = psa_import_key(&attributes,
8519 key2,
8520 PSA_BITS_TO_BYTES(key_bits),
8521 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008522 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008524 goto end;
8525 }
8526 }
8527#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8529 cipher_info)) != 0) {
8530 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008531 goto end;
8532 }
8533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8535 cipher_info)) != 0) {
8536 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537 goto end;
8538 }
8539
Gilles Peskine449bd832023-01-11 14:50:10 +01008540 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8541 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8542 MBEDTLS_ENCRYPT)) != 0) {
8543 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008544 goto end;
8545 }
8546
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8548 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8549 MBEDTLS_DECRYPT)) != 0) {
8550 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008551 goto end;
8552 }
8553
8554#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8556 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8557 MBEDTLS_PADDING_NONE)) != 0) {
8558 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559 goto end;
8560 }
8561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8563 MBEDTLS_PADDING_NONE)) != 0) {
8564 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008565 goto end;
8566 }
8567 }
8568#endif /* MBEDTLS_CIPHER_MODE_CBC */
8569#endif /* MBEDTLS_USE_PSA_CRYPTO */
8570
Neil Armstrong29c0c042022-03-17 17:47:28 +01008571#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8572 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8573 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008575#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008577
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8579 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8580 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 if ((status = psa_import_key(&attributes,
8583 mac_enc, mac_key_len,
8584 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008585 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008587 goto end;
8588 }
8589
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8591 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008592#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008594#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008596 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8598 PSA_KEY_USAGE_VERIFY_HASH);
8599 } else {
8600 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8601 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if ((status = psa_import_key(&attributes,
8604 mac_dec, mac_key_len,
8605 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008606 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008608 goto end;
8609 }
8610#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8612 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008613 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 }
8615 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8616 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008617 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008619#endif /* MBEDTLS_USE_PSA_CRYPTO */
8620 }
8621#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8622
8623 ((void) mac_dec);
8624 ((void) mac_enc);
8625
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008626end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8628 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008629}
8630
Valerio Settia08b1a42022-11-17 15:10:02 +01008631#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8632 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008633int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 psa_pake_operation_t *pake_ctx,
8635 const unsigned char *buf,
8636 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008637{
8638 psa_status_t status;
8639 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008640 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008641 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8642 * At round two perform a single cycle
8643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 for (; remaining_steps > 0; remaining_steps--) {
8647 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008648 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008650 /* Length is stored at the first byte */
8651 size_t length = buf[input_offset];
8652 input_offset += 1;
8653
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008655 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8656 }
8657
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 status = psa_pake_input(pake_ctx, step,
8659 buf + input_offset, length);
8660 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008661 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008662 }
8663
8664 input_offset += length;
8665 }
8666 }
8667
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008669 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008671
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008673}
8674
Valerio Setti6b3dab02022-11-17 17:14:54 +01008675int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 psa_pake_operation_t *pake_ctx,
8677 unsigned char *buf,
8678 size_t len, size_t *olen,
8679 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008680{
8681 psa_status_t status;
8682 size_t output_offset = 0;
8683 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008684 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008685 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8686 * At round two perform a single cycle
8687 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008689
Gilles Peskine449bd832023-01-11 14:50:10 +01008690 for (; remaining_steps > 0; remaining_steps--) {
8691 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8692 step <= PSA_PAKE_STEP_ZK_PROOF;
8693 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008694 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008695 * For each step, prepend 1 byte with the length of the data as
8696 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 status = psa_pake_output(pake_ctx, step,
8699 buf + output_offset + 1,
8700 len - output_offset - 1,
8701 &output_len);
8702 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008703 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008704 }
8705
Valerio Setti99d88c12022-11-22 16:03:43 +01008706 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008707
8708 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008709 }
8710 }
8711
8712 *olen = output_offset;
8713
Gilles Peskine449bd832023-01-11 14:50:10 +01008714 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008715}
Valerio Settia08b1a42022-11-17 15:10:02 +01008716#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8717
Jerry Yuee40f9d2022-02-17 14:55:16 +08008718#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008719int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8720 unsigned char *hash, size_t *hashlen,
8721 unsigned char *data, size_t data_len,
8722 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008723{
8724 psa_status_t status;
8725 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008726 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008727
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008729
Gilles Peskine449bd832023-01-11 14:50:10 +01008730 if ((status = psa_hash_setup(&hash_operation,
8731 hash_alg)) != PSA_SUCCESS) {
8732 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008733 goto exit;
8734 }
8735
Gilles Peskine449bd832023-01-11 14:50:10 +01008736 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8737 64)) != PSA_SUCCESS) {
8738 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008739 goto exit;
8740 }
8741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 if ((status = psa_hash_update(&hash_operation,
8743 data, data_len)) != PSA_SUCCESS) {
8744 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008745 goto exit;
8746 }
8747
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8749 hashlen)) != PSA_SUCCESS) {
8750 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8751 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008752 }
8753
8754exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 if (status != PSA_SUCCESS) {
8756 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8757 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8758 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008761 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8762 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008763 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008764 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008766 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008767 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008768 }
8769 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771}
8772
8773#else
8774
Gilles Peskine449bd832023-01-11 14:50:10 +01008775int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8776 unsigned char *hash, size_t *hashlen,
8777 unsigned char *data, size_t data_len,
8778 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779{
8780 int ret = 0;
8781 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8783 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008784
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008786
Gilles Peskine449bd832023-01-11 14:50:10 +01008787 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008788
8789 /*
8790 * digitally-signed struct {
8791 * opaque client_random[32];
8792 * opaque server_random[32];
8793 * ServerDHParams params;
8794 * };
8795 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8797 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008798 goto exit;
8799 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8801 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008802 goto exit;
8803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008804 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8805 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008806 goto exit;
8807 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8809 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008810 goto exit;
8811 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008814 goto exit;
8815 }
8816
8817exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008818 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008819
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 if (ret != 0) {
8821 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8822 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8823 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008824
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008826}
8827#endif /* MBEDTLS_USE_PSA_CRYPTO */
8828
Jerry Yud9d91da2022-02-17 14:57:06 +08008829#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8830
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008831/* Find the preferred hash for a given signature algorithm. */
8832unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 mbedtls_ssl_context *ssl,
8834 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008835{
Gabor Mezei078e8032022-04-27 21:17:56 +02008836 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008837 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008838
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8840 return MBEDTLS_SSL_HASH_NONE;
8841 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008842
Gilles Peskine449bd832023-01-11 14:50:10 +01008843 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008844 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8846 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008847 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8849 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008850
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008851 mbedtls_md_type_t md_alg =
8852 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8853 if (md_alg == MBEDTLS_MD_NONE) {
8854 continue;
8855 }
8856
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008858#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008859 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008860 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008861 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008862
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8864 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8865 PSA_ALG_ECDSA(psa_hash_alg),
8866 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008867 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008869
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8871 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8872 PSA_ALG_RSA_PKCS1V15_SIGN(
8873 psa_hash_alg),
8874 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008875 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008877 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008878#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008879
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008881 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008882 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008883
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008885}
8886
8887#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8888
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008889/* Serialization of TLS 1.2 sessions:
8890 *
8891 * struct {
8892 * uint64 start_time;
8893 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008894 * uint8 session_id_len; // at most 32
8895 * opaque session_id[32];
8896 * opaque master[48]; // fixed length in the standard
8897 * uint32 verify_result;
8898 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8899 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8900 * uint32 ticket_lifetime;
8901 * uint8 mfl_code; // up to 255 according to standard
8902 * uint8 encrypt_then_mac; // 0 or 1
8903 * } serialized_session_tls12;
8904 *
8905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008906static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8907 unsigned char *buf,
8908 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008909{
8910 unsigned char *p = buf;
8911 size_t used = 0;
8912
8913#if defined(MBEDTLS_HAVE_TIME)
8914 uint64_t start;
8915#endif
8916#if defined(MBEDTLS_X509_CRT_PARSE_C)
8917#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8918 size_t cert_len;
8919#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8920#endif /* MBEDTLS_X509_CRT_PARSE_C */
8921
8922 /*
8923 * Time
8924 */
8925#if defined(MBEDTLS_HAVE_TIME)
8926 used += 8;
8927
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008929 start = (uint64_t) session->start;
8930
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008932 p += 8;
8933 }
8934#endif /* MBEDTLS_HAVE_TIME */
8935
8936 /*
8937 * Basic mandatory fields
8938 */
8939 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 + 1 /* id_len */
8941 + sizeof(session->id)
8942 + sizeof(session->master)
8943 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008944
Gilles Peskine449bd832023-01-11 14:50:10 +01008945 if (used <= buf_len) {
8946 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008947 p += 2;
8948
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 *p++ = MBEDTLS_BYTE_0(session->id_len);
8950 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008951 p += 32;
8952
Gilles Peskine449bd832023-01-11 14:50:10 +01008953 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008954 p += 48;
8955
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008957 p += 4;
8958 }
8959
8960 /*
8961 * Peer's end-entity certificate
8962 */
8963#if defined(MBEDTLS_X509_CRT_PARSE_C)
8964#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008965 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008966 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008967 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008968 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008969 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008970
8971 used += 3 + cert_len;
8972
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 if (used <= buf_len) {
8974 *p++ = MBEDTLS_BYTE_2(cert_len);
8975 *p++ = MBEDTLS_BYTE_1(cert_len);
8976 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if (session->peer_cert != NULL) {
8979 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008980 p += cert_len;
8981 }
8982 }
8983#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008984 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008985 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008987 *p++ = (unsigned char) session->peer_cert_digest_type;
8988 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 memcpy(p, session->peer_cert_digest,
8990 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008991 p += session->peer_cert_digest_len;
8992 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008994 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008996 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8997 *p++ = 0;
8998 }
8999 }
9000#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9001#endif /* MBEDTLS_X509_CRT_PARSE_C */
9002
9003 /*
9004 * Session ticket if any, plus associated data
9005 */
9006#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9007 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9008
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 if (used <= buf_len) {
9010 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9011 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9012 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009013
Gilles Peskine449bd832023-01-11 14:50:10 +01009014 if (session->ticket != NULL) {
9015 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009016 p += session->ticket_len;
9017 }
9018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 p += 4;
9021 }
9022#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9023
9024 /*
9025 * Misc extension-related info
9026 */
9027#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9028 used += 1;
9029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009031 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009033#endif
9034
9035#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9036 used += 1;
9037
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 if (used <= buf_len) {
9039 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9040 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009041#endif
9042
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044}
9045
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009046MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009047static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9048 const unsigned char *buf,
9049 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009050{
9051#if defined(MBEDTLS_HAVE_TIME)
9052 uint64_t start;
9053#endif
9054#if defined(MBEDTLS_X509_CRT_PARSE_C)
9055#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9056 size_t cert_len;
9057#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9058#endif /* MBEDTLS_X509_CRT_PARSE_C */
9059
9060 const unsigned char *p = buf;
9061 const unsigned char * const end = buf + len;
9062
9063 /*
9064 * Time
9065 */
9066#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009067 if (8 > (size_t) (end - p)) {
9068 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9069 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009070
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009071 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072 p += 8;
9073
9074 session->start = (time_t) start;
9075#endif /* MBEDTLS_HAVE_TIME */
9076
9077 /*
9078 * Basic mandatory fields
9079 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9082 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009084 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085 p += 2;
9086
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009087 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009088 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009089 p += 32;
9090
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009092 p += 48;
9093
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009094 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009095 p += 4;
9096
9097 /* Immediately clear invalid pointer values that have been read, in case
9098 * we exit early before we replaced them with valid ones. */
9099#if defined(MBEDTLS_X509_CRT_PARSE_C)
9100#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9101 session->peer_cert = NULL;
9102#else
9103 session->peer_cert_digest = NULL;
9104#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9105#endif /* MBEDTLS_X509_CRT_PARSE_C */
9106#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9107 session->ticket = NULL;
9108#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9109
9110 /*
9111 * Peer certificate
9112 */
9113#if defined(MBEDTLS_X509_CRT_PARSE_C)
9114#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9115 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 if (3 > (size_t) (end - p)) {
9117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9118 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009120 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009121 p += 3;
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9125
Gilles Peskine449bd832023-01-11 14:50:10 +01009126 if (cert_len > (size_t) (end - p)) {
9127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9128 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 if (session->peer_cert == NULL) {
9133 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9134 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135
Gilles Peskine449bd832023-01-11 14:50:10 +01009136 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9139 p, cert_len)) != 0) {
9140 mbedtls_x509_crt_free(session->peer_cert);
9141 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009142 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009143 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144 }
9145
9146 p += cert_len;
9147 }
9148#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9149 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if (2 > (size_t) (end - p)) {
9151 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9152 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009153
9154 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9155 session->peer_cert_digest_len = (size_t) *p++;
9156
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009158 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9160 if (md_info == NULL) {
9161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9162 }
9163 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9165 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9169 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009170
9171 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 mbedtls_calloc(1, session->peer_cert_digest_len);
9173 if (session->peer_cert_digest == NULL) {
9174 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9175 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 memcpy(session->peer_cert_digest, p,
9178 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009179 p += session->peer_cert_digest_len;
9180 }
9181#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9182#endif /* MBEDTLS_X509_CRT_PARSE_C */
9183
9184 /*
9185 * Session ticket and associated data
9186 */
9187#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 if (3 > (size_t) (end - p)) {
9189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9190 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009191
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009192 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009193 p += 3;
9194
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 if (session->ticket_len != 0) {
9196 if (session->ticket_len > (size_t) (end - p)) {
9197 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9198 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 session->ticket = mbedtls_calloc(1, session->ticket_len);
9201 if (session->ticket == NULL) {
9202 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9203 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009204
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009206 p += session->ticket_len;
9207 }
9208
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 if (4 > (size_t) (end - p)) {
9210 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9211 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009212
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009213 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009214 p += 4;
9215#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9216
9217 /*
9218 * Misc extension-related info
9219 */
9220#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 if (1 > (size_t) (end - p)) {
9222 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9223 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009224
9225 session->mfl_code = *p++;
9226#endif
9227
9228#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 if (1 > (size_t) (end - p)) {
9230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9231 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009232
9233 session->encrypt_then_mac = *p++;
9234#endif
9235
9236 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009237 if (p != end) {
9238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9239 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009240
Gilles Peskine449bd832023-01-11 14:50:10 +01009241 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009242}
Jerry Yudc7bd172022-02-17 13:44:15 +08009243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9244
XiaokangQian75d40ef2022-04-20 11:05:24 +00009245int mbedtls_ssl_validate_ciphersuite(
9246 const mbedtls_ssl_context *ssl,
9247 const mbedtls_ssl_ciphersuite_t *suite_info,
9248 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009250{
9251 (void) ssl;
9252
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 if (suite_info == NULL) {
9254 return -1;
9255 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009256
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 if ((suite_info->min_tls_version > max_tls_version) ||
9258 (suite_info->max_tls_version < min_tls_version)) {
9259 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009260 }
9261
XiaokangQian060d8672022-04-21 09:24:56 +00009262#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009263#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009264#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009265 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9266 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009267#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9269 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009270#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009271 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009272 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009273 }
9274#endif
9275
9276 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9277#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009278 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9279 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9280 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009281 }
9282#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9283#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9284
Gilles Peskine449bd832023-01-11 14:50:10 +01009285 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009286}
9287
Ronald Crone68ab4f2022-10-05 12:46:29 +02009288#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009289/*
9290 * Function for writing a signature algorithm extension.
9291 *
9292 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9293 * value (TLS 1.3 RFC8446):
9294 * enum {
9295 * ....
9296 * ecdsa_secp256r1_sha256( 0x0403 ),
9297 * ecdsa_secp384r1_sha384( 0x0503 ),
9298 * ecdsa_secp521r1_sha512( 0x0603 ),
9299 * ....
9300 * } SignatureScheme;
9301 *
9302 * struct {
9303 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9304 * } SignatureSchemeList;
9305 *
9306 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9307 * value (TLS 1.2 RFC5246):
9308 * enum {
9309 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9310 * sha512(6), (255)
9311 * } HashAlgorithm;
9312 *
9313 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9314 * SignatureAlgorithm;
9315 *
9316 * struct {
9317 * HashAlgorithm hash;
9318 * SignatureAlgorithm signature;
9319 * } SignatureAndHashAlgorithm;
9320 *
9321 * SignatureAndHashAlgorithm
9322 * supported_signature_algorithms<2..2^16-2>;
9323 *
9324 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9325 * generalization of the TLS 1.2 signature algorithm extension.
9326 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9327 * `SignatureScheme` field of TLS 1.3
9328 *
9329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009330int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9331 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009332{
9333 unsigned char *p = buf;
9334 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9335 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9336
9337 *out_len = 0;
9338
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009340
9341 /* Check if we have space for header and length field:
9342 * - extension_type (2 bytes)
9343 * - extension_data_length (2 bytes)
9344 * - supported_signature_algorithms_length (2 bytes)
9345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009346 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009347 p += 6;
9348
9349 /*
9350 * Write supported_signature_algorithms
9351 */
9352 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009353 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9354 if (sig_alg == NULL) {
9355 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9356 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009357
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9359 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9360 *sig_alg,
9361 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9362 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009363 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 }
9365 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9366 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009367 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009368 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9369 *sig_alg,
9370 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009371 }
9372
9373 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009374 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009375 if (supported_sig_alg_len == 0) {
9376 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9377 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009378 }
9379
Gilles Peskine449bd832023-01-11 14:50:10 +01009380 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9381 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9382 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009383
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009384 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009385
9386#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009388#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009389
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009391}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009392#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009393
XiaokangQian40a35232022-05-07 09:02:40 +00009394#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009395/*
9396 * mbedtls_ssl_parse_server_name_ext
9397 *
9398 * Structure of server_name extension:
9399 *
9400 * enum {
9401 * host_name(0), (255)
9402 * } NameType;
9403 * opaque HostName<1..2^16-1>;
9404 *
9405 * struct {
9406 * NameType name_type;
9407 * select (name_type) {
9408 * case host_name: HostName;
9409 * } name;
9410 * } ServerName;
9411 * struct {
9412 * ServerName server_name_list<1..2^16-1>
9413 * } ServerNameList;
9414 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009416int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9417 const unsigned char *buf,
9418 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009419{
9420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9421 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009422 size_t server_name_list_len, hostname_len;
9423 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009424
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009426
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9428 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009429 p += 2;
9430
Gilles Peskine449bd832023-01-11 14:50:10 +01009431 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009432 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009433 while (p < server_name_list_end) {
9434 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9435 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9436 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9437 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009438
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009440 /* sni_name is intended to be used only during the parsing of the
9441 * ClientHello message (it is reset to NULL before the end of
9442 * the message parsing). Thus it is ok to just point to the
9443 * reception buffer and not make a copy of it.
9444 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009445 ssl->handshake->sni_name = p + 3;
9446 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 if (ssl->conf->f_sni == NULL) {
9448 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009449 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9451 ssl, p + 3, hostname_len);
9452 if (ret != 0) {
9453 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9454 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9455 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9456 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9457 }
9458 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009459 }
9460
9461 p += hostname_len + 3;
9462 }
9463
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009465}
9466#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9467
XiaokangQianacb39922022-06-17 10:18:48 +00009468#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009470int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9471 const unsigned char *buf,
9472 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009473{
9474 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009475 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009476 const unsigned char *protocol_name_list;
9477 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009478 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009479
9480 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 if (ssl->conf->alpn_list == NULL) {
9482 return 0;
9483 }
XiaokangQianacb39922022-06-17 10:18:48 +00009484
9485 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009486 * RFC7301, section 3.1
9487 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009488 *
XiaokangQianc7403452022-06-23 03:24:12 +00009489 * struct {
9490 * ProtocolName protocol_name_list<2..2^16-1>
9491 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009492 */
9493
XiaokangQianc7403452022-06-23 03:24:12 +00009494 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009495 * protocol_name_list_len 2 bytes
9496 * protocol_name_len 1 bytes
9497 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009500
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009502 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009504 protocol_name_list = p;
9505 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009506
9507 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009509 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9511 protocol_name_len);
9512 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009513 MBEDTLS_SSL_PEND_FATAL_ALERT(
9514 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9516 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009517 }
9518
9519 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009520 }
9521
9522 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9524 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009525 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009527 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009528 if (protocol_name_len == alpn_len &&
9529 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009530 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009532 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009533
9534 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009535 }
9536 }
9537
XiaokangQian95d5f542022-06-24 02:29:26 +00009538 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009539 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9541 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9542 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009543}
9544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9546 unsigned char *buf,
9547 unsigned char *end,
9548 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009549{
9550 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009551 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009552 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009553
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 if (ssl->alpn_chosen == NULL) {
9555 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009556 }
9557
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 protocol_name_len = strlen(ssl->alpn_chosen);
9559 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009560
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009562 /*
9563 * 0 . 1 ext identifier
9564 * 2 . 3 ext length
9565 * 4 . 5 protocol list length
9566 * 6 . 6 protocol name length
9567 * 7 . 7+n protocol name
9568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009570
XiaokangQian95d5f542022-06-24 02:29:26 +00009571 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009572
Gilles Peskine449bd832023-01-11 14:50:10 +01009573 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9574 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009575 /* Note: the length of the chosen protocol has been checked to be less
9576 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009579
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009581
9582#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009584#endif
9585
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009587}
9588#endif /* MBEDTLS_SSL_ALPN */
9589
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009590#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009591 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009592 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009593 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009594int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9595 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009596{
9597 /* Initialize to suppress unnecessary compiler warning */
9598 size_t hostname_len = 0;
9599
9600 /* Check if new hostname is valid before
9601 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009602 if (hostname != NULL) {
9603 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009604
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9607 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009608 }
9609
9610 /* Now it's clear that we will overwrite the old hostname,
9611 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009612 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009613 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009614 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009615 }
9616
9617 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009618 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009619 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 } else {
9621 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9622 if (session->hostname == NULL) {
9623 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9624 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009625
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009627 }
9628
Gilles Peskine449bd832023-01-11 14:50:10 +01009629 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009630}
Xiaokang Qian03409292022-10-12 02:49:52 +00009631#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9632 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009633 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009634 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009635
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009636#endif /* MBEDTLS_SSL_TLS_C */