blob: 8c1e37251b98d1ba4b12570c4c7621b52d829d66 [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 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001345 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 (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;
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002458 * uint16 record_size_limit;
Jerry Yu438ddd82022-07-07 06:55:50 +00002459 * select ( endpoint ) {
2460 * case client: ClientOnlyData;
Jerry Yucf913512023-11-14 11:06:52 +08002461 * case server: uint64 ticket_creation_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002462 * };
2463 * } serialized_session_tls13;
2464 *
2465 */
2466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002467MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002468static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2469 unsigned char *buf,
2470 size_t buf_len,
2471 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002472{
2473 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002474#if defined(MBEDTLS_SSL_CLI_C) && \
2475 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 size_t hostname_len = (session->hostname == NULL) ?
2477 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002478#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002479 size_t needed = 1 /* endpoint */
2480 + 2 /* ciphersuite */
2481 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002482 + 1 /* ticket_flags */
2483 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002484 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2488 }
Jerry Yu34191072022-08-18 10:32:09 +08002489 needed += session->resumption_key_len; /* resumption_key */
2490
Jerry Yu02e3a072022-12-12 15:13:20 +08002491#if defined(MBEDTLS_SSL_EARLY_DATA)
2492 needed += 4; /* max_early_data_size */
2493#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002494#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002495 needed += 2; /* record_size_limit */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002496#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002497
Jerry Yu438ddd82022-07-07 06:55:50 +00002498#if defined(MBEDTLS_HAVE_TIME)
Jerry Yucf913512023-11-14 11:06:52 +08002499 needed += 8; /* ticket_creation_time or ticket_reception_time */
Jerry Yu438ddd82022-07-07 06:55:50 +00002500#endif
2501
2502#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002504#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002505 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002507#endif
2508
Jerry Yu438ddd82022-07-07 06:55:50 +00002509 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002510 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002511
2512 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (session->ticket_len > SIZE_MAX - needed) {
2514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2515 }
Jerry Yu34191072022-08-18 10:32:09 +08002516
Jerry Yue28d9742022-08-18 15:44:03 +08002517 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002518 }
2519#endif /* MBEDTLS_SSL_CLI_C */
2520
Jerry Yue36fdd62022-08-17 21:31:36 +08002521 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 if (needed > buf_len) {
2523 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2524 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002525
2526 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2528 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p[7] = session->ticket_flags;
2530
2531 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002532 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002533 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002535 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002536
Jerry Yu02e3a072022-12-12 15:13:20 +08002537#if defined(MBEDTLS_SSL_EARLY_DATA)
2538 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2539 p += 4;
2540#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002541#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2542 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
2543 p += 2;
2544#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002545
Jerry Yu438ddd82022-07-07 06:55:50 +00002546#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002548 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002549 p += 8;
2550 }
2551#endif /* MBEDTLS_HAVE_TIME */
2552
2553#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002555#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002557 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002559 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002561 p += hostname_len;
2562 }
2563#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2564
Jerry Yu438ddd82022-07-07 06:55:50 +00002565#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu342a5552023-11-10 14:23:39 +08002566 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002567 p += 8;
2568#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002570 p += 4;
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002573 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (session->ticket != NULL && session->ticket_len > 0) {
2576 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 p += session->ticket_len;
2578 }
2579 }
2580#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002582}
2583
2584MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002585static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2586 const unsigned char *buf,
2587 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002588{
2589 const unsigned char *p = buf;
2590 const unsigned char *end = buf + len;
2591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (end - p < 9) {
2593 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2594 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002595 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2597 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002598 session->ticket_flags = p[7];
2599
2600 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002601 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 p += 9;
2603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (end - p < session->resumption_key_len) {
2605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2606 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2610 }
2611 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002612 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002613
Jerry Yu02e3a072022-12-12 15:13:20 +08002614#if defined(MBEDTLS_SSL_EARLY_DATA)
2615 if (end - p < 4) {
2616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2617 }
2618 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2619 p += 4;
2620#endif
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002621#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2622 if (end - p < 2) {
2623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2624 }
2625 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
2626 p += 2;
2627#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
Jerry Yu02e3a072022-12-12 15:13:20 +08002628
Jerry Yu438ddd82022-07-07 06:55:50 +00002629#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2631 if (end - p < 8) {
2632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2633 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002634 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002635 p += 8;
2636 }
2637#endif /* MBEDTLS_HAVE_TIME */
2638
2639#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Yanray Wangfd256542023-11-22 10:32:03 +08002641#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002642 size_t hostname_len;
2643 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (end - p < 2) {
2645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2646 }
2647 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002648 p += 2;
2649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (end - p < (long int) hostname_len) {
2651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2652 }
2653 if (hostname_len > 0) {
2654 session->hostname = mbedtls_calloc(1, hostname_len);
2655 if (session->hostname == NULL) {
2656 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2657 }
2658 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002659 p += hostname_len;
2660 }
Yanray Wangfd256542023-11-22 10:32:03 +08002661#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002662
Jerry Yu438ddd82022-07-07 06:55:50 +00002663#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (end - p < 8) {
2665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2666 }
Jerry Yu342a5552023-11-10 14:23:39 +08002667 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002668 p += 8;
2669#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (end - p < 4) {
2671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2672 }
2673 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002674 p += 4;
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (end - p < 2) {
2677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2678 }
2679 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002680 p += 2;
2681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 if (end - p < (long int) session->ticket_len) {
2683 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2684 }
2685 if (session->ticket_len > 0) {
2686 session->ticket = mbedtls_calloc(1, session->ticket_len);
2687 if (session->ticket == NULL) {
2688 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2689 }
2690 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002691 p += session->ticket_len;
2692 }
2693 }
2694#endif /* MBEDTLS_SSL_CLI_C */
2695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002697
2698}
2699#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002701static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2702 unsigned char *buf,
2703 size_t buf_len,
2704 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002705{
2706 ((void) session);
2707 ((void) buf);
2708 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002709 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002711}
Jerry Yu438ddd82022-07-07 06:55:50 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2714 unsigned char *buf,
2715 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002716{
2717 ((void) session);
2718 ((void) buf);
2719 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002721}
2722#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002723#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2726 size_t taglen,
2727 psa_algorithm_t *alg,
2728 psa_key_type_t *key_type,
2729 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002730{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002731#if !defined(MBEDTLS_SSL_HAVE_CCM)
2732 (void) taglen;
2733#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002735#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002736 case MBEDTLS_CIPHER_AES_128_CBC:
2737 *alg = PSA_ALG_CBC_NO_PADDING;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 128;
2740 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002741#endif
2742#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002743 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002745 *key_type = PSA_KEY_TYPE_AES;
2746 *key_size = 128;
2747 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002748#endif
2749#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002750 case MBEDTLS_CIPHER_AES_128_GCM:
2751 *alg = PSA_ALG_GCM;
2752 *key_type = PSA_KEY_TYPE_AES;
2753 *key_size = 128;
2754 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002755#endif
2756#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002757 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002759 *key_type = PSA_KEY_TYPE_AES;
2760 *key_size = 192;
2761 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002762#endif
2763#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002764 case MBEDTLS_CIPHER_AES_192_GCM:
2765 *alg = PSA_ALG_GCM;
2766 *key_type = PSA_KEY_TYPE_AES;
2767 *key_size = 192;
2768 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002769#endif
2770#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002771 case MBEDTLS_CIPHER_AES_256_CBC:
2772 *alg = PSA_ALG_CBC_NO_PADDING;
2773 *key_type = PSA_KEY_TYPE_AES;
2774 *key_size = 256;
2775 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002776#endif
2777#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002778 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002780 *key_type = PSA_KEY_TYPE_AES;
2781 *key_size = 256;
2782 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002783#endif
2784#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002785 case MBEDTLS_CIPHER_AES_256_GCM:
2786 *alg = PSA_ALG_GCM;
2787 *key_type = PSA_KEY_TYPE_AES;
2788 *key_size = 256;
2789 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002790#endif
2791#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002792 case MBEDTLS_CIPHER_ARIA_128_CBC:
2793 *alg = PSA_ALG_CBC_NO_PADDING;
2794 *key_type = PSA_KEY_TYPE_ARIA;
2795 *key_size = 128;
2796 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002797#endif
2798#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002799 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002801 *key_type = PSA_KEY_TYPE_ARIA;
2802 *key_size = 128;
2803 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002804#endif
2805#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002806 case MBEDTLS_CIPHER_ARIA_128_GCM:
2807 *alg = PSA_ALG_GCM;
2808 *key_type = PSA_KEY_TYPE_ARIA;
2809 *key_size = 128;
2810 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002811#endif
2812#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002813 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002815 *key_type = PSA_KEY_TYPE_ARIA;
2816 *key_size = 192;
2817 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002818#endif
2819#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002820 case MBEDTLS_CIPHER_ARIA_192_GCM:
2821 *alg = PSA_ALG_GCM;
2822 *key_type = PSA_KEY_TYPE_ARIA;
2823 *key_size = 192;
2824 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002825#endif
2826#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002827 case MBEDTLS_CIPHER_ARIA_256_CBC:
2828 *alg = PSA_ALG_CBC_NO_PADDING;
2829 *key_type = PSA_KEY_TYPE_ARIA;
2830 *key_size = 256;
2831 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002832#endif
2833#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002834 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002836 *key_type = PSA_KEY_TYPE_ARIA;
2837 *key_size = 256;
2838 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002839#endif
2840#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002841 case MBEDTLS_CIPHER_ARIA_256_GCM:
2842 *alg = PSA_ALG_GCM;
2843 *key_type = PSA_KEY_TYPE_ARIA;
2844 *key_size = 256;
2845 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002846#endif
2847#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002848 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2849 *alg = PSA_ALG_CBC_NO_PADDING;
2850 *key_type = PSA_KEY_TYPE_CAMELLIA;
2851 *key_size = 128;
2852 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002853#endif
2854#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002855 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002857 *key_type = PSA_KEY_TYPE_CAMELLIA;
2858 *key_size = 128;
2859 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002860#endif
2861#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002862 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2863 *alg = PSA_ALG_GCM;
2864 *key_type = PSA_KEY_TYPE_CAMELLIA;
2865 *key_size = 128;
2866 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002867#endif
2868#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002869 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002871 *key_type = PSA_KEY_TYPE_CAMELLIA;
2872 *key_size = 192;
2873 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002874#endif
2875#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002876 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2877 *alg = PSA_ALG_GCM;
2878 *key_type = PSA_KEY_TYPE_CAMELLIA;
2879 *key_size = 192;
2880 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002881#endif
2882#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002883 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2884 *alg = PSA_ALG_CBC_NO_PADDING;
2885 *key_type = PSA_KEY_TYPE_CAMELLIA;
2886 *key_size = 256;
2887 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002888#endif
2889#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002890 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002892 *key_type = PSA_KEY_TYPE_CAMELLIA;
2893 *key_size = 256;
2894 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002895#endif
2896#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002897 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2898 *alg = PSA_ALG_GCM;
2899 *key_type = PSA_KEY_TYPE_CAMELLIA;
2900 *key_size = 256;
2901 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002902#endif
2903#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002904 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2905 *alg = PSA_ALG_CHACHA20_POLY1305;
2906 *key_type = PSA_KEY_TYPE_CHACHA20;
2907 *key_size = 256;
2908 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002909#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002910 case MBEDTLS_CIPHER_NULL:
2911 *alg = MBEDTLS_SSL_NULL_CIPHER;
2912 *key_type = 0;
2913 *key_size = 0;
2914 break;
2915 default:
2916 return PSA_ERROR_NOT_SUPPORTED;
2917 }
2918
2919 return PSA_SUCCESS;
2920}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002921#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002922
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002923#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002924int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2925 const unsigned char *dhm_P, size_t P_len,
2926 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002927{
Janos Follath865b3eb2019-12-16 11:46:15 +00002928 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 mbedtls_mpi_free(&conf->dhm_P);
2931 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2934 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2935 mbedtls_mpi_free(&conf->dhm_P);
2936 mbedtls_mpi_free(&conf->dhm_G);
2937 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002938 }
2939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002941}
Paul Bakker5121ce52009-01-03 21:22:43 +00002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002944{
Janos Follath865b3eb2019-12-16 11:46:15 +00002945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 mbedtls_mpi_free(&conf->dhm_P);
2948 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2951 &conf->dhm_P)) != 0 ||
2952 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2953 &conf->dhm_G)) != 0) {
2954 mbedtls_mpi_free(&conf->dhm_P);
2955 mbedtls_mpi_free(&conf->dhm_G);
2956 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002957 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002960}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002961#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002962
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002963#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2964/*
2965 * Set the minimum length for Diffie-Hellman parameters
2966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2968 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002969{
2970 conf->dhm_min_bitlen = bitlen;
2971}
2972#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2973
Ronald Crone68ab4f2022-10-05 12:46:29 +02002974#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002975#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002976/*
2977 * Set allowed/preferred hashes for handshake signatures
2978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002979void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2980 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002981{
2982 conf->sig_hashes = hashes;
2983}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002984#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002985
Jerry Yuf017ee42022-01-12 15:49:48 +08002986/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2988 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002989{
Jerry Yuf017ee42022-01-12 15:49:48 +08002990#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2991 conf->sig_hashes = NULL;
2992#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2993 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002994}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002995#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002996
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002997#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002998#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002999/*
3000 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01003001 *
3002 * mbedtls_ssl_setup() takes the provided list
3003 * and translates it to a list of IANA TLS group identifiers,
3004 * stored in ssl->handshake->group_list.
3005 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003007void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3008 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003009{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003010 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01003011 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003012}
Brett Warrene0edc842021-08-17 09:53:13 +01003013#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003014#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01003015
Brett Warrene0edc842021-08-17 09:53:13 +01003016/*
3017 * Set the allowed groups
3018 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3020 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01003021{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003022#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01003023 conf->curve_list = NULL;
3024#endif
3025 conf->group_list = group_list;
3026}
3027
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003028#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003029int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00003030{
Hanno Becker947194e2017-04-07 13:25:49 +01003031 /* Initialize to suppress unnecessary compiler warning */
3032 size_t hostname_len = 0;
3033
3034 /* Check if new hostname is valid before
3035 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (hostname != NULL) {
3037 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01003038
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
3040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3041 }
Hanno Becker947194e2017-04-07 13:25:49 +01003042 }
3043
3044 /* Now it's clear that we will overwrite the old hostname,
3045 * so we can free it safely */
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01003048 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01003049 }
3050
3051 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01003052
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01003054 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 } else {
3056 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
3057 if (ssl->hostname == NULL) {
3058 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3059 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02003062
Hanno Becker947194e2017-04-07 13:25:49 +01003063 ssl->hostname[hostname_len] = '\0';
3064 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003067}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003068#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003069
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003070#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003071void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3072 int (*f_sni)(void *, mbedtls_ssl_context *,
3073 const unsigned char *, size_t),
3074 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003075{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003076 conf->f_sni = f_sni;
3077 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003078}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003082int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003083{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003084 size_t cur_len, tot_len;
3085 const char **p;
3086
3087 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003088 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3089 * MUST NOT be truncated."
3090 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003091 */
3092 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 for (p = protos; *p != NULL; p++) {
3094 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003095 tot_len += cur_len;
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097 if ((cur_len == 0) ||
3098 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3099 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3101 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003102 }
3103
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003104 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003107}
3108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003110{
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003112}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003114
Johan Pascalb62bb512015-12-03 21:56:45 +01003115#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003116void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3117 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003118{
3119 conf->dtls_srtp_mki_support = support_mki_value;
3120}
3121
Gilles Peskine449bd832023-01-11 14:50:10 +01003122int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3123 unsigned char *mki_value,
3124 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003125{
Gilles Peskine449bd832023-01-11 14:50:10 +01003126 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003128 }
Ron Eldor591f1622018-01-22 12:30:04 +02003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3131 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003132 }
Ron Eldor591f1622018-01-22 12:30:04 +02003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003135 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003137}
3138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3140 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003141{
Johan Pascal253d0262020-09-22 13:04:45 +02003142 const mbedtls_ssl_srtp_profile *p;
3143 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003144
Johan Pascal253d0262020-09-22 13:04:45 +02003145 /* check the profiles list: all entry must be valid,
3146 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3148 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3149 p++) {
3150 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003151 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003153 /* unsupported value, stop parsing and set the size to an error value */
3154 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003155 }
3156 }
3157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3159 conf->dtls_srtp_profile_list = NULL;
3160 conf->dtls_srtp_profile_list_len = 0;
3161 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003162 }
3163
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003164 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003165 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003168}
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3171 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003172{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003173 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3174 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003176 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003178 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3180 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003181 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003182}
Johan Pascalb62bb512015-12-03 21:56:45 +01003183#endif /* MBEDTLS_SSL_DTLS_SRTP */
3184
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303185#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003186void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003187{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003188 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003189}
3190
Gilles Peskine449bd832023-01-11 14:50:10 +01003191void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003192{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003193 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003194}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303195#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003196
Janos Follath088ce432017-04-10 12:42:31 +01003197#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3199 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003200{
3201 conf->cert_req_ca_list = cert_req_ca_list;
3202}
3203#endif
3204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003206void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003207{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003208 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003209}
3210#endif
3211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003213void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003214{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003215 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003216}
3217#endif
3218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003220int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003221{
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3223 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003225 }
3226
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003227 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003230}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003232
Gilles Peskine449bd832023-01-11 14:50:10 +01003233void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003234{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003235 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003236}
3237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003239void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003240{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003241 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003242}
3243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003245{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003246 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003247}
3248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3250 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003251{
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003253}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003257#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003258void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003259{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003260 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003261}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003262#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003263
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003264#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003265
Jerry Yud0766ec2022-09-22 10:46:57 +08003266#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003267void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3268 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003269{
Jerry Yud0766ec2022-09-22 10:46:57 +08003270 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003271}
3272#endif
3273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3275 mbedtls_ssl_ticket_write_t *f_ticket_write,
3276 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3277 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003278{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003279 conf->f_ticket_write = f_ticket_write;
3280 conf->f_ticket_parse = f_ticket_parse;
3281 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003282}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003283#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3287 mbedtls_ssl_export_keys_t *f_export_keys,
3288 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003289{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003290 ssl->f_export_keys = f_export_keys;
3291 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003292}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003293
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003294#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003295void mbedtls_ssl_conf_async_private_cb(
3296 mbedtls_ssl_config *conf,
3297 mbedtls_ssl_async_sign_t *f_async_sign,
3298 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3299 mbedtls_ssl_async_resume_t *f_async_resume,
3300 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003302{
3303 conf->f_async_sign_start = f_async_sign;
3304 conf->f_async_decrypt_start = f_async_decrypt;
3305 conf->f_async_resume = f_async_resume;
3306 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003307 conf->p_async_config_data = async_config_data;
3308}
3309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003311{
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003313}
3314
Gilles Peskine449bd832023-01-11 14:50:10 +01003315void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003316{
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 if (ssl->handshake == NULL) {
3318 return NULL;
3319 } else {
3320 return ssl->handshake->user_async_ctx;
3321 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003322}
3323
Gilles Peskine449bd832023-01-11 14:50:10 +01003324void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3325 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003326{
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003328 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003330}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003331#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003332
Paul Bakker5121ce52009-01-03 21:22:43 +00003333/*
3334 * SSL get accessors
3335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003336uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003337{
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 if (ssl->session != NULL) {
3339 return ssl->session->verify_result;
3340 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003341
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (ssl->session_negotiate != NULL) {
3343 return ssl->session_negotiate->verify_result;
3344 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003345
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003347}
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003350{
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (ssl == NULL || ssl->session == NULL) {
3352 return 0;
3353 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003356}
3357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003359{
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 if (ssl == NULL || ssl->session == NULL) {
3361 return NULL;
3362 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003363
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003365}
3366
Gilles Peskine449bd832023-01-11 14:50:10 +01003367const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003368{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3371 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003372 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003374 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003376 }
3377 }
3378#endif
3379
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003381 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003383 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003385 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003387 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003388}
3389
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003390#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3391
3392size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3393{
3394 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3395 size_t record_size_limit = max_len;
3396
3397 if (ssl->session != NULL &&
3398 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3399 ssl->session->record_size_limit < max_len) {
3400 record_size_limit = ssl->session->record_size_limit;
3401 }
3402
3403 // TODO: this is currently untested
3404 /* During a handshake, use the value being negotiated */
3405 if (ssl->session_negotiate != NULL &&
3406 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3407 ssl->session_negotiate->record_size_limit < max_len) {
3408 record_size_limit = ssl->session_negotiate->record_size_limit;
3409 }
3410
3411 return record_size_limit;
3412}
3413#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3414
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003415#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003416size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003417{
David Horstmann95d516f2021-05-04 18:36:56 +01003418 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003419 size_t read_mfl;
3420
Jerry Yuddda0502022-12-01 19:43:12 +08003421#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003422 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3424 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3425 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003426 }
Jerry Yuddda0502022-12-01 19:43:12 +08003427#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003428
3429 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 if (ssl->session_out != NULL) {
3431 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3432 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003433 max_len = read_mfl;
3434 }
3435 }
3436
Jerry Yuddda0502022-12-01 19:43:12 +08003437 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 if (ssl->session_negotiate != NULL) {
3439 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3440 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003441 max_len = read_mfl;
3442 }
3443 }
3444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003446}
3447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003449{
3450 size_t max_len;
3451
3452 /*
3453 * Assume mfl_code is correct since it was checked when set
3454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003456
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003457 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 if (ssl->session_out != NULL &&
3459 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3460 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003461 }
3462
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003463 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 if (ssl->session_negotiate != NULL &&
3465 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3466 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003467 }
3468
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003470}
3471#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3472
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003474size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003475{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003476 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003477 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3478 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3479 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3480 return 0;
3481 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3484 return ssl->mtu;
3485 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003486
Gilles Peskine449bd832023-01-11 14:50:10 +01003487 if (ssl->mtu == 0) {
3488 return ssl->handshake->mtu;
3489 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003490
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 return ssl->mtu < ssl->handshake->mtu ?
3492 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003493}
3494#endif /* MBEDTLS_SSL_PROTO_DTLS */
3495
Gilles Peskine449bd832023-01-11 14:50:10 +01003496int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003497{
3498 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3499
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003500#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003501 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003502 !defined(MBEDTLS_SSL_PROTO_DTLS)
3503 (void) ssl;
3504#endif
3505
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003506#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003510 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003512#endif
3513
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003514#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3515 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3516
3517 if (max_len > record_size_limit) {
3518 max_len = record_size_limit;
3519 }
3520#endif
3521
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003522 if (ssl->transform_out != NULL &&
3523 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003524 /*
3525 * In TLS 1.3 case, when records are protected, `max_len` as computed
3526 * above is the maximum length of the TLSInnerPlaintext structure that
3527 * along the plaintext payload contains the inner content type (one byte)
3528 * and some zero padding. Given the algorithm used for padding
3529 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3530 * the plaintext payload. Round down to a multiple of
3531 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3532 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003533 */
3534 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3535 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3536 }
3537
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003538#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003539 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3540 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3541 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003542 const size_t overhead = (size_t) ret;
3543
Gilles Peskine449bd832023-01-11 14:50:10 +01003544 if (ret < 0) {
3545 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003546 }
3547
Gilles Peskine449bd832023-01-11 14:50:10 +01003548 if (mtu <= overhead) {
3549 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3550 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3551 }
3552
3553 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003554 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003555 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003556 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003557#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003558
Hanno Becker0defedb2018-08-10 12:35:02 +01003559#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003560 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3561 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003562 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003563#endif
3564
Gilles Peskine449bd832023-01-11 14:50:10 +01003565 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003566}
3567
Gilles Peskine449bd832023-01-11 14:50:10 +01003568int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003569{
3570 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3571
3572#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3573 (void) ssl;
3574#endif
3575
3576#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003577 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003578
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003580 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003582#endif
3583
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003585}
3586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003588const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003589{
Gilles Peskine449bd832023-01-11 14:50:10 +01003590 if (ssl == NULL || ssl->session == NULL) {
3591 return NULL;
3592 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003593
Hanno Beckere6824572019-02-07 13:18:46 +00003594#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003595 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003596#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003598#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003599}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003600#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003603int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3604 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003605{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003606 int ret;
3607
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003609 dst == NULL ||
3610 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003611 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003613 }
3614
Hanno Beckere810bbc2021-05-14 16:01:05 +01003615 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3616 * idempotent: Each session can only be exported once.
3617 *
3618 * (This is in preparation for TLS 1.3 support where we will
3619 * need the ability to export multiple sessions (aka tickets),
3620 * which will be achieved by calling mbedtls_ssl_get_session()
3621 * multiple times until it fails.)
3622 *
3623 * Check whether we have already exported the current session,
3624 * and fail if so.
3625 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003626 if (ssl->session->exported == 1) {
3627 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3628 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003629
Gilles Peskine449bd832023-01-11 14:50:10 +01003630 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3631 if (ret != 0) {
3632 return ret;
3633 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003634
3635 /* Remember that we've exported the session. */
3636 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003638}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003640
Paul Bakker5121ce52009-01-03 21:22:43 +00003641/*
Hanno Beckera835da52019-05-16 12:39:07 +01003642 * Define ticket header determining Mbed TLS version
3643 * and structure of the ticket.
3644 */
3645
Hanno Becker94ef3b32019-05-16 12:50:45 +01003646/*
Hanno Becker50b59662019-05-28 14:30:45 +01003647 * Define bitflag determining compile-time settings influencing
3648 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003649 */
3650
Hanno Becker50b59662019-05-28 14:30:45 +01003651#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003652#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003653#else
Hanno Becker3e088662019-05-29 11:10:18 +01003654#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003655#endif /* MBEDTLS_HAVE_TIME */
3656
3657#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003658#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003659#else
Hanno Becker3e088662019-05-29 11:10:18 +01003660#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003661#endif /* MBEDTLS_X509_CRT_PARSE_C */
3662
3663#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003664#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003665#else
Hanno Becker3e088662019-05-29 11:10:18 +01003666#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003667#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3668
3669#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003670#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003671#else
Hanno Becker3e088662019-05-29 11:10:18 +01003672#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003673#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3674
Hanno Becker94ef3b32019-05-16 12:50:45 +01003675#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003676#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003677#else
Hanno Becker3e088662019-05-29 11:10:18 +01003678#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003679#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3680
Hanno Becker94ef3b32019-05-16 12:50:45 +01003681#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3682#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3683#else
3684#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3685#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3686
Hanno Becker3e088662019-05-29 11:10:18 +01003687#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3688#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3689#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3690#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003691#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3692#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003693
Hanno Becker50b59662019-05-28 14:30:45 +01003694#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003695 ((uint16_t) ( \
3696 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3697 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3698 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3699 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3700 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3701 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3702 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003703
Hanno Beckerf8787072019-05-16 12:41:07 +01003704static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003705 MBEDTLS_VERSION_MAJOR,
3706 MBEDTLS_VERSION_MINOR,
3707 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003708 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3709 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003710};
Hanno Beckera835da52019-05-16 12:39:07 +01003711
3712/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003713 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003714 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003715 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003716 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003717 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003718 * opaque mbedtls_version[3]; // library version: major, minor, patch
3719 * opaque session_format[2]; // library-version specific 16-bit field
3720 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003721 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003722 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003723 * Note: When updating the format, remember to keep
3724 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003725 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003726 * // In this version, `session_format` determines
3727 * // the setting of those compile-time
3728 * // configuration options which influence
3729 * // the structure of mbedtls_ssl_session.
3730 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003731 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003732 * // - TLS 1.2 (0x0303)
3733 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003734 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003735 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003736 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003737 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003738 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003739 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003740 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003741 *
3742 * };
3743 *
3744 * } serialized_session;
3745 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003746 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003747
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003748MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003749static int ssl_session_save(const mbedtls_ssl_session *session,
3750 unsigned char omit_header,
3751 unsigned char *buf,
3752 size_t buf_len,
3753 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003754{
3755 unsigned char *p = buf;
3756 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003757 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003758#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3759 size_t out_len;
3760 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3761#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 if (session == NULL) {
3763 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3764 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003765
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003767 /*
3768 * Add Mbed TLS version identifier
3769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003771
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 if (used <= buf_len) {
3773 memcpy(p, ssl_serialized_session_header,
3774 sizeof(ssl_serialized_session_header));
3775 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003776 }
3777 }
3778
3779 /*
3780 * TLS version identifier
3781 */
3782 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 if (used <= buf_len) {
3784 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003785 }
3786
3787 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003788 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003790#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003791 case MBEDTLS_SSL_VERSION_TLS1_2:
3792 used += ssl_tls12_session_save(session, p, remaining_len);
3793 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003794#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3795
Jerry Yu251a12e2022-07-13 15:15:48 +08003796#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003797 case MBEDTLS_SSL_VERSION_TLS1_3:
3798 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3799 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3800 return ret;
3801 }
3802 used += out_len;
3803 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003804#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3805
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 default:
3807 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003808 }
3809
3810 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 if (used > buf_len) {
3812 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3813 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003814
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003816}
3817
3818/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003819 * Public wrapper for ssl_session_save()
3820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003821int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3822 unsigned char *buf,
3823 size_t buf_len,
3824 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003825{
Gilles Peskine449bd832023-01-11 14:50:10 +01003826 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003827}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003828
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003829/*
3830 * Deserialize session, see mbedtls_ssl_session_save() for format.
3831 *
3832 * This internal version is wrapped by a public function that cleans up in
3833 * case of error, and has an extra option omit_header.
3834 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003836static int ssl_session_load(mbedtls_ssl_session *session,
3837 unsigned char omit_header,
3838 const unsigned char *buf,
3839 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003840{
3841 const unsigned char *p = buf;
3842 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003843 size_t remaining_len;
3844
3845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 if (session == NULL) {
3847 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3848 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003849
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003851 /*
3852 * Check Mbed TLS version identifier
3853 */
3854
Gilles Peskine449bd832023-01-11 14:50:10 +01003855 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003857 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003858
3859 if (memcmp(p, ssl_serialized_session_header,
3860 sizeof(ssl_serialized_session_header)) != 0) {
3861 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3862 }
3863 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003864 }
3865
3866 /*
3867 * TLS version identifier
3868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (1 > (size_t) (end - p)) {
3870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3871 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003872 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003873
3874 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003875 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01003876 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003877#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 case MBEDTLS_SSL_VERSION_TLS1_2:
3879 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003880#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3881
Jerry Yu438ddd82022-07-07 06:55:50 +00003882#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 case MBEDTLS_SSL_VERSION_TLS1_3:
3884 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003885#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3886
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 default:
3888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003889 }
3890}
3891
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003892/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003893 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003895int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3896 const unsigned char *buf,
3897 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003898{
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003900
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 if (ret != 0) {
3902 mbedtls_ssl_session_free(session);
3903 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003904
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003906}
3907
3908/*
Paul Bakker1961b702013-01-25 14:49:24 +01003909 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003910 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003912static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003913{
3914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3915
Ronald Cron66dbf912022-02-02 15:33:46 +01003916 /*
3917 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003918 * that were written into the output buffer by the previous handshake step,
3919 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003920 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3921 * We proceed to the next handshake step only when all data from the
3922 * previous one have been sent to the peer, thus we make sure that this is
3923 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3924 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3925 * we have to wait before to go ahead.
3926 * In the case of TLS 1.3, handshake step handlers do not send data to the
3927 * peer. Data are only sent here and through
3928 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003929 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3932 return ret;
3933 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003934
3935#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3937 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3938 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3939 return ret;
3940 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003941 }
3942#endif /* MBEDTLS_SSL_PROTO_DTLS */
3943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003945}
3946
Gilles Peskine449bd832023-01-11 14:50:10 +01003947int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003948{
Hanno Becker41934dd2021-08-07 19:13:43 +01003949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003950
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003952 ssl->conf == NULL ||
3953 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003954 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003956 }
3957
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 ret = ssl_prepare_handshake_step(ssl);
3959 if (ret != 0) {
3960 return ret;
3961 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003962
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 ret = mbedtls_ssl_handle_pending_alert(ssl);
3964 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003965 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 }
Jerry Yue7047812021-09-13 19:26:39 +08003967
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003968 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3969 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3970 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003972#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3974 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003975 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003978 case MBEDTLS_SSL_HELLO_REQUEST:
3979 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003980 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003981 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003982
Ronald Cron9f0fba32022-02-10 16:45:15 +01003983 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003985 break;
3986
3987 default:
3988#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3990 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3991 } else {
3992 ret = mbedtls_ssl_handshake_client_step(ssl);
3993 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003994#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003995 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003996#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003998#endif
3999 }
Jerry Yub9930e72021-08-06 17:11:51 +08004000 }
Ronald Cron6291b232023-03-08 15:51:25 +01004001#endif /* MBEDTLS_SSL_CLI_C */
4002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004003#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004005#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4006 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004008 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 ret = mbedtls_ssl_handshake_server_step(ssl);
4010 }
Ronald Cron6291b232023-03-08 15:51:25 +01004011#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4012 ret = mbedtls_ssl_handshake_server_step(ssl);
4013#else
4014 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004015#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004016 }
4017#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004020 /* handshake_step return error. And it is same
4021 * with alert_reason.
4022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (ssl->send_alert) {
4024 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004025 goto cleanup;
4026 }
4027 }
4028
4029cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004031}
4032
4033/*
4034 * Perform the SSL handshake
4035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004036int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004037{
4038 int ret = 0;
4039
Hanno Beckera817ea42020-10-20 15:20:23 +01004040 /* Sanity checks */
4041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (ssl == NULL || ssl->conf == NULL) {
4043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4044 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004045
Hanno Beckera817ea42020-10-20 15:20:23 +01004046#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4048 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4049 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4050 "mbedtls_ssl_set_timer_cb() for DTLS"));
4051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004052 }
4053#endif /* MBEDTLS_SSL_PROTO_DTLS */
4054
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004056
Hanno Beckera817ea42020-10-20 15:20:23 +01004057 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4059 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004062 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 }
Paul Bakker1961b702013-01-25 14:49:24 +01004064 }
4065
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004069}
4070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004071#if defined(MBEDTLS_SSL_RENEGOTIATION)
4072#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004073/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004074 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004075 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004076MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004077static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004078{
Janos Follath865b3eb2019-12-16 11:46:15 +00004079 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004082
4083 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004084 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4085 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4088 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4089 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004090 }
4091
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004093
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004095}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004096#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004097
4098/*
4099 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004100 * - any side: calling mbedtls_ssl_renegotiate(),
4101 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4102 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004103 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004104 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004105 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004106 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004107int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004108{
Janos Follath865b3eb2019-12-16 11:46:15 +00004109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if ((ret = ssl_handshake_init(ssl)) != 0) {
4114 return ret;
4115 }
Paul Bakker48916f92012-09-16 19:57:18 +00004116
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004117 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4118 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004119#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4121 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4122 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004123 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004125 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004127 }
4128#endif
4129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4131 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4135 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004136 }
4137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004141}
4142
4143/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004144 * Renegotiate current connection on client,
4145 * or request renegotiation on server
4146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004147int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004148{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004149 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if (ssl == NULL || ssl->conf == NULL) {
4152 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4153 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004155#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004156 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4158 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4160 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004162 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004163
4164 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (ssl->out_left != 0) {
4166 return mbedtls_ssl_flush_output(ssl);
4167 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004168
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004170 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004171#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004174 /*
4175 * On client, either start the renegotiation process or,
4176 * if already in progress, continue the handshake
4177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4179 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4180 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004181 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004182
4183 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4184 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4185 return ret;
4186 }
4187 } else {
4188 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4189 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4190 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004191 }
4192 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004194
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004196}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004197#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004198
Gilles Peskine449bd832023-01-11 14:50:10 +01004199void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004200{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004201 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004204 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004206
Valerio Setti6f0441d2023-07-03 12:11:36 +02004207#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004208#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 if (ssl->handshake->group_list_heap_allocated) {
4210 mbedtls_free((void *) handshake->group_list);
4211 }
Brett Warrene0edc842021-08-17 09:53:13 +01004212 handshake->group_list = NULL;
4213#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004214#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004215
Ronald Crone68ab4f2022-10-05 12:46:29 +02004216#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004217#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 if (ssl->handshake->sig_algs_heap_allocated) {
4219 mbedtls_free((void *) handshake->sig_algs);
4220 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004221 handshake->sig_algs = NULL;
4222#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004223#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (ssl->handshake->certificate_request_context) {
4225 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004226 }
4227#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004228#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004229
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004230#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4232 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004233 handshake->async_in_progress = 0;
4234 }
4235#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4236
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004237#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004238#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004240#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004241 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004242#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004243#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004244#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004245#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004247#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004248 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004249#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004250#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004252#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004254#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004255#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004256 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004258#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004259
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004260#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004261#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004263 /*
4264 * Opaque keys are not stored in the handshake's data and it's the user
4265 * responsibility to destroy them. Clear ones, instead, are created by
4266 * the TLS library and should be destroyed at the same level
4267 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4269 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004270 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004271 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4272#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004274#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004275#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004277 handshake->ecjpake_cache = NULL;
4278 handshake->ecjpake_cache_len = 0;
4279#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004280#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004281
Valerio Setti7aeec542023-07-05 18:57:21 +02004282#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004283 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004284 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004285 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004287#endif
4288
Ronald Cron73fe8df2022-10-05 14:31:43 +02004289#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004292 /* The maintenance of the external PSK key slot is the
4293 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (ssl->handshake->psk_opaque_is_internal) {
4295 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004296 ssl->handshake->psk_opaque_is_internal = 0;
4297 }
4298 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4299 }
Neil Armstronge952a302022-05-03 10:22:14 +02004300#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004302 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004303 }
Neil Armstronge952a302022-05-03 10:22:14 +02004304#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004305#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004307#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4308 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004309 /*
4310 * Free only the linked list wrapper, not the keys themselves
4311 * since the belong to the SNI callback
4312 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004314#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004315
Gilles Peskineeccd8882020-03-10 12:19:08 +01004316#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4318 if (handshake->ecrs_peer_cert != NULL) {
4319 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4320 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004321 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004322#endif
4323
Hanno Becker75173122019-02-06 16:18:31 +00004324#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4325 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004327#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4328
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004329#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4331 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004332#endif /* MBEDTLS_SSL_CLI_C &&
4333 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004334
4335#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 mbedtls_ssl_flight_free(handshake->flight);
4337 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004338#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004339
Valerio Settiea59c432023-07-25 11:14:03 +02004340#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004341 if (handshake->xxdh_psa_privkey_is_external == 0) {
4342 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 }
Valerio Settiea59c432023-07-25 11:14:03 +02004344#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004345
Ronald Cron6f135e12021-12-08 16:57:54 +01004346#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 mbedtls_ssl_transform_free(handshake->transform_handshake);
4348 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004349#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4351 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004352#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004353#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004354
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004355
4356#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4357 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4358 * processes datagrams and the fact that a datagram is allowed to have
4359 * several records in it, it is possible that the I/O buffers are not
4360 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4362 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004363#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004364
Jerry Yuba9c7272021-10-30 11:54:10 +08004365 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 mbedtls_platform_zeroize(handshake,
4367 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004368}
4369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004371{
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004373 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004376#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004378#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004379
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004380#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004381#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4382 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004384#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004386#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004389}
4390
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004391#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004392
4393#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4394#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4395#else
4396#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4397#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4398
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004399#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004400
4401#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4402#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4403#else
4404#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4405#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4406
4407#if defined(MBEDTLS_SSL_ALPN)
4408#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4409#else
4410#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4411#endif /* MBEDTLS_SSL_ALPN */
4412
4413#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4414#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4415#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4416#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4417
4418#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 ((uint32_t) ( \
4420 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4421 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4422 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4423 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4424 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4425 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4426 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4427 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004428
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004429static unsigned char ssl_serialized_context_header[] = {
4430 MBEDTLS_VERSION_MAJOR,
4431 MBEDTLS_VERSION_MINOR,
4432 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4434 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4435 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4436 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4437 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004438};
4439
Paul Bakker5121ce52009-01-03 21:22:43 +00004440/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004441 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004442 *
4443 * The format of the serialized data is:
4444 * (in the presentation language of TLS, RFC 8446 section 3)
4445 *
4446 * // header
4447 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004448 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004449 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004450 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004451 * Note: When updating the format, remember to keep these
4452 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004453 *
4454 * // session sub-structure
4455 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4456 * // transform sub-structure
4457 * uint8 random[64]; // ServerHello.random+ClientHello.random
4458 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4459 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4460 * // fields from ssl_context
4461 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4462 * uint64 in_window_top; // DTLS: last validated record seq_num
4463 * uint64 in_window; // DTLS: bitmask for replay protection
4464 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4465 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4466 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4467 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4468 *
4469 * Note that many fields of the ssl_context or sub-structures are not
4470 * serialized, as they fall in one of the following categories:
4471 *
4472 * 1. forced value (eg in_left must be 0)
4473 * 2. pointer to dynamically-allocated memory (eg session, transform)
4474 * 3. value can be re-derived from other data (eg session keys from MS)
4475 * 4. value was temporary (eg content of input buffer)
4476 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4479 unsigned char *buf,
4480 size_t buf_len,
4481 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004482{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004483 unsigned char *p = buf;
4484 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004485 size_t session_len;
4486 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004487
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004488 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004489 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4490 * this function's documentation.
4491 *
4492 * These are due to assumptions/limitations in the implementation. Some of
4493 * them are likely to stay (no handshake in progress) some might go away
4494 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004495 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004496 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4498 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4499 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004500 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 if (ssl->handshake != NULL) {
4502 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004504 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004505 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (ssl->transform == NULL || ssl->session == NULL) {
4507 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4508 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004509 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004510 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (mbedtls_ssl_check_pending(ssl) != 0) {
4512 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4513 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004514 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (ssl->out_left != 0) {
4516 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4517 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004518 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004519 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4521 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4522 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004523 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004524 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4526 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004528 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004529 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4531 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4532 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004533 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004534 /* Renegotiation must not be enabled */
4535#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4537 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4538 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004539 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004540#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004541
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004542 /*
4543 * Version and format identifier
4544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (used <= buf_len) {
4548 memcpy(p, ssl_serialized_context_header,
4549 sizeof(ssl_serialized_context_header));
4550 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004551 }
4552
4553 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004554 * Session (length + data)
4555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4557 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4558 return ret;
4559 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004560
4561 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (used <= buf_len) {
4563 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004564 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004565
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 ret = ssl_session_save(ssl->session, 1,
4567 p, session_len, &session_len);
4568 if (ret != 0) {
4569 return ret;
4570 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004571
4572 p += session_len;
4573 }
4574
4575 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004576 * Transform
4577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 used += sizeof(ssl->transform->randbytes);
4579 if (used <= buf_len) {
4580 memcpy(p, ssl->transform->randbytes,
4581 sizeof(ssl->transform->randbytes));
4582 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004583 }
4584
4585#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004586 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004588 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004590 p += ssl->transform->in_cid_len;
4591
4592 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004594 p += ssl->transform->out_cid_len;
4595 }
4596#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4597
4598 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004599 * Saved fields from top-level ssl_context structure
4600 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004601 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (used <= buf_len) {
4603 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004604 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004605 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004606
4607#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4608 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if (used <= buf_len) {
4610 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004611 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004614 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004615 }
4616#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4617
4618#if defined(MBEDTLS_SSL_PROTO_DTLS)
4619 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004621 *p++ = ssl->disable_datagram_packing;
4622 }
4623#endif /* MBEDTLS_SSL_PROTO_DTLS */
4624
Jerry Yuae0b2e22021-10-08 15:21:19 +08004625 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 if (used <= buf_len) {
4627 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004628 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004629 }
4630
4631#if defined(MBEDTLS_SSL_PROTO_DTLS)
4632 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (used <= buf_len) {
4634 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004635 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004636 }
4637#endif /* MBEDTLS_SSL_PROTO_DTLS */
4638
4639#if defined(MBEDTLS_SSL_ALPN)
4640 {
4641 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004643 : 0;
4644
4645 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004647 *p++ = alpn_len;
4648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (ssl->alpn_chosen != NULL) {
4650 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004651 p += alpn_len;
4652 }
4653 }
4654 }
4655#endif /* MBEDTLS_SSL_ALPN */
4656
4657 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004658 * Done
4659 */
4660 *olen = used;
4661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if (used > buf_len) {
4663 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4664 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004665
Gilles Peskine449bd832023-01-11 14:50:10 +01004666 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004669}
4670
4671/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004672 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004673 *
4674 * This internal version is wrapped by a public function that cleans up in
4675 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004676 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004677MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004678static int ssl_context_load(mbedtls_ssl_context *ssl,
4679 const unsigned char *buf,
4680 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004681{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004682 const unsigned char *p = buf;
4683 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004684 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004685 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004687 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004688#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004689
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004690 /*
4691 * The context should have been freshly setup or reset.
4692 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004693 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004694 * renegotiating, or if the user mistakenly loaded a session first.)
4695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4697 ssl->session != NULL) {
4698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004699 }
4700
4701 /*
4702 * We can't check that the config matches the initial one, but we can at
4703 * least check it matches the requirements for serializing.
4704 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004705 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004706#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004707 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004708#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004709 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4710 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4711 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4712 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004714 }
4715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004717
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004718 /*
4719 * Check version identifier
4720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004723 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004724
4725 if (memcmp(p, ssl_serialized_context_header,
4726 sizeof(ssl_serialized_context_header)) != 0) {
4727 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4728 }
4729 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004730
4731 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004732 * Session
4733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if ((size_t) (end - p) < 4) {
4735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4736 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004737
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004738 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004739 p += 4;
4740
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004741 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004742 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004743 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004744 ssl->session_in = ssl->session;
4745 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004746 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004747
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 if ((size_t) (end - p) < session_len) {
4749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4750 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004751
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 ret = ssl_session_load(ssl->session, 1, p, session_len);
4753 if (ret != 0) {
4754 mbedtls_ssl_session_free(ssl->session);
4755 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004756 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004757
4758 p += session_len;
4759
4760 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004761 * Transform
4762 */
4763
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004764 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004765 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004766#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004767 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004768 ssl->transform_in = ssl->transform;
4769 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004770 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004771#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004772
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004773#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4775 if (prf_func == NULL) {
4776 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4777 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004778
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004779 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4782 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004783
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 ret = ssl_tls12_populate_transform(ssl->transform,
4785 ssl->session->ciphersuite,
4786 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004787#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004789#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 prf_func,
4791 p, /* currently pointing to randbytes */
4792 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4793 ssl->conf->endpoint,
4794 ssl);
4795 if (ret != 0) {
4796 return ret;
4797 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004798#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004800
4801#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4802 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if ((size_t) (end - p) < 1) {
4804 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4805 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004806
4807 ssl->transform->in_cid_len = *p++;
4808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4810 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4811 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004814 p += ssl->transform->in_cid_len;
4815
4816 ssl->transform->out_cid_len = *p++;
4817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4819 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4820 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004823 p += ssl->transform->out_cid_len;
4824#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4825
4826 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004827 * Saved fields from top-level ssl_context structure
4828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if ((size_t) (end - p) < 4) {
4830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4831 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004832
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004833 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004834 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004835
4836#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 if ((size_t) (end - p) < 16) {
4838 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4839 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004840
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004841 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004842 p += 8;
4843
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004844 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 p += 8;
4846#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4847
4848#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if ((size_t) (end - p) < 1) {
4850 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4851 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004852
4853 ssl->disable_datagram_packing = *p++;
4854#endif /* MBEDTLS_SSL_PROTO_DTLS */
4855
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4857 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4858 }
4859 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4860 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004861
4862#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if ((size_t) (end - p) < 2) {
4864 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4865 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004866
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004867 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004868 p += 2;
4869#endif /* MBEDTLS_SSL_PROTO_DTLS */
4870
4871#if defined(MBEDTLS_SSL_ALPN)
4872 {
4873 uint8_t alpn_len;
4874 const char **cur;
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if ((size_t) (end - p) < 1) {
4877 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4878 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879
4880 alpn_len = *p++;
4881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004883 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4885 if (strlen(*cur) == alpn_len &&
4886 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004887 ssl->alpn_chosen = *cur;
4888 break;
4889 }
4890 }
4891 }
4892
4893 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4895 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4896 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004897
4898 p += alpn_len;
4899 }
4900#endif /* MBEDTLS_SSL_ALPN */
4901
4902 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004903 * Forced fields from top-level ssl_context structure
4904 *
4905 * Most of them already set to the correct value by mbedtls_ssl_init() and
4906 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4907 */
4908 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004909 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004910
Hanno Becker361b10d2019-08-30 10:42:49 +01004911 /* Adjust pointers for header fields of outgoing records to
4912 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004914
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004915#if defined(MBEDTLS_SSL_PROTO_DTLS)
4916 ssl->in_epoch = 1;
4917#endif
4918
4919 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4920 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004921 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4922 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (ssl->handshake != NULL) {
4924 mbedtls_ssl_handshake_free(ssl);
4925 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004926 ssl->handshake = NULL;
4927 }
4928
4929 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004930 * Done - should have consumed entire buffer
4931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (p != end) {
4933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4934 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004935
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004937}
4938
4939/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004940 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004942int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4943 const unsigned char *buf,
4944 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004945{
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if (ret != 0) {
4949 mbedtls_ssl_free(context);
4950 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004954#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004955
4956/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004957 * Free an SSL context
4958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004959void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004960{
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004962 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004968#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4969 size_t out_buf_len = ssl->out_buf_len;
4970#else
4971 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4972#endif
4973
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004974 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004975 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004976 }
4977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004979#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4980 size_t in_buf_len = ssl->in_buf_len;
4981#else
4982 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4983#endif
4984
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004985 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004986 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004987 }
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (ssl->transform) {
4990 mbedtls_ssl_transform_free(ssl->transform);
4991 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004992 }
4993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if (ssl->handshake) {
4995 mbedtls_ssl_handshake_free(ssl);
4996 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004997
4998#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5000 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005001#endif
5002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 mbedtls_ssl_session_free(ssl->session_negotiate);
5004 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005005 }
5006
Ronald Cron6f135e12021-12-08 16:57:54 +01005007#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 mbedtls_ssl_transform_free(ssl->transform_application);
5009 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005010#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 if (ssl->session) {
5013 mbedtls_ssl_session_free(ssl->session);
5014 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005015 }
5016
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005017#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005019 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005020 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005021#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005022
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005023#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005025#endif
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005028
Paul Bakker86f04f42013-02-14 11:20:09 +01005029 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005031}
5032
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005033/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005034 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005036void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005037{
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005039}
5040
Gilles Peskineae270bf2021-06-02 00:05:29 +02005041/* The selection should be the same as mbedtls_x509_crt_profile_default in
5042 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005043 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005044 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005045 * about this list.
5046 */
Brett Warrene0edc842021-08-17 09:53:13 +01005047static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005048#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005049 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005050#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005051#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005052 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005053#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005054#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005055 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005056#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005057#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005058 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005059#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005060#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005061 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005062#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005063#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005064 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005065#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005066#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005067 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005068#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005069#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005070 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005071#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005072#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005073 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5074 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5075 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5076 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5077 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5078#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005079 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005080};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005081
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005082static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005083 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5084 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5085 0
5086};
5087
Ronald Crone68ab4f2022-10-05 12:46:29 +02005088#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005089
Jerry Yu909df7b2022-01-22 11:56:27 +08005090/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005091 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005092 * rules SHOULD be upheld.
5093 * - No duplicate entries.
5094 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005095 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005096 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005097 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005098static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005099
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005100#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005101 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005102 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005103 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005104 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5105#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005106
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005107#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005108 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005109 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005110 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005111 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5112#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005113
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005114#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005115 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005116 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005117 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005118 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5119#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005120
Yanray Wang1136fad2023-11-22 16:54:31 +08005121#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005122 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005123#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005124
Yanray Wang1136fad2023-11-22 16:54:31 +08005125#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005126 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005127#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005128
Yanray Wang1136fad2023-11-22 16:54:31 +08005129#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005130 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005131#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005132
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005133#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005134 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005135#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005136
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005137#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005138 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005139#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005140
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005141#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005142 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005143#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005144
Gabor Mezei15b95a62022-05-09 16:37:58 +02005145 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005146};
5147
5148/* NOTICE: see above */
5149#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5150static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005151
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005152#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005153#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005155#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005156#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5157 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005158#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005159#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005161#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005162#endif /* MBEDTLS_MD_CAN_SHA512 */
5163
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005164#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005165#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005167#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005168#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5169 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005170#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005171#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005173#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005174#endif /* MBEDTLS_MD_CAN_SHA384 */
5175
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005176#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005177#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005179#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005180#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5181 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005182#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005183#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005185#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005186#endif /* MBEDTLS_MD_CAN_SHA256 */
5187
Gabor Mezei15b95a62022-05-09 16:37:58 +02005188 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005189};
5190#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005191
Jerry Yu909df7b2022-01-22 11:56:27 +08005192/* NOTICE: see above */
5193static uint16_t ssl_preset_suiteb_sig_algs[] = {
5194
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005195#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005196 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005197 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005198 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005199 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5200#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005201
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005202#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005203 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005204 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005205 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005206 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5207#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005208
Gabor Mezei15b95a62022-05-09 16:37:58 +02005209 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005210};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005211
Jerry Yu909df7b2022-01-22 11:56:27 +08005212/* NOTICE: see above */
5213#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5214static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005215
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005216#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005217#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005219#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005220#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005221
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005222#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005223#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005225#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005226#endif /* MBEDTLS_MD_CAN_SHA384 */
5227
Gabor Mezei15b95a62022-05-09 16:37:58 +02005228 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005229};
Jerry Yu909df7b2022-01-22 11:56:27 +08005230#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5231
Ronald Crone68ab4f2022-10-05 12:46:29 +02005232#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005233
Brett Warrene0edc842021-08-17 09:53:13 +01005234static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005235#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005236 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005237#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005238#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005239 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005240#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005241 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005242};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005243
Ronald Crone68ab4f2022-10-05 12:46:29 +02005244#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005245/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005246 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005247MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005248static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005249{
5250 size_t i, j;
5251 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5254 for (j = 0; j < i; j++) {
5255 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005256 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 }
5258 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5259 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5260 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005261 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005262 }
5263 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005265}
5266
Ronald Crone68ab4f2022-10-05 12:46:29 +02005267#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005268
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005269/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005270 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005272int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5273 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005274{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005275#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005276 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005277#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005278
Ronald Crone68ab4f2022-10-05 12:46:29 +02005279#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5281 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5282 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005283 }
5284
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5286 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5287 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005288 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005289
5290#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5292 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5293 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005294 }
5295
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5297 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5298 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005299 }
5300#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005301#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005302
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005303 /* Use the functions here so that they are covered in tests,
5304 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 mbedtls_ssl_conf_endpoint(conf, endpoint);
5306 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005307
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005308 /*
5309 * Things that are common to all presets
5310 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005311#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005313 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5314#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5315 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5316#endif
5317 }
5318#endif
5319
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005320#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5321 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5322#endif
5323
5324#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5325 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5326#endif
5327
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005328#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005329 conf->f_cookie_write = ssl_cookie_write_dummy;
5330 conf->f_cookie_check = ssl_cookie_check_dummy;
5331#endif
5332
5333#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5334 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5335#endif
5336
Janos Follath088ce432017-04-10 12:42:31 +01005337#if defined(MBEDTLS_SSL_SRV_C)
5338 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005339 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005340#endif
5341
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005342#if defined(MBEDTLS_SSL_PROTO_DTLS)
5343 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5344 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5345#endif
5346
5347#if defined(MBEDTLS_SSL_RENEGOTIATION)
5348 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 memset(conf->renego_period, 0x00, 2);
5350 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005351#endif
5352
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005353#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005355 const unsigned char dhm_p[] =
5356 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5357 const unsigned char dhm_g[] =
5358 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5361 dhm_p, sizeof(dhm_p),
5362 dhm_g, sizeof(dhm_g))) != 0) {
5363 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005364 }
5365 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005366#endif
5367
Ronald Cron6f135e12021-12-08 16:57:54 +01005368#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005369
5370#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005371 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005372#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005373 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005374#endif
5375#endif /* MBEDTLS_SSL_EARLY_DATA */
5376
Jerry Yud0766ec2022-09-22 10:46:57 +08005377#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005378 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005380#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005381 /*
5382 * Allow all TLS 1.3 key exchange modes by default.
5383 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005384 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005385#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005386
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005388#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005389 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005390 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005391#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005395#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005396 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5397 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005398#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5399 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5400 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5401#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5402 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5403 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5404#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005406#endif
5407 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005408
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005409 /*
5410 * Preset-specific defaults
5411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005413 /*
5414 * NSA Suite B
5415 */
5416 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005417
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005418 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005419
5420#if defined(MBEDTLS_X509_CRT_PARSE_C)
5421 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005422#endif
5423
Ronald Crone68ab4f2022-10-05 12:46:29 +02005424#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005425#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005427 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005429#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005431#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005432
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005433#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005434 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005435#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005436 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005437 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005438
5439 /*
5440 * Default
5441 */
5442 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005443
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005444 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005445
5446#if defined(MBEDTLS_X509_CRT_PARSE_C)
5447 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5448#endif
5449
Ronald Crone68ab4f2022-10-05 12:46:29 +02005450#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005451#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005453 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005457#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005458
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005459#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005460 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005461#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005462 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005463
5464#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5465 conf->dhm_min_bitlen = 1024;
5466#endif
5467 }
5468
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005470}
5471
5472/*
5473 * Free mbedtls_ssl_config
5474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005475void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005476{
5477#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 mbedtls_mpi_free(&conf->dhm_P);
5479 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005480#endif
5481
Ronald Cron73fe8df2022-10-05 14:31:43 +02005482#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005483#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005485 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5486 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005487#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005489 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005490 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005491 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005492 }
5493
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005495 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005496 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005497 conf->psk_identity_len = 0;
5498 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005499#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005500
5501#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005503#endif
5504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005506}
5507
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005508#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005509 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005510/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005513unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005514{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5517 return MBEDTLS_SSL_SIG_RSA;
5518 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005519#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005520#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5522 return MBEDTLS_SSL_SIG_ECDSA;
5523 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005524#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005526}
5527
Gilles Peskine449bd832023-01-11 14:50:10 +01005528unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005529{
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005531 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005533 case MBEDTLS_PK_ECDSA:
5534 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005536 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005538 }
5539}
5540
Gilles Peskine449bd832023-01-11 14:50:10 +01005541mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005542{
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005544#if defined(MBEDTLS_RSA_C)
5545 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005547#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005548#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005551#endif
5552 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005554 }
5555}
Valerio Settie9646ec2023-08-02 20:02:28 +02005556#endif /* MBEDTLS_PK_C &&
5557 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005558
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005559/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005560 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005561 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005562mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005563{
Gilles Peskine449bd832023-01-11 14:50:10 +01005564 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005565#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005568#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005569#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005572#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005573#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005574 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005576#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005577#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005578 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005580#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005581#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005584#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005585#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005588#endif
5589 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005591 }
5592}
5593
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005594/*
5595 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005597unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005598{
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005600#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005601 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005603#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005604#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005605 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005607#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005608#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005609 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005611#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005612#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005613 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005615#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005616#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005617 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005619#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005620#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005621 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005623#endif
5624 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005626 }
5627}
5628
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005629/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005630 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005631 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005633int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005634{
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 if (group_list == NULL) {
5638 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005639 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005640
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 for (; *group_list != 0; group_list++) {
5642 if (*group_list == tls_id) {
5643 return 0;
5644 }
5645 }
5646
5647 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005648}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005649
Valerio Setti49e69072023-06-27 17:27:51 +02005650#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005651/*
5652 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005654int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005655{
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005657
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005659 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005663}
Valerio Setti49e69072023-06-27 17:27:51 +02005664#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005665
Valerio Setti18c9fed2022-12-30 17:44:24 +01005666static const struct {
5667 uint16_t tls_id;
5668 mbedtls_ecp_group_id ecp_group_id;
5669 psa_ecc_family_t psa_family;
5670 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005671} tls_id_match_table[] =
5672{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005673#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005674 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005675#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005676#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005677 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005678#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005679#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005680 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005681#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005682#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005683 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005684#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005685#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005686 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005687#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005688#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005689 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005690#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005691#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005692 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005693#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005694#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005695 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005696#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005697#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005698 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005699#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005700#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005701 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005702#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005703#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005704 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005705#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005706#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005707 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005708#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005709#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005710 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005711#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005712 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005713};
5714
Gilles Peskine449bd832023-01-11 14:50:10 +01005715int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005716 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005718{
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5720 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005721 if (type != NULL) {
5722 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 }
5724 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005725 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005727 return PSA_SUCCESS;
5728 }
5729 }
5730
5731 return PSA_ERROR_NOT_SUPPORTED;
5732}
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005735{
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5737 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005738 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005740 }
5741
5742 return MBEDTLS_ECP_DP_NONE;
5743}
5744
Gilles Peskine449bd832023-01-11 14:50:10 +01005745uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005746{
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5748 i++) {
5749 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005750 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005752 }
5753
5754 return 0;
5755}
5756
Valerio Setti67419f02023-01-04 16:12:42 +01005757#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005758static const struct {
5759 uint16_t tls_id;
5760 const char *name;
5761} tls_id_curve_name_table[] =
5762{
Valerio Setti54e23792023-07-07 10:49:27 +02005763 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5764 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5765 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5766 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5767 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5768 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5769 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5770 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5771 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5772 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5773 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5774 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5775 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005776 { 0, NULL },
5777};
5778
Gilles Peskine449bd832023-01-11 14:50:10 +01005779const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005780{
Valerio Settiacd32c02023-06-29 18:06:29 +02005781 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5782 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5783 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005785 }
5786
5787 return NULL;
5788}
Valerio Setti67419f02023-01-04 16:12:42 +01005789#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005792int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5793 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5794 int cert_endpoint,
5795 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005796{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005797 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005798 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005799 const char *ext_oid;
5800 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005803 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005805 case MBEDTLS_KEY_EXCHANGE_RSA:
5806 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005807 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005808 break;
5809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005810 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5811 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5812 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5813 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005814 break;
5815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005816 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5817 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005818 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005819 break;
5820
5821 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005822 case MBEDTLS_KEY_EXCHANGE_NONE:
5823 case MBEDTLS_KEY_EXCHANGE_PSK:
5824 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5825 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005826 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005827 usage = 0;
5828 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005830 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5831 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005832 }
5833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005835 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005836 ret = -1;
5837 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005840 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5842 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005843 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005845 }
5846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005848 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005849 ret = -1;
5850 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005853}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005854#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005855
Jerry Yu148165c2021-09-24 23:20:59 +08005856#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005857int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5858 const mbedtls_md_type_t md,
5859 unsigned char *dst,
5860 size_t dst_len,
5861 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005862{
Ronald Cronf6893e12022-01-07 22:09:01 +01005863 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5864 psa_hash_operation_t *hash_operation_to_clone;
5865 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5866
Jerry Yu148165c2021-09-24 23:20:59 +08005867 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005870#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 case MBEDTLS_MD_SHA384:
5872 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5873 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005874#endif
5875
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005876#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 case MBEDTLS_MD_SHA256:
5878 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5879 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005880#endif
5881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 default:
5883 goto exit;
5884 }
5885
5886 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5887 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005888 goto exit;
5889 }
5890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5892 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005893 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005895
5896exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005897#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5898 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005899 (void) ssl;
5900#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005901 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005902}
5903#else /* MBEDTLS_USE_PSA_CRYPTO */
5904
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005905#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005906MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005907static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5908 unsigned char *dst,
5909 size_t dst_len,
5910 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005911{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005912 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005913 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005914
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 if (dst_len < 48) {
5916 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5917 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005918
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005919 mbedtls_md_init(&sha384);
5920 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005921 if (ret != 0) {
5922 goto exit;
5923 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005924 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005925 if (ret != 0) {
5926 goto exit;
5927 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005928
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005929 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005930 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005931 goto exit;
5932 }
5933
5934 *olen = 48;
5935
5936exit:
5937
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005938 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005940}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005941#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005942
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005943#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005944MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005945static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5946 unsigned char *dst,
5947 size_t dst_len,
5948 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005949{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005950 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005951 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 if (dst_len < 32) {
5954 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5955 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005956
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005957 mbedtls_md_init(&sha256);
5958 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5959 if (ret != 0) {
5960 goto exit;
5961 }
5962 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5963 if (ret != 0) {
5964 goto exit;
5965 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005966
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005967 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005969 goto exit;
5970 }
5971
5972 *olen = 32;
5973
5974exit:
5975
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005976 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005978}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005979#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5982 const mbedtls_md_type_t md,
5983 unsigned char *dst,
5984 size_t dst_len,
5985 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005986{
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005988
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005989#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 case MBEDTLS_MD_SHA384:
5991 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005992#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005993
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005994#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 case MBEDTLS_MD_SHA256:
5996 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005997#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006000#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6001 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 (void) ssl;
6003 (void) dst;
6004 (void) dst_len;
6005 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006006#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006008 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006010}
XiaokangQian647719a2021-12-07 09:16:29 +00006011
Jerry Yu148165c2021-09-24 23:20:59 +08006012#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006013
Ronald Crone68ab4f2022-10-05 12:46:29 +02006014#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006015/* mbedtls_ssl_parse_sig_alg_ext()
6016 *
6017 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6018 * value (TLS 1.3 RFC8446):
6019 * enum {
6020 * ....
6021 * ecdsa_secp256r1_sha256( 0x0403 ),
6022 * ecdsa_secp384r1_sha384( 0x0503 ),
6023 * ecdsa_secp521r1_sha512( 0x0603 ),
6024 * ....
6025 * } SignatureScheme;
6026 *
6027 * struct {
6028 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6029 * } SignatureSchemeList;
6030 *
6031 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6032 * value (TLS 1.2 RFC5246):
6033 * enum {
6034 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6035 * sha512(6), (255)
6036 * } HashAlgorithm;
6037 *
6038 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6039 * SignatureAlgorithm;
6040 *
6041 * struct {
6042 * HashAlgorithm hash;
6043 * SignatureAlgorithm signature;
6044 * } SignatureAndHashAlgorithm;
6045 *
6046 * SignatureAndHashAlgorithm
6047 * supported_signature_algorithms<2..2^16-2>;
6048 *
6049 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6050 * generalization of the TLS 1.2 signature algorithm extension.
6051 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6052 * `SignatureScheme` field of TLS 1.3
6053 *
6054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006055int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6056 const unsigned char *buf,
6057 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006058{
6059 const unsigned char *p = buf;
6060 size_t supported_sig_algs_len = 0;
6061 const unsigned char *supported_sig_algs_end;
6062 uint16_t sig_alg;
6063 uint32_t common_idx = 0;
6064
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6066 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006067 p += 2;
6068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 memset(ssl->handshake->received_sig_algs, 0,
6070 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006073 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 while (p < supported_sig_algs_end) {
6075 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6076 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006077 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6079 sig_alg,
6080 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006081#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6083 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6084 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006085 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006086 }
6087#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6090 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006093 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6094 common_idx += 1;
6095 }
6096 }
6097 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 if (p != end) {
6099 MBEDTLS_SSL_DEBUG_MSG(1,
6100 ("Signature algorithms extension length misaligned"));
6101 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6102 MBEDTLS_ERR_SSL_DECODE_ERROR);
6103 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006104 }
6105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (common_idx == 0) {
6107 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6108 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6109 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6110 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006111 }
6112
Gabor Mezei15b95a62022-05-09 16:37:58 +02006113 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006115}
6116
Ronald Crone68ab4f2022-10-05 12:46:29 +02006117#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006118
Jerry Yudc7bd172022-02-17 13:44:15 +08006119#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6120
6121#if defined(MBEDTLS_USE_PSA_CRYPTO)
6122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6124 mbedtls_svc_key_id_t key,
6125 psa_algorithm_t alg,
6126 const unsigned char *raw_psk, size_t raw_psk_length,
6127 const unsigned char *seed, size_t seed_length,
6128 const unsigned char *label, size_t label_length,
6129 const unsigned char *other_secret,
6130 size_t other_secret_length,
6131 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006132{
6133 psa_status_t status;
6134
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 status = psa_key_derivation_setup(derivation, alg);
6136 if (status != PSA_SUCCESS) {
6137 return status;
6138 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006139
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6141 status = psa_key_derivation_input_bytes(derivation,
6142 PSA_KEY_DERIVATION_INPUT_SEED,
6143 seed, seed_length);
6144 if (status != PSA_SUCCESS) {
6145 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006146 }
6147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 if (other_secret != NULL) {
6149 status = psa_key_derivation_input_bytes(derivation,
6150 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6151 other_secret, other_secret_length);
6152 if (status != PSA_SUCCESS) {
6153 return status;
6154 }
6155 }
6156
6157 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006158 status = psa_key_derivation_input_bytes(
6159 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 raw_psk, raw_psk_length);
6161 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006162 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006164 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 if (status != PSA_SUCCESS) {
6166 return status;
6167 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006168
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 status = psa_key_derivation_input_bytes(derivation,
6170 PSA_KEY_DERIVATION_INPUT_LABEL,
6171 label, label_length);
6172 if (status != PSA_SUCCESS) {
6173 return status;
6174 }
6175 } else {
6176 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006177 }
6178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 status = psa_key_derivation_set_capacity(derivation, capacity);
6180 if (status != PSA_SUCCESS) {
6181 return status;
6182 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006185}
6186
Andrzej Kurek57d10632022-10-24 10:32:01 -04006187#if defined(PSA_WANT_ALG_SHA_384) || \
6188 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006189MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006190static int tls_prf_generic(mbedtls_md_type_t md_type,
6191 const unsigned char *secret, size_t slen,
6192 const char *label,
6193 const unsigned char *random, size_t rlen,
6194 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006195{
6196 psa_status_t status;
6197 psa_algorithm_t alg;
6198 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6199 psa_key_derivation_operation_t derivation =
6200 PSA_KEY_DERIVATION_OPERATION_INIT;
6201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006203 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006205 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006207
6208 /* Normally a "secret" should be long enough to be impossible to
6209 * find by brute force, and in particular should not be empty. But
6210 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6211 * and for this use case it makes sense to have a 0-length "secret".
6212 * Since the key API doesn't allow importing a key of length 0,
6213 * keep master_key=0, which setup_psa_key_derivation() understands
6214 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6218 psa_set_key_algorithm(&key_attributes, alg);
6219 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006220
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6222 if (status != PSA_SUCCESS) {
6223 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 }
6226
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 status = setup_psa_key_derivation(&derivation,
6228 master_key, alg,
6229 NULL, 0,
6230 random, rlen,
6231 (unsigned char const *) label,
6232 (size_t) strlen(label),
6233 NULL, 0,
6234 dlen);
6235 if (status != PSA_SUCCESS) {
6236 psa_key_derivation_abort(&derivation);
6237 psa_destroy_key(master_key);
6238 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006239 }
6240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6242 if (status != PSA_SUCCESS) {
6243 psa_key_derivation_abort(&derivation);
6244 psa_destroy_key(master_key);
6245 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 }
6247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 status = psa_key_derivation_abort(&derivation);
6249 if (status != PSA_SUCCESS) {
6250 psa_destroy_key(master_key);
6251 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006252 }
6253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 if (!mbedtls_svc_key_id_is_null(master_key)) {
6255 status = psa_destroy_key(master_key);
6256 }
6257 if (status != PSA_SUCCESS) {
6258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6259 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006262}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006263#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006264#else /* MBEDTLS_USE_PSA_CRYPTO */
6265
Andrzej Kurek57d10632022-10-24 10:32:01 -04006266#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006267 (defined(MBEDTLS_MD_CAN_SHA256) || \
6268 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006270static int tls_prf_generic(mbedtls_md_type_t md_type,
6271 const unsigned char *secret, size_t slen,
6272 const char *label,
6273 const unsigned char *random, size_t rlen,
6274 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006275{
6276 size_t nb;
6277 size_t i, j, k, md_len;
6278 unsigned char *tmp;
6279 size_t tmp_len = 0;
6280 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6281 const mbedtls_md_info_t *md_info;
6282 mbedtls_md_context_t md_ctx;
6283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6288 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6289 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006292
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 tmp_len = md_len + strlen(label) + rlen;
6294 tmp = mbedtls_calloc(1, tmp_len);
6295 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006296 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6297 goto exit;
6298 }
6299
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 nb = strlen(label);
6301 memcpy(tmp + md_len, label, nb);
6302 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006303 nb += rlen;
6304
6305 /*
6306 * Compute P_<hash>(secret, label + random)[0..dlen]
6307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006309 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006311
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6313 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006314 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 }
6316 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6317 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006318 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 }
6320 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6321 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006322 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 for (i = 0; i < dlen; i += md_len) {
6326 ret = mbedtls_md_hmac_reset(&md_ctx);
6327 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006328 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 }
6330 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6331 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006332 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 }
6334 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6335 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006336 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006338
Gilles Peskine449bd832023-01-11 14:50:10 +01006339 ret = mbedtls_md_hmac_reset(&md_ctx);
6340 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006341 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 }
6343 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6344 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006345 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 }
6347 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6348 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006349 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006351
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006353
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006355 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006357 }
6358
6359exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006361
Gilles Peskine449bd832023-01-11 14:50:10 +01006362 if (tmp != NULL) {
6363 mbedtls_platform_zeroize(tmp, tmp_len);
6364 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006367
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006371}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006372#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006373#endif /* MBEDTLS_USE_PSA_CRYPTO */
6374
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006375#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006376MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006377static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6378 const char *label,
6379 const unsigned char *random, size_t rlen,
6380 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006381{
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6383 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006384}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006385#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006386
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006387#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006388MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006389static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6390 const char *label,
6391 const unsigned char *random, size_t rlen,
6392 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006393{
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6395 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006396}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006397#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006398
Jerry Yuf009d862022-02-17 14:01:37 +08006399/*
6400 * Set appropriate PRF function and other SSL / TLS1.2 functions
6401 *
6402 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006403 * - hash associated with the ciphersuite (only used by TLS 1.2)
6404 *
6405 * Outputs:
6406 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6407 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006408MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006409static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6410 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006411{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006412#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006414 handshake->tls_prf = tls_prf_sha384;
6415 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6416 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006418#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006419#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006420 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006421 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006422 handshake->tls_prf = tls_prf_sha256;
6423 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6424 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6425 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006426#else
Jerry Yuf009d862022-02-17 14:01:37 +08006427 {
Jerry Yuf009d862022-02-17 14:01:37 +08006428 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006429 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006431 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006432#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006435}
Jerry Yud6ab2352022-02-17 14:03:43 +08006436
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437/*
6438 * Compute master secret if needed
6439 *
6440 * Parameters:
6441 * [in/out] handshake
6442 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6443 * (PSA-PSK) ciphersuite_info, psk_opaque
6444 * [out] premaster (cleared)
6445 * [out] master
6446 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6447 * debug: conf->f_dbg, conf->p_dbg
6448 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006449 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006452static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6453 unsigned char *master,
6454 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455{
6456 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6457
6458 /* cf. RFC 5246, Section 8.1:
6459 * "The master secret is always exactly 48 bytes in length." */
6460 size_t const master_secret_len = 48;
6461
6462#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6463 unsigned char session_hash[48];
6464#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6465
6466 /* The label for the KDF used for key expansion.
6467 * This is either "master secret" or "extended master secret"
6468 * depending on whether the Extended Master Secret extension
6469 * is used. */
6470 char const *lbl = "master secret";
6471
Przemek Stekielae4ed302022-04-05 17:15:55 +02006472 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473 * - If the Extended Master Secret extension is not used,
6474 * this is ClientHello.Random + ServerHello.Random
6475 * (see Sect. 8.1 in RFC 5246).
6476 * - If the Extended Master Secret extension is used,
6477 * this is the transcript of the handshake so far.
6478 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006479 unsigned char const *seed = handshake->randbytes;
6480 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006481
6482#if !defined(MBEDTLS_DEBUG_C) && \
6483 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6484 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006486 ssl = NULL; /* make sure we don't use it except for those cases */
6487 (void) ssl;
6488#endif
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 if (handshake->resume != 0) {
6491 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6492 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006493 }
6494
6495#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006497 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006498 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006499 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6500 if (ret != 0) {
6501 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6502 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6505 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006506 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006507#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006508
Przemek Stekiel99114f32022-04-22 11:20:09 +02006509#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006510 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006512 /* Perform PSK-to-MS expansion in a single step. */
6513 psa_status_t status;
6514 psa_algorithm_t alg;
6515 mbedtls_svc_key_id_t psk;
6516 psa_key_derivation_operation_t derivation =
6517 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006518 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006525 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006527 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006530 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006532
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006534 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006535 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006536 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006537 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006538 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006539 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006540 other_secret_len = 48;
6541 other_secret = handshake->premaster + 2;
6542 break;
6543 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006544 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006545 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6546 other_secret = handshake->premaster + 2;
6547 break;
6548 default:
6549 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006550 }
6551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 status = setup_psa_key_derivation(&derivation, psk, alg,
6553 ssl->conf->psk, ssl->conf->psk_len,
6554 seed, seed_len,
6555 (unsigned char const *) lbl,
6556 (size_t) strlen(lbl),
6557 other_secret, other_secret_len,
6558 master_secret_len);
6559 if (status != PSA_SUCCESS) {
6560 psa_key_derivation_abort(&derivation);
6561 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006562 }
6563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 status = psa_key_derivation_output_bytes(&derivation,
6565 master,
6566 master_secret_len);
6567 if (status != PSA_SUCCESS) {
6568 psa_key_derivation_abort(&derivation);
6569 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006570 }
6571
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 status = psa_key_derivation_abort(&derivation);
6573 if (status != PSA_SUCCESS) {
6574 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6575 }
6576 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006577#endif
6578 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006579#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6581 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006582 psa_status_t status;
6583 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6584 psa_key_derivation_operation_t derivation =
6585 PSA_KEY_DERIVATION_OPERATION_INIT;
6586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006588
6589 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 status = psa_key_derivation_setup(&derivation, alg);
6592 if (status != PSA_SUCCESS) {
6593 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006594 }
6595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 status = psa_key_derivation_set_capacity(&derivation,
6597 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6598 if (status != PSA_SUCCESS) {
6599 psa_key_derivation_abort(&derivation);
6600 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006601 }
6602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6604 &derivation);
6605 if (status != PSA_SUCCESS) {
6606 psa_key_derivation_abort(&derivation);
6607 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006608 }
6609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 status = psa_key_derivation_output_bytes(&derivation,
6611 handshake->premaster,
6612 handshake->pmslen);
6613 if (status != PSA_SUCCESS) {
6614 psa_key_derivation_abort(&derivation);
6615 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6616 }
6617
6618 status = psa_key_derivation_abort(&derivation);
6619 if (status != PSA_SUCCESS) {
6620 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006621 }
6622 }
6623#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6625 lbl, seed, seed_len,
6626 master,
6627 master_secret_len);
6628 if (ret != 0) {
6629 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6630 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006631 }
6632
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6634 handshake->premaster,
6635 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 mbedtls_platform_zeroize(handshake->premaster,
6638 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006639 }
6640
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006642}
6643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006645{
6646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6647 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6648 ssl->handshake->ciphersuite_info;
6649
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006651
6652 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006654 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 if (ret != 0) {
6656 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6657 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006658 }
6659
6660 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 ret = ssl_compute_master(ssl->handshake,
6662 ssl->session_negotiate->master,
6663 ssl);
6664 if (ret != 0) {
6665 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6666 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006667 }
6668
6669 /* Swap the client and server random values:
6670 * - MS derivation wanted client+server (RFC 5246 8.1)
6671 * - key derivation wants server+client (RFC 5246 6.3) */
6672 {
6673 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 memcpy(tmp, ssl->handshake->randbytes, 64);
6675 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6676 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6677 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006678 }
6679
6680 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6682 ssl->session_negotiate->ciphersuite,
6683 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006684#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006686#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 ssl->handshake->tls_prf,
6688 ssl->handshake->randbytes,
6689 ssl->tls_version,
6690 ssl->conf->endpoint,
6691 ssl);
6692 if (ret != 0) {
6693 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6694 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006695 }
6696
6697 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6699 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006704}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006705
Gilles Peskine449bd832023-01-11 14:50:10 +01006706int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006707{
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006709#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006710 case MBEDTLS_SSL_HASH_SHA384:
6711 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6712 break;
6713#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006714#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006715 case MBEDTLS_SSL_HASH_SHA256:
6716 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6717 break;
6718#endif
6719 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006721 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006722#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6723 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006724 (void) ssl;
6725#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006727}
6728
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006729#if defined(MBEDTLS_USE_PSA_CRYPTO)
6730static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6731 const psa_hash_operation_t *hs_op,
6732 size_t buffer_size,
6733 unsigned char *hash,
6734 size_t *hlen)
6735{
6736 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006737 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006738
6739#if !defined(MBEDTLS_DEBUG_C)
6740 (void) ssl;
6741#endif
6742 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006743 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006744 if (status != PSA_SUCCESS) {
6745 goto exit;
6746 }
6747
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006748 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006749 if (status != PSA_SUCCESS) {
6750 goto exit;
6751 }
6752
6753 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6754 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6755
6756exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006757 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006758 return mbedtls_md_error_from_psa(status);
6759}
6760#else
6761static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6762 const mbedtls_md_context_t *hs_ctx,
6763 unsigned char *hash,
6764 size_t *hlen)
6765{
6766 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006767 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006768
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006769 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006770
6771#if !defined(MBEDTLS_DEBUG_C)
6772 (void) ssl;
6773#endif
6774 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6775
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006776 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006777 if (ret != 0) {
6778 goto exit;
6779 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006780 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006781 if (ret != 0) {
6782 goto exit;
6783 }
6784
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006785 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006786 if (ret != 0) {
6787 goto exit;
6788 }
6789
6790 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6791
6792 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6793 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6794
6795exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006796 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006797 return ret;
6798}
6799#endif /* MBEDTLS_USE_PSA_CRYPTO */
6800
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006801#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006802int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6803 unsigned char *hash,
6804 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006805{
6806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006807 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6808 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006809#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006810 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6811 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006812#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006813}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006814#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006815
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006816#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006817int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6818 unsigned char *hash,
6819 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006820{
6821#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006822 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6823 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006824#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006825 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6826 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006827#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006828}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006829#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006830
Neil Armstrong80f6f322022-05-03 17:56:38 +02006831#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6832 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006833int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006834{
6835 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006837 const unsigned char *psk = NULL;
6838 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006842 /*
6843 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006844 * checked before calling this function.
6845 *
6846 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006847 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6850 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6851 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006852 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006853 }
6854
6855 /*
6856 * PMS = struct {
6857 * opaque other_secret<0..2^16-1>;
6858 * opaque psk<0..2^16-1>;
6859 * };
6860 * with "other_secret" depending on the particular key exchange
6861 */
6862#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6864 if (end - p < 2) {
6865 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6866 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006869 p += 2;
6870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 if (end < p || (size_t) (end - p) < psk_len) {
6872 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6873 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006874
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006876 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006878#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6879#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006881 /*
6882 * other_secret already set by the ClientKeyExchange message,
6883 * and is 48 bytes long
6884 */
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
6889 *p++ = 0;
6890 *p++ = 48;
6891 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006893#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6894#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6897 size_t len;
6898
6899 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006901 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6903 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6904 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006905 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006907 p += 2 + len;
6908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6910 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006911#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006912#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6915 size_t zlen;
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006918 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6920 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6921 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006922 }
6923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006925 p += 2 + zlen;
6926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6928 MBEDTLS_DEBUG_ECDH_Z);
6929 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006930#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006931 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6933 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006934 }
6935
6936 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 if (end - p < 2) {
6938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6939 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006942 p += 2;
6943
Gilles Peskine449bd832023-01-11 14:50:10 +01006944 if (end < p || (size_t) (end - p) < psk_len) {
6945 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6946 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006949 p += psk_len;
6950
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006951 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006954}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006955#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006956
6957#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006959static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006960
6961#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006962int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006963{
6964 /* If renegotiation is not enforced, retransmit until we would reach max
6965 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006967 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6968 unsigned char doublings = 1;
6969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006971 ++doublings;
6972 ratio >>= 1;
6973 }
6974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 if (++ssl->renego_records_seen > doublings) {
6976 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6977 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006978 }
6979 }
6980
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006982}
6983#endif
6984#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006985
Jerry Yud9526692022-02-17 14:23:47 +08006986/*
6987 * Handshake functions
6988 */
6989#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6990/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006991int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006992{
6993 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6994 ssl->handshake->ciphersuite_info;
6995
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006997
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6999 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007000 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007002 }
7003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7005 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007006}
7007
Gilles Peskine449bd832023-01-11 14:50:10 +01007008int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007009{
7010 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7011 ssl->handshake->ciphersuite_info;
7012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007014
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7016 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007017 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007019 }
7020
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7022 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007023}
7024
7025#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7026/* Some certificate support -> implement write and parse */
7027
Gilles Peskine449bd832023-01-11 14:50:10 +01007028int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007029{
7030 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7031 size_t i, n;
7032 const mbedtls_x509_crt *crt;
7033 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7034 ssl->handshake->ciphersuite_info;
7035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7039 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007040 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007042 }
7043
7044#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7046 if (ssl->handshake->client_auth == 0) {
7047 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007048 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007049 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007050 }
7051 }
7052#endif /* MBEDTLS_SSL_CLI_C */
7053#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7055 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007056 /* Should never happen because we shouldn't have picked the
7057 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007059 }
7060 }
7061#endif
7062
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007064
7065 /*
7066 * 0 . 0 handshake type
7067 * 1 . 3 handshake length
7068 * 4 . 6 length of all certs
7069 * 7 . 9 length of cert. 1
7070 * 10 . n-1 peer certificate
7071 * n . n+2 length of cert. 2
7072 * n+3 . ... upper level cert, etc.
7073 */
7074 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007078 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7080 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7081 " > %" MBEDTLS_PRINTF_SIZET,
7082 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7083 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007084 }
7085
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7087 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7088 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007089
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007091 i += n; crt = crt->next;
7092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7095 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7096 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007097
7098 ssl->out_msglen = i;
7099 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7100 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7101
7102 ssl->state++;
7103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7105 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7106 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007107 }
7108
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007110
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007112}
7113
7114#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7115
7116#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007118static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7119 unsigned char *crt_buf,
7120 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007121{
7122 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 if (peer_crt == NULL) {
7125 return -1;
7126 }
Jerry Yud9526692022-02-17 14:23:47 +08007127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 if (peer_crt->raw.len != crt_buf_len) {
7129 return -1;
7130 }
Jerry Yud9526692022-02-17 14:23:47 +08007131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007133}
7134#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007135MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007136static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7137 unsigned char *crt_buf,
7138 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007139{
7140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7141 unsigned char const * const peer_cert_digest =
7142 ssl->session->peer_cert_digest;
7143 mbedtls_md_type_t const peer_cert_digest_type =
7144 ssl->session->peer_cert_digest_type;
7145 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007147 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7148 size_t digest_len;
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 if (peer_cert_digest == NULL || digest_info == NULL) {
7151 return -1;
7152 }
Jerry Yud9526692022-02-17 14:23:47 +08007153
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 digest_len = mbedtls_md_get_size(digest_info);
7155 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7156 return -1;
7157 }
Jerry Yud9526692022-02-17 14:23:47 +08007158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7160 if (ret != 0) {
7161 return -1;
7162 }
Jerry Yud9526692022-02-17 14:23:47 +08007163
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007165}
7166#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7167#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7168
7169/*
7170 * Once the certificate message is read, parse it into a cert chain and
7171 * perform basic checks, but leave actual verification to the caller
7172 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007173MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007174static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7175 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007176{
7177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7178#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007180#endif
7181 size_t i, n;
7182 uint8_t alert;
7183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7185 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7186 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7187 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7188 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007189 }
7190
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7192 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7193 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7194 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007195 }
7196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7198 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7199 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7200 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7201 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007202 }
7203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007205
7206 /*
7207 * Same message structure as in mbedtls_ssl_write_certificate()
7208 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007209 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (ssl->in_msg[i] != 0 ||
7212 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7213 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7214 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7215 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7216 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007217 }
7218
7219 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7220 i += 3;
7221
7222 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007224 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 if (i + 3 > ssl->in_hslen) {
7226 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7227 mbedtls_ssl_send_alert_message(ssl,
7228 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7229 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7230 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007231 }
7232 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7233 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 if (ssl->in_msg[i] != 0) {
7235 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7236 mbedtls_ssl_send_alert_message(ssl,
7237 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7238 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7239 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007240 }
7241
7242 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007243 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007244 i += 3;
7245
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 if (n < 128 || i + n > ssl->in_hslen) {
7247 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7248 mbedtls_ssl_send_alert_message(ssl,
7249 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7250 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7251 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007252 }
7253
7254 /* Check if we're handling the first CRT in the chain. */
7255#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007257 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007259 /* During client-side renegotiation, check that the server's
7260 * end-CRTs hasn't changed compared to the initial handshake,
7261 * mitigating the triple handshake attack. On success, reuse
7262 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007263 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7264 if (ssl_check_peer_crt_unchanged(ssl,
7265 &ssl->in_msg[i],
7266 n) != 0) {
7267 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7268 mbedtls_ssl_send_alert_message(ssl,
7269 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7270 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7271 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007272 }
7273
7274 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007276 }
7277#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7278
7279 /* Parse the next certificate in the chain. */
7280#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007282#else
7283 /* If we don't need to store the CRT chain permanently, parse
7284 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007286#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007288 case 0: /*ok*/
7289 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7290 /* Ignore certificate with an unknown algorithm: maybe a
7291 prior certificate was already trusted. */
7292 break;
7293
7294 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7295 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7296 goto crt_parse_der_failed;
7297
7298 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7299 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7300 goto crt_parse_der_failed;
7301
7302 default:
7303 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007304crt_parse_der_failed:
7305 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7306 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7307 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007308 }
7309
7310 i += n;
7311 }
7312
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7314 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007315}
7316
7317#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007319static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007320{
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7322 return -1;
7323 }
Jerry Yud9526692022-02-17 14:23:47 +08007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007326 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7327 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7329 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7330 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007331 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007333}
7334#endif /* MBEDTLS_SSL_SRV_C */
7335
7336/* Check if a certificate message is expected.
7337 * Return either
7338 * - SSL_CERTIFICATE_EXPECTED, or
7339 * - SSL_CERTIFICATE_SKIP
7340 * indicating whether a Certificate message is expected or not.
7341 */
7342#define SSL_CERTIFICATE_EXPECTED 0
7343#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007344MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007345static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7346 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007347{
7348 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7349 ssl->handshake->ciphersuite_info;
7350
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7352 return SSL_CERTIFICATE_SKIP;
7353 }
Jerry Yud9526692022-02-17 14:23:47 +08007354
7355#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7357 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7358 return SSL_CERTIFICATE_SKIP;
7359 }
Jerry Yud9526692022-02-17 14:23:47 +08007360
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007362 ssl->session_negotiate->verify_result =
7363 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007365 }
7366 }
7367#else
7368 ((void) authmode);
7369#endif /* MBEDTLS_SSL_SRV_C */
7370
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007372}
7373
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007374MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007375static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7376 int authmode,
7377 mbedtls_x509_crt *chain,
7378 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007379{
7380 int ret = 0;
7381 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7382 ssl->handshake->ciphersuite_info;
7383 int have_ca_chain = 0;
7384
7385 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7386 void *p_vrfy;
7387
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7389 return 0;
7390 }
Jerry Yud9526692022-02-17 14:23:47 +08007391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 if (ssl->f_vrfy != NULL) {
7393 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007394 f_vrfy = ssl->f_vrfy;
7395 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 } else {
7397 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007398 f_vrfy = ssl->conf->f_vrfy;
7399 p_vrfy = ssl->conf->p_vrfy;
7400 }
7401
7402 /*
7403 * Main check: verify certificate
7404 */
7405#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007407 ((void) rs_ctx);
7408 have_ca_chain = 1;
7409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007411 ret = mbedtls_x509_crt_verify_with_ca_cb(
7412 chain,
7413 ssl->conf->f_ca_cb,
7414 ssl->conf->p_ca_cb,
7415 ssl->conf->cert_profile,
7416 ssl->hostname,
7417 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 f_vrfy, p_vrfy);
7419 } else
Jerry Yud9526692022-02-17 14:23:47 +08007420#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7421 {
7422 mbedtls_x509_crt *ca_chain;
7423 mbedtls_x509_crl *ca_crl;
7424
7425#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007427 ca_chain = ssl->handshake->sni_ca_chain;
7428 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else
Jerry Yud9526692022-02-17 14:23:47 +08007430#endif
7431 {
7432 ca_chain = ssl->conf->ca_chain;
7433 ca_crl = ssl->conf->ca_crl;
7434 }
7435
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007437 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 }
Jerry Yud9526692022-02-17 14:23:47 +08007439
7440 ret = mbedtls_x509_crt_verify_restartable(
7441 chain,
7442 ca_chain, ca_crl,
7443 ssl->conf->cert_profile,
7444 ssl->hostname,
7445 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007447 }
7448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 if (ret != 0) {
7450 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007451 }
7452
7453#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7455 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7456 }
Jerry Yud9526692022-02-17 14:23:47 +08007457#endif
7458
7459 /*
7460 * Secondary checks: always done, but change 'ret' only if it was 0
7461 */
7462
Valerio Settiacd32c02023-06-29 18:06:29 +02007463#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007464 {
7465 const mbedtls_pk_context *pk = &chain->pk;
7466
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007467 /* If certificate uses an EC key, make sure the curve is OK.
7468 * This is a public key, so it can't be opaque, so can_do() is a good
7469 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007471 /* and in the unlikely case the above assumption no longer holds
7472 * we are making sure that pk_ec() here does not return a NULL
7473 */
Valerio Settif9362b72023-11-29 08:42:27 +01007474 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02007475 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7476 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007478 }
Valerio Setti97207782023-05-18 18:59:06 +02007479 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007480 ssl->session_negotiate->verify_result |=
7481 MBEDTLS_X509_BADCERT_BAD_KEY;
7482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7484 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007485 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007487 }
Jerry Yud9526692022-02-17 14:23:47 +08007488 }
7489 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007490#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007491
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 if (mbedtls_ssl_check_cert_usage(chain,
7493 ciphersuite_info,
7494 !ssl->conf->endpoint,
7495 &ssl->session_negotiate->verify_result) != 0) {
7496 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7497 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007498 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 }
Jerry Yud9526692022-02-17 14:23:47 +08007500 }
7501
7502 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7503 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7504 * with details encoded in the verification flags. All other kinds
7505 * of error codes, including those from the user provided f_vrfy
7506 * functions, are treated as fatal and lead to a failure of
7507 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7509 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7510 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007511 ret = 0;
7512 }
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7515 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007516 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7517 }
7518
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007520 uint8_t alert;
7521
7522 /* The certificate may have been rejected for several reasons.
7523 Pick one and send the corresponding alert. Which alert to send
7524 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007526 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007528 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007530 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007532 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007534 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007536 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007538 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007540 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007542 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007544 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007546 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 }
7548 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7549 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007550 }
7551
7552#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (ssl->session_negotiate->verify_result != 0) {
7554 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7555 (unsigned int) ssl->session_negotiate->verify_result));
7556 } else {
7557 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007558 }
7559#endif /* MBEDTLS_DEBUG_C */
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007562}
7563
7564#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007565MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007566static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7567 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007568{
7569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7570 /* Remember digest of the peer's end-CRT. */
7571 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7573 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7574 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7575 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7576 mbedtls_ssl_send_alert_message(ssl,
7577 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7578 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007581 }
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 ret = mbedtls_md(mbedtls_md_info_from_type(
7584 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7585 start, len,
7586 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007587
7588 ssl->session_negotiate->peer_cert_digest_type =
7589 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7590 ssl->session_negotiate->peer_cert_digest_len =
7591 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007594}
7595
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007596MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007597static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7598 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007599{
7600 unsigned char *end = start + len;
7601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7602
7603 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7605 ret = mbedtls_pk_parse_subpubkey(&start, end,
7606 &ssl->handshake->peer_pubkey);
7607 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007608 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007610 }
7611
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007613}
7614#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7615
Gilles Peskine449bd832023-01-11 14:50:10 +01007616int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007617{
7618 int ret = 0;
7619 int crt_expected;
7620#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7621 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7622 ? ssl->handshake->sni_authmode
7623 : ssl->conf->authmode;
7624#else
7625 const int authmode = ssl->conf->authmode;
7626#endif
7627 void *rs_ctx = NULL;
7628 mbedtls_x509_crt *chain = NULL;
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7633 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7634 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007635 goto exit;
7636 }
7637
7638#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (ssl->handshake->ecrs_enabled &&
7640 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007641 chain = ssl->handshake->ecrs_peer_cert;
7642 ssl->handshake->ecrs_peer_cert = NULL;
7643 goto crt_verify;
7644 }
7645#endif
7646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007648 /* mbedtls_ssl_read_record may have sent an alert already. We
7649 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007651 goto exit;
7652 }
7653
7654#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007656 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7657
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007659 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 }
Jerry Yud9526692022-02-17 14:23:47 +08007661
7662 goto exit;
7663 }
7664#endif /* MBEDTLS_SSL_SRV_C */
7665
7666 /* Clear existing peer CRT structure in case we tried to
7667 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007669
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7671 if (chain == NULL) {
7672 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7673 sizeof(mbedtls_x509_crt)));
7674 mbedtls_ssl_send_alert_message(ssl,
7675 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7676 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007677
7678 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7679 goto exit;
7680 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007682
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 ret = ssl_parse_certificate_chain(ssl, chain);
7684 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007685 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 }
Jerry Yud9526692022-02-17 14:23:47 +08007687
7688#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007690 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 }
Jerry Yud9526692022-02-17 14:23:47 +08007692
7693crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007695 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 }
Jerry Yud9526692022-02-17 14:23:47 +08007697#endif
7698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 ret = ssl_parse_certificate_verify(ssl, authmode,
7700 chain, rs_ctx);
7701 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007702 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 }
Jerry Yud9526692022-02-17 14:23:47 +08007704
7705#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7706 {
7707 unsigned char *crt_start, *pk_start;
7708 size_t crt_len, pk_len;
7709
7710 /* We parse the CRT chain without copying, so
7711 * these pointers point into the input buffer,
7712 * and are hence still valid after freeing the
7713 * CRT chain. */
7714
7715 crt_start = chain->raw.p;
7716 crt_len = chain->raw.len;
7717
7718 pk_start = chain->pk_raw.p;
7719 pk_len = chain->pk_raw.len;
7720
7721 /* Free the CRT structures before computing
7722 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 mbedtls_x509_crt_free(chain);
7724 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007725 chain = NULL;
7726
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7728 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007729 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 }
Jerry Yud9526692022-02-17 14:23:47 +08007731
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7733 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007734 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 }
Jerry Yud9526692022-02-17 14:23:47 +08007736 }
7737#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7738 /* Pass ownership to session structure. */
7739 ssl->session_negotiate->peer_cert = chain;
7740 chain = NULL;
7741#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7742
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007744
7745exit:
7746
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007748 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 }
Jerry Yud9526692022-02-17 14:23:47 +08007750
7751#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007752 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007753 ssl->handshake->ecrs_peer_cert = chain;
7754 chain = NULL;
7755 }
7756#endif
7757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (chain != NULL) {
7759 mbedtls_x509_crt_free(chain);
7760 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007761 }
7762
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007764}
7765#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7766
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007767static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7768 unsigned char *padbuf, size_t hlen,
7769 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007770{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007771 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007772 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007773#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007774 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007775 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007776 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007777 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007778#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007780 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007781 mbedtls_md_context_t cloned_ctx;
7782 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007783#endif
7784
7785 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007787 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007789
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007791 ? "client finished"
7792 : "server finished";
7793
7794#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007795 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007796
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007797 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007799 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007800 }
7801
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007802 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007804 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007805 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007806 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007807#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007808 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007809
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007810 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007811 if (ret != 0) {
7812 goto exit;
7813 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007814 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007815 if (ret != 0) {
7816 goto exit;
7817 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007818
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007819 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007820 if (ret != 0) {
7821 goto exit;
7822 }
7823#endif /* MBEDTLS_USE_PSA_CRYPTO */
7824
7825 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7826
Jerry Yu615bd6f2022-02-17 14:25:15 +08007827 /*
7828 * TLSv1.2:
7829 * hash = PRF( master, finished_label,
7830 * Hash( handshake ) )[0.11]
7831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007833 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007834
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007836
Paul Elliottecb95be2023-08-11 16:41:04 +01007837 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007838
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007839 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007840
7841exit:
7842#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007843 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007844 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007845#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007846 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007847 return ret;
7848#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007849}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007850
7851#if defined(MBEDTLS_MD_CAN_SHA256)
7852static int ssl_calc_finished_tls_sha256(
7853 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7854{
7855 unsigned char padbuf[32];
7856 return ssl_calc_finished_tls_generic(ssl,
7857#if defined(MBEDTLS_USE_PSA_CRYPTO)
7858 &ssl->handshake->fin_sha256_psa,
7859#else
7860 &ssl->handshake->fin_sha256,
7861#endif
7862 padbuf, sizeof(padbuf),
7863 buf, from);
7864}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007865#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007866
Jerry Yub7ba49e2022-02-17 14:25:53 +08007867
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007868#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007869static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007871{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007872 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007873 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007874#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007875 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007876#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007877 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007878#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007879 padbuf, sizeof(padbuf),
7880 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007881}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007882#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007885{
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007887
7888 /*
7889 * Free our handshake params
7890 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 mbedtls_ssl_handshake_free(ssl);
7892 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007893 ssl->handshake = NULL;
7894
7895 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007896 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (ssl->transform) {
7899 mbedtls_ssl_transform_free(ssl->transform);
7900 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007901 }
7902 ssl->transform = ssl->transform_negotiate;
7903 ssl->transform_negotiate = NULL;
7904
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007906}
7907
Gilles Peskine449bd832023-01-11 14:50:10 +01007908void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007909{
7910 int resume = ssl->handshake->resume;
7911
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007913
7914#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007916 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7917 ssl->renego_records_seen = 0;
7918 }
7919#endif
7920
7921 /*
7922 * Free the previous session and switch in the current one
7923 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007925#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7926 /* RFC 7366 3.1: keep the EtM state */
7927 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007929#endif
7930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 mbedtls_ssl_session_free(ssl->session);
7932 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007933 }
7934 ssl->session = ssl->session_negotiate;
7935 ssl->session_negotiate = NULL;
7936
7937 /*
7938 * Add cache entry
7939 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007941 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 resume == 0) {
7943 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7944 ssl->session->id,
7945 ssl->session->id_len,
7946 ssl->session) != 0) {
7947 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7948 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007949 }
7950
7951#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7953 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007954 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007956
7957 /* Keep last flight around in case we need to resend it:
7958 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7960 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007961#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007963
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007964 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007965
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007967}
7968
Gilles Peskine449bd832023-01-11 14:50:10 +01007969int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007970{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007971 int ret;
7972 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007973
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007977
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007978 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7979 if (ret != 0) {
7980 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7981 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007982
7983 /*
7984 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7985 * may define some other value. Currently (early 2016), no defined
7986 * ciphersuite does this (and this is unlikely to change as activity has
7987 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7988 */
7989 hash_len = 12;
7990
7991#if defined(MBEDTLS_SSL_RENEGOTIATION)
7992 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007994#endif
7995
7996 ssl->out_msglen = 4 + hash_len;
7997 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7998 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7999
8000 /*
8001 * In case of session resuming, invert the client and server
8002 * ChangeCipherSpec messages order.
8003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008005#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008007 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008009#endif
8010#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008012 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008014#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008016 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008018
8019 /*
8020 * Switch to our negotiated transform and session parameters for outbound
8021 * data.
8022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008024
8025#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008027 unsigned char i;
8028
8029 /* Remember current epoch settings for resending */
8030 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8032 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008033
8034 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008036
8037
8038 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 for (i = 2; i > 0; i--) {
8040 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008041 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 }
8043 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008044
8045 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if (i == 0) {
8047 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8048 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008049 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008051#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008053
8054 ssl->transform_out = ssl->transform_negotiate;
8055 ssl->session_out = ssl->session_negotiate;
8056
8057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8059 mbedtls_ssl_send_flight_completed(ssl);
8060 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008061#endif
8062
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8064 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8065 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008066 }
8067
8068#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8070 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8071 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8072 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008073 }
8074#endif
8075
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008079}
8080
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008081#define SSL_MAX_HASH_LEN 12
8082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008084{
8085 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8086 unsigned int hash_len = 12;
8087 unsigned char buf[SSL_MAX_HASH_LEN];
8088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008090
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008091 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8092 if (ret != 0) {
8093 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8094 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008095
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8097 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008098 goto exit;
8099 }
8100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8102 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8103 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8104 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008105 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8106 goto exit;
8107 }
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8110 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8111 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008112 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8113 goto exit;
8114 }
8115
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8117 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8118 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8119 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008120 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8121 goto exit;
8122 }
8123
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8125 buf, hash_len) != 0) {
8126 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8127 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8128 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008129 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8130 goto exit;
8131 }
8132
8133#if defined(MBEDTLS_SSL_RENEGOTIATION)
8134 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008136#endif
8137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008139#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008141 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008143#endif
8144#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008146 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008148#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008150 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008152
8153#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8155 mbedtls_ssl_recv_flight_completed(ssl);
8156 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008157#endif
8158
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008160
8161exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 mbedtls_platform_zeroize(buf, hash_len);
8163 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008164}
8165
Jerry Yu392112c2022-02-17 14:34:10 +08008166#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8167/*
8168 * Helper to get TLS 1.2 PRF from ciphersuite
8169 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008171static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008172{
Jerry Yu392112c2022-02-17 14:34:10 +08008173 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008175#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8177 return tls_prf_sha384;
8178 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008179#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008180#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008181 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8183 return tls_prf_sha256;
8184 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008185 }
8186#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008187#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8188 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008189 (void) ciphersuite_info;
8190#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008193}
8194#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008197{
8198 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008199#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if (tls_prf == tls_prf_sha384) {
8201 return MBEDTLS_SSL_TLS_PRF_SHA384;
8202 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008203#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008204#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 if (tls_prf == tls_prf_sha256) {
8206 return MBEDTLS_SSL_TLS_PRF_SHA256;
8207 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008208#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008210}
8211
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008212/*
8213 * Populate a transform structure with session keys and all the other
8214 * necessary information.
8215 *
8216 * Parameters:
8217 * - [in/out]: transform: structure to populate
8218 * [in] must be just initialised with mbedtls_ssl_transform_init()
8219 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8220 * - [in] ciphersuite
8221 * - [in] master
8222 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008223 * - [in] tls_prf: pointer to PRF to use for key derivation
8224 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008225 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008226 * - [in] endpoint: client or server
8227 * - [in] ssl: used for:
8228 * - ssl->conf->{f,p}_export_keys
8229 * [in] optionally used for:
8230 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8231 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008232MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008233static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8234 int ciphersuite,
8235 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008236#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008238#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 ssl_tls_prf_t tls_prf,
8240 const unsigned char randbytes[64],
8241 mbedtls_ssl_protocol_version tls_version,
8242 unsigned endpoint,
8243 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008244{
8245 int ret = 0;
8246 unsigned char keyblk[256];
8247 unsigned char *key1;
8248 unsigned char *key2;
8249 unsigned char *mac_enc;
8250 unsigned char *mac_dec;
8251 size_t mac_key_len = 0;
8252 size_t iv_copy_len;
8253 size_t keylen;
8254 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008255 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008256#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008257 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008258 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008259#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008260
8261#if defined(MBEDTLS_USE_PSA_CRYPTO)
8262 psa_key_type_t key_type;
8263 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8264 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008265 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008266 size_t key_bits;
8267 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8268#endif
8269
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008270 /*
8271 * Some data just needs copying into the structure
8272 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008273#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008274 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008275#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008276 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277
8278#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280#endif
8281
8282#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8285 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008287 }
8288#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8289
8290 /*
8291 * Get various info structures
8292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8294 if (ciphersuite_info == NULL) {
8295 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8296 ciphersuite));
8297 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008298 }
8299
Neil Armstrongab555e02022-04-04 11:07:59 +02008300 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008301#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008303#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008305
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008307 transform->taglen =
8308 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008309 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008310
8311#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008312 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 transform->taglen,
8314 &alg,
8315 &key_type,
8316 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008317 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008318 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008319 goto end;
8320 }
8321#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008322 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (cipher_info == NULL) {
8324 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8325 ciphersuite_info->cipher));
8326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008327 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008328#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008329
Neil Armstronge4512952022-03-08 09:08:22 +01008330#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008331 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008333 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 (unsigned) ciphersuite_info->mac));
8335 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008336 }
8337#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008338 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 if (md_info == NULL) {
8340 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8341 (unsigned) ciphersuite_info->mac));
8342 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008343 }
Neil Armstronge4512952022-03-08 09:08:22 +01008344#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345
8346#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8347 /* Copy own and peer's CID if the use of the CID
8348 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008349 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8350 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008351
8352 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8354 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8355 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008356
8357 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8359 ssl->handshake->peer_cid_len);
8360 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8361 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008362 }
8363#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8364
8365 /*
8366 * Compute key block using the PRF
8367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8369 if (ret != 0) {
8370 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8371 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008372 }
8373
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8375 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8376 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8377 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8378 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379
8380 /*
8381 * Determine the appropriate key, IV and MAC length.
8382 */
8383
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008384#if defined(MBEDTLS_USE_PSA_CRYPTO)
8385 keylen = PSA_BITS_TO_BYTES(key_bits);
8386#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008388#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008389
Valerio Settie5707042023-10-11 11:54:42 +02008390#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008392 size_t explicit_ivlen;
8393
8394 transform->maclen = 0;
8395 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008396
8397 /* All modes haves 96-bit IVs, but the length of the static parts vary
8398 * with mode and version:
8399 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8400 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8401 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8402 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8403 * sequence number).
8404 */
8405 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008406
8407 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008408#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008410#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8412 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008413#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008414
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008416 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008418 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008420
8421 /* Minimum length of encrypted record */
8422 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8423 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008424 } else
Valerio Settie5707042023-10-11 11:54:42 +02008425#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008426#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008427 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008428 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008430#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008432#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008433 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008434#endif /* MBEDTLS_USE_PSA_CRYPTO */
8435
8436#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008437 /* Get MAC length */
8438 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8439#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008440 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8442 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008444 goto end;
8445 }
8446
8447 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008449#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008450 transform->maclen = mac_key_len;
8451
8452 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008453#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008455#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008456 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008457#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008458
8459 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008461 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008463 /*
8464 * GenericBlockCipher:
8465 * 1. if EtM is in use: one block plus MAC
8466 * otherwise: * first multiple of blocklen greater than maclen
8467 * 2. IV
8468 */
8469#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008471 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 + block_size;
8473 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474#endif
8475 {
8476 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 + block_size
8478 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008479 }
8480
Gilles Peskine449bd832023-01-11 14:50:10 +01008481 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008482 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 } else {
8484 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 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008490#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8491 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8493 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008494 }
8495
Gilles Peskine449bd832023-01-11 14:50:10 +01008496 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8497 (unsigned) keylen,
8498 (unsigned) transform->minlen,
8499 (unsigned) transform->ivlen,
8500 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008501
8502 /*
8503 * Finally setup the cipher contexts, IVs and MAC secrets.
8504 */
8505#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008507 key1 = keyblk + mac_key_len * 2;
8508 key2 = keyblk + mac_key_len * 2 + keylen;
8509
8510 mac_enc = keyblk;
8511 mac_dec = keyblk + mac_key_len;
8512
Gilles Peskine449bd832023-01-11 14:50:10 +01008513 iv_copy_len = (transform->fixed_ivlen) ?
8514 transform->fixed_ivlen : transform->ivlen;
8515 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8516 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8517 iv_copy_len);
8518 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008519#endif /* MBEDTLS_SSL_CLI_C */
8520#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008522 key1 = keyblk + mac_key_len * 2 + keylen;
8523 key2 = keyblk + mac_key_len * 2;
8524
8525 mac_enc = keyblk + mac_key_len;
8526 mac_dec = keyblk;
8527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 iv_copy_len = (transform->fixed_ivlen) ?
8529 transform->fixed_ivlen : transform->ivlen;
8530 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8531 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8532 iv_copy_len);
8533 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008534#endif /* MBEDTLS_SSL_SRV_C */
8535 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8538 goto end;
8539 }
8540
Paul Elliott4fb19552023-10-18 12:15:30 +01008541 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 ssl->f_export_keys(ssl->p_export_keys,
8543 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8544 master, 48,
8545 randbytes + 32,
8546 randbytes,
8547 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008548 }
8549
8550#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008551 transform->psa_alg = alg;
8552
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8554 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8555 psa_set_key_algorithm(&attributes, alg);
8556 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008557
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 if ((status = psa_import_key(&attributes,
8559 key1,
8560 PSA_BITS_TO_BYTES(key_bits),
8561 &transform->psa_key_enc)) != PSA_SUCCESS) {
8562 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008563 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008565 goto end;
8566 }
8567
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008569
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 if ((status = psa_import_key(&attributes,
8571 key2,
8572 PSA_BITS_TO_BYTES(key_bits),
8573 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008574 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008576 goto end;
8577 }
8578 }
8579#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8581 cipher_info)) != 0) {
8582 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583 goto end;
8584 }
8585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8587 cipher_info)) != 0) {
8588 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008589 goto end;
8590 }
8591
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8593 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8594 MBEDTLS_ENCRYPT)) != 0) {
8595 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008596 goto end;
8597 }
8598
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8600 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8601 MBEDTLS_DECRYPT)) != 0) {
8602 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008603 goto end;
8604 }
8605
8606#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8608 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8609 MBEDTLS_PADDING_NONE)) != 0) {
8610 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008611 goto end;
8612 }
8613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8615 MBEDTLS_PADDING_NONE)) != 0) {
8616 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008617 goto end;
8618 }
8619 }
8620#endif /* MBEDTLS_CIPHER_MODE_CBC */
8621#endif /* MBEDTLS_USE_PSA_CRYPTO */
8622
Neil Armstrong29c0c042022-03-17 17:47:28 +01008623#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8624 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8625 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008627#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008629
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8631 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8632 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008633
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 if ((status = psa_import_key(&attributes,
8635 mac_enc, mac_key_len,
8636 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008637 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008639 goto end;
8640 }
8641
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8643 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008644#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008646#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008648 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8650 PSA_KEY_USAGE_VERIFY_HASH);
8651 } else {
8652 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8653 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008654
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 if ((status = psa_import_key(&attributes,
8656 mac_dec, mac_key_len,
8657 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008658 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008660 goto end;
8661 }
8662#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008663 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8664 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008665 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 }
8667 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8668 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008669 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008671#endif /* MBEDTLS_USE_PSA_CRYPTO */
8672 }
8673#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8674
8675 ((void) mac_dec);
8676 ((void) mac_enc);
8677
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008678end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8680 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008681}
8682
Valerio Settia08b1a42022-11-17 15:10:02 +01008683#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8684 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008685int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 psa_pake_operation_t *pake_ctx,
8687 const unsigned char *buf,
8688 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008689{
8690 psa_status_t status;
8691 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008692 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008693 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8694 * At round two perform a single cycle
8695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008697
Gilles Peskine449bd832023-01-11 14:50:10 +01008698 for (; remaining_steps > 0; remaining_steps--) {
8699 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008700 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008702 /* Length is stored at the first byte */
8703 size_t length = buf[input_offset];
8704 input_offset += 1;
8705
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008707 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8708 }
8709
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 status = psa_pake_input(pake_ctx, step,
8711 buf + input_offset, length);
8712 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008713 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008714 }
8715
8716 input_offset += length;
8717 }
8718 }
8719
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008721 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008725}
8726
Valerio Setti6b3dab02022-11-17 17:14:54 +01008727int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 psa_pake_operation_t *pake_ctx,
8729 unsigned char *buf,
8730 size_t len, size_t *olen,
8731 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008732{
8733 psa_status_t status;
8734 size_t output_offset = 0;
8735 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008736 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008737 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8738 * At round two perform a single cycle
8739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 for (; remaining_steps > 0; remaining_steps--) {
8743 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8744 step <= PSA_PAKE_STEP_ZK_PROOF;
8745 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008746 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008747 * For each step, prepend 1 byte with the length of the data as
8748 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008750 status = psa_pake_output(pake_ctx, step,
8751 buf + output_offset + 1,
8752 len - output_offset - 1,
8753 &output_len);
8754 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008755 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008756 }
8757
Valerio Setti99d88c12022-11-22 16:03:43 +01008758 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008759
8760 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008761 }
8762 }
8763
8764 *olen = output_offset;
8765
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008767}
Valerio Settia08b1a42022-11-17 15:10:02 +01008768#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8769
Jerry Yuee40f9d2022-02-17 14:55:16 +08008770#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008771int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8772 unsigned char *hash, size_t *hashlen,
8773 unsigned char *data, size_t data_len,
8774 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008775{
8776 psa_status_t status;
8777 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008778 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008779
Gilles Peskine449bd832023-01-11 14:50:10 +01008780 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 if ((status = psa_hash_setup(&hash_operation,
8783 hash_alg)) != PSA_SUCCESS) {
8784 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008785 goto exit;
8786 }
8787
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8789 64)) != PSA_SUCCESS) {
8790 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008791 goto exit;
8792 }
8793
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 if ((status = psa_hash_update(&hash_operation,
8795 data, data_len)) != PSA_SUCCESS) {
8796 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008797 goto exit;
8798 }
8799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8801 hashlen)) != PSA_SUCCESS) {
8802 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8803 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008804 }
8805
8806exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 if (status != PSA_SUCCESS) {
8808 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8809 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8810 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008811 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008812 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008813 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8814 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008815 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008816 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008817 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008818 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008820 }
8821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008822 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008823}
8824
8825#else
8826
Gilles Peskine449bd832023-01-11 14:50:10 +01008827int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8828 unsigned char *hash, size_t *hashlen,
8829 unsigned char *data, size_t data_len,
8830 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008831{
8832 int ret = 0;
8833 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008834 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8835 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008836
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008838
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008840
8841 /*
8842 * digitally-signed struct {
8843 * opaque client_random[32];
8844 * opaque server_random[32];
8845 * ServerDHParams params;
8846 * };
8847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008848 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8849 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008850 goto exit;
8851 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8853 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008854 goto exit;
8855 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8857 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008858 goto exit;
8859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8861 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008862 goto exit;
8863 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008864 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008866 goto exit;
8867 }
8868
8869exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008870 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008871
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 if (ret != 0) {
8873 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8874 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8875 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008876
Gilles Peskine449bd832023-01-11 14:50:10 +01008877 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008878}
8879#endif /* MBEDTLS_USE_PSA_CRYPTO */
8880
Jerry Yud9d91da2022-02-17 14:57:06 +08008881#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8882
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008883/* Find the preferred hash for a given signature algorithm. */
8884unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 mbedtls_ssl_context *ssl,
8886 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008887{
Gabor Mezei078e8032022-04-27 21:17:56 +02008888 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008889 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008890
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8892 return MBEDTLS_SSL_HASH_NONE;
8893 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008894
Gilles Peskine449bd832023-01-11 14:50:10 +01008895 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008896 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8898 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008899 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8901 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008902
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008903 mbedtls_md_type_t md_alg =
8904 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8905 if (md_alg == MBEDTLS_MD_NONE) {
8906 continue;
8907 }
8908
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008910#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008912 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008913 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008914
Gilles Peskine449bd832023-01-11 14:50:10 +01008915 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8916 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8917 PSA_ALG_ECDSA(psa_hash_alg),
8918 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008919 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008920 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008921
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8923 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8924 PSA_ALG_RSA_PKCS1V15_SIGN(
8925 psa_hash_alg),
8926 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008927 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008929 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008930#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008931
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008933 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008934 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008935
Gilles Peskine449bd832023-01-11 14:50:10 +01008936 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008937}
8938
8939#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8940
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008941/* Serialization of TLS 1.2 sessions:
8942 *
8943 * struct {
8944 * uint64 start_time;
8945 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008946 * uint8 session_id_len; // at most 32
8947 * opaque session_id[32];
8948 * opaque master[48]; // fixed length in the standard
8949 * uint32 verify_result;
8950 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8951 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8952 * uint32 ticket_lifetime;
8953 * uint8 mfl_code; // up to 255 according to standard
8954 * uint8 encrypt_then_mac; // 0 or 1
8955 * } serialized_session_tls12;
8956 *
8957 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008958static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8959 unsigned char *buf,
8960 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008961{
8962 unsigned char *p = buf;
8963 size_t used = 0;
8964
8965#if defined(MBEDTLS_HAVE_TIME)
8966 uint64_t start;
8967#endif
8968#if defined(MBEDTLS_X509_CRT_PARSE_C)
8969#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8970 size_t cert_len;
8971#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8972#endif /* MBEDTLS_X509_CRT_PARSE_C */
8973
8974 /*
8975 * Time
8976 */
8977#if defined(MBEDTLS_HAVE_TIME)
8978 used += 8;
8979
Gilles Peskine449bd832023-01-11 14:50:10 +01008980 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008981 start = (uint64_t) session->start;
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984 p += 8;
8985 }
8986#endif /* MBEDTLS_HAVE_TIME */
8987
8988 /*
8989 * Basic mandatory fields
8990 */
8991 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008992 + 1 /* id_len */
8993 + sizeof(session->id)
8994 + sizeof(session->master)
8995 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008996
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (used <= buf_len) {
8998 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008999 p += 2;
9000
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 *p++ = MBEDTLS_BYTE_0(session->id_len);
9002 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009003 p += 32;
9004
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009006 p += 48;
9007
Gilles Peskine449bd832023-01-11 14:50:10 +01009008 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009009 p += 4;
9010 }
9011
9012 /*
9013 * Peer's end-entity certificate
9014 */
9015#if defined(MBEDTLS_X509_CRT_PARSE_C)
9016#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009018 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009020 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009022
9023 used += 3 + cert_len;
9024
Gilles Peskine449bd832023-01-11 14:50:10 +01009025 if (used <= buf_len) {
9026 *p++ = MBEDTLS_BYTE_2(cert_len);
9027 *p++ = MBEDTLS_BYTE_1(cert_len);
9028 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (session->peer_cert != NULL) {
9031 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032 p += cert_len;
9033 }
9034 }
9035#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01009036 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009037 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009039 *p++ = (unsigned char) session->peer_cert_digest_type;
9040 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 memcpy(p, session->peer_cert_digest,
9042 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009043 p += session->peer_cert_digest_len;
9044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009046 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009048 *p++ = (unsigned char) MBEDTLS_MD_NONE;
9049 *p++ = 0;
9050 }
9051 }
9052#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9053#endif /* MBEDTLS_X509_CRT_PARSE_C */
9054
9055 /*
9056 * Session ticket if any, plus associated data
9057 */
9058#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9059 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
9060
Gilles Peskine449bd832023-01-11 14:50:10 +01009061 if (used <= buf_len) {
9062 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
9063 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
9064 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 if (session->ticket != NULL) {
9067 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009068 p += session->ticket_len;
9069 }
9070
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009072 p += 4;
9073 }
9074#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9075
9076 /*
9077 * Misc extension-related info
9078 */
9079#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
9080 used += 1;
9081
Gilles Peskine449bd832023-01-11 14:50:10 +01009082 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009083 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01009084 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009085#endif
9086
9087#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
9088 used += 1;
9089
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 if (used <= buf_len) {
9091 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
9092 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009093#endif
9094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009096}
9097
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009098MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009099static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9100 const unsigned char *buf,
9101 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009102{
9103#if defined(MBEDTLS_HAVE_TIME)
9104 uint64_t start;
9105#endif
9106#if defined(MBEDTLS_X509_CRT_PARSE_C)
9107#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9108 size_t cert_len;
9109#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9110#endif /* MBEDTLS_X509_CRT_PARSE_C */
9111
9112 const unsigned char *p = buf;
9113 const unsigned char * const end = buf + len;
9114
9115 /*
9116 * Time
9117 */
9118#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 if (8 > (size_t) (end - p)) {
9120 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9121 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009122
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009123 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009124 p += 8;
9125
9126 session->start = (time_t) start;
9127#endif /* MBEDTLS_HAVE_TIME */
9128
9129 /*
9130 * Basic mandatory fields
9131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9134 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009135
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009136 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009137 p += 2;
9138
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009140 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009141 p += 32;
9142
Gilles Peskine449bd832023-01-11 14:50:10 +01009143 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144 p += 48;
9145
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009146 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009147 p += 4;
9148
9149 /* Immediately clear invalid pointer values that have been read, in case
9150 * we exit early before we replaced them with valid ones. */
9151#if defined(MBEDTLS_X509_CRT_PARSE_C)
9152#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9153 session->peer_cert = NULL;
9154#else
9155 session->peer_cert_digest = NULL;
9156#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9157#endif /* MBEDTLS_X509_CRT_PARSE_C */
9158#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9159 session->ticket = NULL;
9160#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9161
9162 /*
9163 * Peer certificate
9164 */
9165#if defined(MBEDTLS_X509_CRT_PARSE_C)
9166#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9167 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 if (3 > (size_t) (end - p)) {
9169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9170 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009172 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009173 p += 3;
9174
Gilles Peskine449bd832023-01-11 14:50:10 +01009175 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009176 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9177
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if (cert_len > (size_t) (end - p)) {
9179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9180 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009181
Gilles Peskine449bd832023-01-11 14:50:10 +01009182 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if (session->peer_cert == NULL) {
9185 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9186 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009187
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9191 p, cert_len)) != 0) {
9192 mbedtls_x509_crt_free(session->peer_cert);
9193 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009194 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009195 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009196 }
9197
9198 p += cert_len;
9199 }
9200#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9201 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 if (2 > (size_t) (end - p)) {
9203 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9204 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009205
9206 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9207 session->peer_cert_digest_len = (size_t) *p++;
9208
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009210 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009211 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9212 if (md_info == NULL) {
9213 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9214 }
9215 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9216 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9217 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009218
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9220 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9221 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009222
9223 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 mbedtls_calloc(1, session->peer_cert_digest_len);
9225 if (session->peer_cert_digest == NULL) {
9226 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9227 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009228
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 memcpy(session->peer_cert_digest, p,
9230 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009231 p += session->peer_cert_digest_len;
9232 }
9233#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9234#endif /* MBEDTLS_X509_CRT_PARSE_C */
9235
9236 /*
9237 * Session ticket and associated data
9238 */
9239#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 if (3 > (size_t) (end - p)) {
9241 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9242 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009243
Dave Rodgmana3d0f612023-11-03 23:34:02 +00009244 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009245 p += 3;
9246
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 if (session->ticket_len != 0) {
9248 if (session->ticket_len > (size_t) (end - p)) {
9249 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9250 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009251
Gilles Peskine449bd832023-01-11 14:50:10 +01009252 session->ticket = mbedtls_calloc(1, session->ticket_len);
9253 if (session->ticket == NULL) {
9254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9255 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009256
Gilles Peskine449bd832023-01-11 14:50:10 +01009257 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009258 p += session->ticket_len;
9259 }
9260
Gilles Peskine449bd832023-01-11 14:50:10 +01009261 if (4 > (size_t) (end - p)) {
9262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9263 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009264
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009265 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009266 p += 4;
9267#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9268
9269 /*
9270 * Misc extension-related info
9271 */
9272#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009273 if (1 > (size_t) (end - p)) {
9274 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9275 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009276
9277 session->mfl_code = *p++;
9278#endif
9279
9280#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009281 if (1 > (size_t) (end - p)) {
9282 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9283 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009284
9285 session->encrypt_then_mac = *p++;
9286#endif
9287
9288 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009289 if (p != end) {
9290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9291 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009292
Gilles Peskine449bd832023-01-11 14:50:10 +01009293 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009294}
Jerry Yudc7bd172022-02-17 13:44:15 +08009295#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9296
XiaokangQian75d40ef2022-04-20 11:05:24 +00009297int mbedtls_ssl_validate_ciphersuite(
9298 const mbedtls_ssl_context *ssl,
9299 const mbedtls_ssl_ciphersuite_t *suite_info,
9300 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009301 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009302{
9303 (void) ssl;
9304
Gilles Peskine449bd832023-01-11 14:50:10 +01009305 if (suite_info == NULL) {
9306 return -1;
9307 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009308
Gilles Peskine449bd832023-01-11 14:50:10 +01009309 if ((suite_info->min_tls_version > max_tls_version) ||
9310 (suite_info->max_tls_version < min_tls_version)) {
9311 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009312 }
9313
XiaokangQian060d8672022-04-21 09:24:56 +00009314#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009315#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009316#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009317 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9318 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009319#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9321 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009322#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009323 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009324 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009325 }
9326#endif
9327
9328 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9329#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9331 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9332 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009333 }
9334#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009338}
9339
Ronald Crone68ab4f2022-10-05 12:46:29 +02009340#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009341/*
9342 * Function for writing a signature algorithm extension.
9343 *
9344 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9345 * value (TLS 1.3 RFC8446):
9346 * enum {
9347 * ....
9348 * ecdsa_secp256r1_sha256( 0x0403 ),
9349 * ecdsa_secp384r1_sha384( 0x0503 ),
9350 * ecdsa_secp521r1_sha512( 0x0603 ),
9351 * ....
9352 * } SignatureScheme;
9353 *
9354 * struct {
9355 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9356 * } SignatureSchemeList;
9357 *
9358 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9359 * value (TLS 1.2 RFC5246):
9360 * enum {
9361 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9362 * sha512(6), (255)
9363 * } HashAlgorithm;
9364 *
9365 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9366 * SignatureAlgorithm;
9367 *
9368 * struct {
9369 * HashAlgorithm hash;
9370 * SignatureAlgorithm signature;
9371 * } SignatureAndHashAlgorithm;
9372 *
9373 * SignatureAndHashAlgorithm
9374 * supported_signature_algorithms<2..2^16-2>;
9375 *
9376 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9377 * generalization of the TLS 1.2 signature algorithm extension.
9378 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9379 * `SignatureScheme` field of TLS 1.3
9380 *
9381 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009382int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9383 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009384{
9385 unsigned char *p = buf;
9386 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9387 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9388
9389 *out_len = 0;
9390
Gilles Peskine449bd832023-01-11 14:50:10 +01009391 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009392
9393 /* Check if we have space for header and length field:
9394 * - extension_type (2 bytes)
9395 * - extension_data_length (2 bytes)
9396 * - supported_signature_algorithms_length (2 bytes)
9397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009398 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009399 p += 6;
9400
9401 /*
9402 * Write supported_signature_algorithms
9403 */
9404 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009405 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9406 if (sig_alg == NULL) {
9407 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9408 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009409
Gilles Peskine449bd832023-01-11 14:50:10 +01009410 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9411 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9412 *sig_alg,
9413 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9414 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009415 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 }
9417 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9418 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009419 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009420 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9421 *sig_alg,
9422 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009423 }
9424
9425 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009426 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009427 if (supported_sig_alg_len == 0) {
9428 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9429 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009430 }
9431
Gilles Peskine449bd832023-01-11 14:50:10 +01009432 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9433 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9434 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009435
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009436 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009437
9438#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009440#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009441
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009443}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009444#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009445
XiaokangQian40a35232022-05-07 09:02:40 +00009446#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009447/*
9448 * mbedtls_ssl_parse_server_name_ext
9449 *
9450 * Structure of server_name extension:
9451 *
9452 * enum {
9453 * host_name(0), (255)
9454 * } NameType;
9455 * opaque HostName<1..2^16-1>;
9456 *
9457 * struct {
9458 * NameType name_type;
9459 * select (name_type) {
9460 * case host_name: HostName;
9461 * } name;
9462 * } ServerName;
9463 * struct {
9464 * ServerName server_name_list<1..2^16-1>
9465 * } ServerNameList;
9466 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009467MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009468int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9469 const unsigned char *buf,
9470 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009471{
9472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9473 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009474 size_t server_name_list_len, hostname_len;
9475 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009476
Gilles Peskine449bd832023-01-11 14:50:10 +01009477 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9480 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009481 p += 2;
9482
Gilles Peskine449bd832023-01-11 14:50:10 +01009483 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009484 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 while (p < server_name_list_end) {
9486 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9487 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9488 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9489 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009490
Gilles Peskine449bd832023-01-11 14:50:10 +01009491 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009492 /* sni_name is intended to be used only during the parsing of the
9493 * ClientHello message (it is reset to NULL before the end of
9494 * the message parsing). Thus it is ok to just point to the
9495 * reception buffer and not make a copy of it.
9496 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009497 ssl->handshake->sni_name = p + 3;
9498 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 if (ssl->conf->f_sni == NULL) {
9500 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009501 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9503 ssl, p + 3, hostname_len);
9504 if (ret != 0) {
9505 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9506 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9507 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9508 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9509 }
9510 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009511 }
9512
9513 p += hostname_len + 3;
9514 }
9515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009517}
9518#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9519
XiaokangQianacb39922022-06-17 10:18:48 +00009520#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009522int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9523 const unsigned char *buf,
9524 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009525{
9526 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009527 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009528 const unsigned char *protocol_name_list;
9529 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009530 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009531
9532 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 if (ssl->conf->alpn_list == NULL) {
9534 return 0;
9535 }
XiaokangQianacb39922022-06-17 10:18:48 +00009536
9537 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009538 * RFC7301, section 3.1
9539 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009540 *
XiaokangQianc7403452022-06-23 03:24:12 +00009541 * struct {
9542 * ProtocolName protocol_name_list<2..2^16-1>
9543 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009544 */
9545
XiaokangQianc7403452022-06-23 03:24:12 +00009546 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009547 * protocol_name_list_len 2 bytes
9548 * protocol_name_len 1 bytes
9549 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009551 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009552
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009554 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009556 protocol_name_list = p;
9557 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009558
9559 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009561 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9563 protocol_name_len);
9564 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009565 MBEDTLS_SSL_PEND_FATAL_ALERT(
9566 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009567 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9568 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009569 }
9570
9571 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009572 }
9573
9574 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9576 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009577 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009579 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 if (protocol_name_len == alpn_len &&
9581 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009582 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009584 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009585
9586 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009587 }
9588 }
9589
XiaokangQian95d5f542022-06-24 02:29:26 +00009590 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009591 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9593 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9594 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009595}
9596
Gilles Peskine449bd832023-01-11 14:50:10 +01009597int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9598 unsigned char *buf,
9599 unsigned char *end,
9600 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009601{
9602 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009603 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009604 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009605
Gilles Peskine449bd832023-01-11 14:50:10 +01009606 if (ssl->alpn_chosen == NULL) {
9607 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009608 }
9609
Gilles Peskine449bd832023-01-11 14:50:10 +01009610 protocol_name_len = strlen(ssl->alpn_chosen);
9611 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009612
Gilles Peskine449bd832023-01-11 14:50:10 +01009613 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009614 /*
9615 * 0 . 1 ext identifier
9616 * 2 . 3 ext length
9617 * 4 . 5 protocol list length
9618 * 6 . 6 protocol name length
9619 * 7 . 7+n protocol name
9620 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009622
XiaokangQian95d5f542022-06-24 02:29:26 +00009623 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009624
Gilles Peskine449bd832023-01-11 14:50:10 +01009625 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9626 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009627 /* Note: the length of the chosen protocol has been checked to be less
9628 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009630 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009631
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009633
9634#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009636#endif
9637
Gilles Peskine449bd832023-01-11 14:50:10 +01009638 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009639}
9640#endif /* MBEDTLS_SSL_ALPN */
9641
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009642#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009643 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009644 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009645 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009646int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9647 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009648{
9649 /* Initialize to suppress unnecessary compiler warning */
9650 size_t hostname_len = 0;
9651
9652 /* Check if new hostname is valid before
9653 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009654 if (hostname != NULL) {
9655 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009656
Gilles Peskine449bd832023-01-11 14:50:10 +01009657 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9659 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009660 }
9661
9662 /* Now it's clear that we will overwrite the old hostname,
9663 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009664 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009665 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009666 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009667 }
9668
9669 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009670 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009671 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009672 } else {
9673 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9674 if (session->hostname == NULL) {
9675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9676 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009677
Gilles Peskine449bd832023-01-11 14:50:10 +01009678 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009679 }
9680
Gilles Peskine449bd832023-01-11 14:50:10 +01009681 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009682}
Xiaokang Qian03409292022-10-12 02:49:52 +00009683#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9684 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009685 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009686 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009688#endif /* MBEDTLS_SSL_TLS_C */