blob: 2a2bd8f57f844ce22935c72441064a469c361ab4 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500309 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Jerry Yu60835a82021-08-04 10:13:52 +08001358 /* Space for further checks */
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001361}
1362
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001363/*
1364 * Setup an SSL context
1365 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1368 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001369{
Janos Follath865b3eb2019-12-16 11:46:15 +00001370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001371 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1372 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001374 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if ((ret = ssl_conf_check(ssl)) != 0) {
1377 return ret;
1378 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001379 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001380
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001382 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001383 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001384
1385 /* Set to NULL in case of an error condition */
1386 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001387
Darryl Greenb33cc762019-11-28 14:29:44 +00001388#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1389 ssl->in_buf_len = in_buf_len;
1390#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1392 if (ssl->in_buf == NULL) {
1393 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001394 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001395 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001396 }
1397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->out_buf_len = out_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1402 if (ssl->out_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001409
Johan Pascalb62bb512015-12-03 21:56:45 +01001410#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001412#endif
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419
1420error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_free(ssl->in_buf);
1422 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424 ssl->conf = NULL;
1425
Darryl Greenb33cc762019-11-28 14:29:44 +00001426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1427 ssl->in_buf_len = 0;
1428 ssl->out_buf_len = 0;
1429#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001430 ssl->in_buf = NULL;
1431 ssl->out_buf = NULL;
1432
1433 ssl->in_hdr = NULL;
1434 ssl->in_ctr = NULL;
1435 ssl->in_len = NULL;
1436 ssl->in_iv = NULL;
1437 ssl->in_msg = NULL;
1438
1439 ssl->out_hdr = NULL;
1440 ssl->out_ctr = NULL;
1441 ssl->out_len = NULL;
1442 ssl->out_iv = NULL;
1443 ssl->out_msg = NULL;
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
1448/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001449 * Reset an initialized and used SSL context for re-use while retaining
1450 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001451 *
1452 * If partial is non-zero, keep data in the input buffer and client ID.
1453 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1456 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457{
Darryl Greenb33cc762019-11-28 14:29:44 +00001458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1459 size_t in_buf_len = ssl->in_buf_len;
1460 size_t out_buf_len = ssl->out_buf_len;
1461#else
1462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1463 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1464#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001465
Hanno Beckerb0302c42021-08-03 09:39:42 +01001466#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1467 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001468#endif
1469
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001470 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474
1475 /* Reset incoming message parsing */
1476 ssl->in_offt = NULL;
1477 ssl->nb_zero = 0;
1478 ssl->in_msgtype = 0;
1479 ssl->in_msglen = 0;
1480 ssl->in_hslen = 0;
1481 ssl->keep_current_message = 0;
1482 ssl->transform_in = NULL;
1483
1484#if defined(MBEDTLS_SSL_PROTO_DTLS)
1485 ssl->next_record_offset = 0;
1486 ssl->in_epoch = 0;
1487#endif
1488
1489 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001491 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493 }
1494
Ronald Cronad8c17b2022-06-10 17:18:09 +02001495 ssl->send_alert = 0;
1496
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 /* Reset outgoing message writing */
1498 ssl->out_msgtype = 0;
1499 ssl->out_msglen = 0;
1500 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 memset(ssl->out_buf, 0, out_buf_len);
1502 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->transform_out = NULL;
1504
1505#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507#endif
1508
XiaokangQian2b01dc32022-01-21 02:53:13 +00001509#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (ssl->transform) {
1511 mbedtls_ssl_transform_free(ssl->transform);
1512 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform = NULL;
1514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1516
XiaokangQian2b01dc32022-01-21 02:53:13 +00001517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_transform_free(ssl->transform_application);
1519 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 ssl->transform_application = NULL;
1521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001523#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1525 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1530 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_handshake = NULL;
1532 }
1533
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538{
1539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1540
1541 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
1545 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_RENEGOTIATION)
1547 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001549
1550 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1552 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001557 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session) {
1559 mbedtls_ssl_session_free(ssl->session);
1560 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001561 ssl->session = NULL;
1562 }
1563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001565 ssl->alpn_chosen = NULL;
1566#endif
1567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001569 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (free_cli_id) {
1574 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001575 ssl->cli_id = NULL;
1576 ssl->cli_id_len = 0;
1577 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001578#endif
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if ((ret = ssl_handshake_init(ssl)) != 0) {
1581 return ret;
1582 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001585}
1586
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001587/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 * Reset an initialized and used SSL context for re-use while retaining
1589 * all application-set variables, function pointers and data.
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592{
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594}
1595
1596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 * SSL set accessors
1598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001601 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001602}
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607}
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613}
1614#endif
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1624 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001625{
1626 ssl->disable_datagram_packing = !allow_packing;
1627}
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1630 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->hs_timeout_min = min;
1633 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1644 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1645 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001647 conf->f_vrfy = f_vrfy;
1648 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1653 int (*f_rng)(void *, unsigned char *, size_t),
1654 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001656 conf->f_rng = f_rng;
1657 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1661 void (*f_dbg)(void *, int, const char *, int, const char *),
1662 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_dbg = f_dbg;
1665 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001666}
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1669 void *p_bio,
1670 mbedtls_ssl_send_t *f_send,
1671 mbedtls_ssl_recv_t *f_recv,
1672 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001673{
1674 ssl->p_bio = p_bio;
1675 ssl->f_send = f_send;
1676 ssl->f_recv = f_recv;
1677 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001678}
1679
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682{
1683 ssl->mtu = mtu;
1684}
1685#endif
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688{
1689 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690}
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1693 void *p_timer,
1694 mbedtls_ssl_set_timer_t *f_set_timer,
1695 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696{
1697 ssl->p_timer = p_timer;
1698 ssl->f_set_timer = f_set_timer;
1699 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001700
1701 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703}
1704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001706void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1707 void *p_cache,
1708 mbedtls_ssl_cache_get_t *f_get_cache,
1709 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001710{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001711 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723 session == NULL ||
1724 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (ssl->handshake->resume == 1) {
1730 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1731 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001732
Jerry Yu21092062022-10-10 21:21:31 +08001733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001735 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001739 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1741 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1742 session->ciphersuite));
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001744 }
Jerry Yu40afab62022-10-08 10:42:13 +08001745 }
Jerry Yu21092062022-10-10 21:21:31 +08001746#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1749 session)) != 0) {
1750 return ret;
1751 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001752
Paul Bakker0a597072012-09-25 21:55:46 +00001753 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1760 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001761{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001762 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001763}
1764
Ronald Cron6f135e12021-12-08 16:57:54 +01001765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1767 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001768{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001769 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001771
1772#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001773void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1774 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001775{
1776 conf->early_data_enabled = early_data_enabled;
1777}
Jerry Yucc4e0072022-11-22 17:22:22 +08001778
1779#if defined(MBEDTLS_SSL_SRV_C)
1780void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001782{
Jerry Yu39da9852022-12-06 16:58:36 +08001783 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001784}
1785#endif /* MBEDTLS_SSL_SRV_C */
1786
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1792 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001793{
1794 conf->cert_profile = profile;
1795}
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001798{
1799 mbedtls_ssl_key_cert *cur = key_cert, *next;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001802 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 cur = next;
1805 }
1806}
1807
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001808/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1811 mbedtls_x509_crt *cert,
1812 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001813{
niisato8ee24222018-06-25 19:05:48 +09001814 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1824 if (new_cert == NULL) {
1825 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1826 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
niisato8ee24222018-06-25 19:05:48 +09001828 new_cert->cert = cert;
1829 new_cert->key = key;
1830 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001834 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001836 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 }
niisato8ee24222018-06-25 19:05:48 +09001840 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844}
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849{
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851}
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001854 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001856{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 conf->ca_chain = ca_chain;
1858 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001859
1860#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1861 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1862 * cannot be used together. */
1863 conf->f_ca_cb = NULL;
1864 conf->p_ca_cb = NULL;
1865#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
Hanno Becker5adaad92019-03-27 16:54:37 +00001867
1868#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1871 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001872{
1873 conf->f_ca_cb = f_ca_cb;
1874 conf->p_ca_cb = p_ca_cb;
1875
1876 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1877 * cannot be used together. */
1878 conf->ca_chain = NULL;
1879 conf->ca_crl = NULL;
1880}
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001883
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001884#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1886 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001887{
1888 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001890}
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1893 mbedtls_x509_crt *own_cert,
1894 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895{
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1897 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1901 mbedtls_x509_crt *ca_chain,
1902 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001903{
1904 ssl->handshake->sni_ca_chain = ca_chain;
1905 ssl->handshake->sni_ca_crl = ca_crl;
1906}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001907
Glenn Strauss999ef702022-03-11 01:37:23 -05001908#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1910 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001911{
1912 ssl->handshake->dn_hints = crt;
1913}
1914#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1917 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918{
1919 ssl->handshake->sni_authmode = authmode;
1920}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1922
Hanno Becker8927c832019-04-03 12:52:50 +01001923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001924void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1926 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001927{
1928 ssl->f_vrfy = f_vrfy;
1929 ssl->p_vrfy = p_vrfy;
1930}
1931#endif
1932
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Valerio Setti016f6822022-12-09 14:17:50 +01001935#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001936static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1937static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1938
Valerio Setti016f6822022-12-09 14:17:50 +01001939static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 mbedtls_ssl_context *ssl,
1941 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001942{
1943 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001944 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001945 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001946 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1950 psa_pake_cs_set_primitive(&cipher_suite,
1951 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1952 PSA_ECC_FAMILY_SECP_R1,
1953 256));
1954 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1957 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001962 user = jpake_server_id;
1963 user_len = sizeof(jpake_server_id);
1964 peer = jpake_client_id;
1965 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_client_id;
1968 user_len = sizeof(jpake_client_id);
1969 peer = jpake_server_id;
1970 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001972
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1974 if (status != PSA_SUCCESS) {
1975 return status;
1976 }
1977
1978 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001980 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
1988 ssl->handshake->psa_pake_ctx_is_ok = 1;
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1994 const unsigned char *pw,
1995 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001996{
1997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1998 psa_status_t status;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (ssl->handshake == NULL || ssl->conf == NULL) {
2001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 /* Empty password is not valid */
2005 if ((pw == NULL) || (pw_len == 0)) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2007 }
2008
2009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2010 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2011 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2012
2013 status = psa_import_key(&attributes, pw, pw_len,
2014 &ssl->handshake->psa_pake_password);
2015 if (status != PSA_SUCCESS) {
2016 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2017 }
2018
2019 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2020 ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 psa_destroy_key(ssl->handshake->psa_pake_password);
2023 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2024 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2025 }
2026
2027 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002028}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2031 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033 psa_status_t status;
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (ssl->handshake == NULL || ssl->conf == NULL) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (mbedtls_svc_key_id_is_null(pwd)) {
2040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2041 }
2042
2043 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2044 if (status != PSA_SUCCESS) {
2045 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2046 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2047 }
2048
2049 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002050}
2051#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2053 const unsigned char *pw,
2054 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002055{
2056 mbedtls_ecjpake_role role;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ssl->handshake == NULL || ssl->conf == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061
Valerio Settic689ed82022-12-07 14:40:38 +01002062 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if ((pw == NULL) || (pw_len == 0)) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Valerio Settic689ed82022-12-07 14:40:38 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2074 role,
2075 MBEDTLS_MD_SHA256,
2076 MBEDTLS_ECP_DP_SECP256R1,
2077 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078}
Valerio Setti02c25b52022-11-15 14:08:42 +01002079#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002080#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002084{
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (conf->psk_identity == NULL ||
2086 conf->psk_identity_len == 0) {
2087 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002088 }
2089
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2092 return 1;
2093 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk != NULL && conf->psk_len != 0) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
2105 /* Remove reference to existing PSK, if any. */
2106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108 /* The maintenance of the PSK key slot is the
2109 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002114 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115 conf->psk = NULL;
2116 conf->psk_len = 0;
2117 }
2118
2119 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (conf->psk_identity != NULL) {
2121 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk_identity = NULL;
2123 conf->psk_identity_len = 0;
2124 }
2125}
2126
Hanno Becker7390c712018-11-15 13:33:04 +00002127/* This function assumes that PSK identity in the SSL config is unset.
2128 * It checks that the provided identity is well-formed and attempts
2129 * to make a copy of it in the SSL config.
2130 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002132static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2133 unsigned char const *psk_identity,
2134 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002135{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002136 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002138 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 (psk_identity_len >> 16) != 0 ||
2140 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2145 if (conf->psk_identity == NULL) {
2146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2147 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002148
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002149 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002153}
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2156 const unsigned char *psk, size_t psk_len,
2157 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002160
2161 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2163 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2164 }
Hanno Becker7390c712018-11-15 13:33:04 +00002165
2166 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (psk == NULL) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2169 }
2170 if (psk_len == 0) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2178 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002182
2183 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2185 if (ret != 0) {
2186 ssl_conf_remove_psk(conf);
2187 }
Hanno Becker7390c712018-11-15 13:33:04 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002193{
2194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002196 /* The maintenance of the external PSK key slot is the
2197 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->psk_opaque_is_internal) {
2199 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002200 ssl->handshake->psk_opaque_is_internal = 0;
2201 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002202 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203 }
Neil Armstronge952a302022-05-03 10:22:14 +02002204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002206 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 ssl->handshake->psk_len = 0;
2209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211}
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2214 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002215{
Neil Armstrong501c9322022-05-03 09:35:09 +02002216#if defined(MBEDTLS_USE_PSA_CRYPTO)
2217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002219 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (psk == NULL || ssl->handshake == NULL) {
2224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2225 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2229 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2236 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2237 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2238 } else {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2240 }
2241 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002242 }
2243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002244
Jerry Yu568ec252022-07-22 21:27:34 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2247 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2248 psa_set_key_usage_flags(&key_attributes,
2249 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 psa_set_key_algorithm(&key_attributes, alg);
2254 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2257 if (status != PSA_SUCCESS) {
2258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2259 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
2261 /* Allow calling psa_destroy_key() on psk remove */
2262 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002264#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
2269 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274}
2275
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002276#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002277int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2278 mbedtls_svc_key_id_t psk,
2279 const unsigned char *psk_identity,
2280 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281{
Janos Follath865b3eb2019-12-16 11:46:15 +00002282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002283
2284 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2287 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288
Hanno Becker7390c712018-11-15 13:33:04 +00002289 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_svc_key_id_is_null(psk)) {
2291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2292 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002293 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002294
2295 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2297 psk_identity_len);
2298 if (ret != 0) {
2299 ssl_conf_remove_psk(conf);
2300 }
Hanno Becker7390c712018-11-15 13:33:04 +00002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2306 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002307{
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((mbedtls_svc_key_id_is_null(psk)) ||
2309 (ssl->handshake == NULL)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316}
2317#endif /* MBEDTLS_USE_PSA_CRYPTO */
2318
Jerry Yu8897c072022-08-12 13:56:53 +08002319#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2321 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2322 size_t),
2323 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324{
2325 conf->f_psk = f_psk;
2326 conf->p_psk = p_psk;
2327}
Jerry Yu8897c072022-08-12 13:56:53 +08002328#endif /* MBEDTLS_SSL_SRV_C */
2329
Ronald Cron73fe8df2022-10-05 14:31:43 +02002330#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
2332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002333static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (alg == PSA_ALG_CBC_NO_PADDING) {
2338 return MBEDTLS_SSL_MODE_CBC;
2339 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (PSA_ALG_IS_AEAD(alg)) {
2342 return MBEDTLS_SSL_MODE_AEAD;
2343 }
2344 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002345}
2346
2347#else /* MBEDTLS_USE_PSA_CRYPTO */
2348
2349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002351{
2352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (mode == MBEDTLS_MODE_CBC) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2357
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358#if defined(MBEDTLS_GCM_C) || \
2359 defined(MBEDTLS_CCM_C) || \
2360 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mode == MBEDTLS_MODE_CHACHAPOLY) {
2364 return MBEDTLS_SSL_MODE_AEAD;
2365 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369}
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371
Gilles Peskinee108d982022-04-26 16:50:40 +02002372static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2373 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002375{
2376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2378 base_mode == MBEDTLS_SSL_MODE_CBC) {
2379 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002380 }
2381#else
2382 (void) encrypt_then_mac;
2383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385}
2386
Neil Armstrongab555e02022-04-04 11:07:59 +02002387mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002389{
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002395#endif
2396 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 encrypt_then_mac = transform->encrypt_then_mac;
2401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403}
2404
Neil Armstrongab555e02022-04-04 11:07:59 +02002405mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410{
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2412
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413#if defined(MBEDTLS_USE_PSA_CRYPTO)
2414 psa_status_t status;
2415 psa_algorithm_t alg;
2416 psa_key_type_t type;
2417 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002418 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2419 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (status == PSA_SUCCESS) {
2421 base_mode = mbedtls_ssl_get_base_mode(alg);
2422 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#else
2424 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002425 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 base_mode =
2428 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#endif /* MBEDTLS_USE_PSA_CRYPTO */
2432
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2434 int encrypt_then_mac = 0;
2435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437}
2438
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002439#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002440
2441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002442/* Serialization of TLS 1.3 sessions:
2443 *
2444 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002445 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002446 * uint64 ticket_received;
2447 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002448 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * } ClientOnlyData;
2450 *
2451 * struct {
2452 * uint8 endpoint;
2453 * uint8 ciphersuite[2];
2454 * uint32 ticket_age_add;
2455 * uint8 ticket_flags;
2456 * opaque resumption_key<0..255>;
2457 * select ( endpoint ) {
2458 * case client: ClientOnlyData;
2459 * case server: uint64 start_time;
2460 * };
2461 * } serialized_session_tls13;
2462 *
2463 */
2464#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002465MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002466static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2467 unsigned char *buf,
2468 size_t buf_len,
2469 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002470{
2471 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002472#if defined(MBEDTLS_SSL_CLI_C) && \
2473 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 size_t hostname_len = (session->hostname == NULL) ?
2475 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002476#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002477 size_t needed = 1 /* endpoint */
2478 + 2 /* ciphersuite */
2479 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002480 + 1 /* ticket_flags */
2481 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002482 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2485 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2486 }
Jerry Yu34191072022-08-18 10:32:09 +08002487 needed += session->resumption_key_len; /* resumption_key */
2488
Jerry Yu438ddd82022-07-07 06:55:50 +00002489#if defined(MBEDTLS_HAVE_TIME)
2490 needed += 8; /* start_time or ticket_received */
2491#endif
2492
2493#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002495#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002496 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002498#endif
2499
Jerry Yu438ddd82022-07-07 06:55:50 +00002500 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002501 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002502
2503 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 if (session->ticket_len > SIZE_MAX - needed) {
2505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2506 }
Jerry Yu34191072022-08-18 10:32:09 +08002507
Jerry Yue28d9742022-08-18 15:44:03 +08002508 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002509 }
2510#endif /* MBEDTLS_SSL_CLI_C */
2511
Jerry Yue36fdd62022-08-17 21:31:36 +08002512 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (needed > buf_len) {
2514 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2515 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002516
2517 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2519 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002520 p[7] = session->ticket_flags;
2521
2522 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002523 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002524 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002526 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002527
2528#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2530 MBEDTLS_PUT_UINT64_BE((uint64_t) session->start, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002531 p += 8;
2532 }
2533#endif /* MBEDTLS_HAVE_TIME */
2534
2535#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002537#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002539 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002541 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002543 p += hostname_len;
2544 }
2545#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2546
Jerry Yu438ddd82022-07-07 06:55:50 +00002547#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002549 p += 8;
2550#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002552 p += 4;
2553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002555 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 if (session->ticket != NULL && session->ticket_len > 0) {
2558 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += session->ticket_len;
2560 }
2561 }
2562#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002564}
2565
2566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002567static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2568 const unsigned char *buf,
2569 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002570{
2571 const unsigned char *p = buf;
2572 const unsigned char *end = buf + len;
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 if (end - p < 9) {
2575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2576 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002577 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2579 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002580 session->ticket_flags = p[7];
2581
2582 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002583 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002584 p += 9;
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (end - p < session->resumption_key_len) {
2587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2588 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2592 }
2593 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002594 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002595
2596#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2598 if (end - p < 8) {
2599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2600 }
2601 session->start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002602 p += 8;
2603 }
2604#endif /* MBEDTLS_HAVE_TIME */
2605
2606#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002608#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002610 size_t hostname_len;
2611 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (end - p < 2) {
2613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2614 }
2615 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002616 p += 2;
2617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (end - p < (long int) hostname_len) {
2619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2620 }
2621 if (hostname_len > 0) {
2622 session->hostname = mbedtls_calloc(1, hostname_len);
2623 if (session->hostname == NULL) {
2624 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2625 }
2626 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002627 p += hostname_len;
2628 }
2629#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2630 MBEDTLS_SSL_SESSION_TICKETS */
2631
Jerry Yu438ddd82022-07-07 06:55:50 +00002632#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (end - p < 8) {
2634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2635 }
2636 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002637 p += 8;
2638#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 if (end - p < 4) {
2640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2641 }
2642 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002643 p += 4;
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 if (end - p < 2) {
2646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2647 }
2648 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002649 p += 2;
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < (long int) session->ticket_len) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 if (session->ticket_len > 0) {
2655 session->ticket = mbedtls_calloc(1, session->ticket_len);
2656 if (session->ticket == NULL) {
2657 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2658 }
2659 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002660 p += session->ticket_len;
2661 }
2662 }
2663#endif /* MBEDTLS_SSL_CLI_C */
2664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002666
2667}
2668#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002669MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002670static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2671 unsigned char *buf,
2672 size_t buf_len,
2673 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002674{
2675 ((void) session);
2676 ((void) buf);
2677 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002678 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002680}
Jerry Yu438ddd82022-07-07 06:55:50 +00002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2683 unsigned char *buf,
2684 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002685{
2686 ((void) session);
2687 ((void) buf);
2688 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002690}
2691#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002692#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2695 size_t taglen,
2696 psa_algorithm_t *alg,
2697 psa_key_type_t *key_type,
2698 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002699{
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002701 case MBEDTLS_CIPHER_AES_128_CBC:
2702 *alg = PSA_ALG_CBC_NO_PADDING;
2703 *key_type = PSA_KEY_TYPE_AES;
2704 *key_size = 128;
2705 break;
2706 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002708 *key_type = PSA_KEY_TYPE_AES;
2709 *key_size = 128;
2710 break;
2711 case MBEDTLS_CIPHER_AES_128_GCM:
2712 *alg = PSA_ALG_GCM;
2713 *key_type = PSA_KEY_TYPE_AES;
2714 *key_size = 128;
2715 break;
2716 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002718 *key_type = PSA_KEY_TYPE_AES;
2719 *key_size = 192;
2720 break;
2721 case MBEDTLS_CIPHER_AES_192_GCM:
2722 *alg = PSA_ALG_GCM;
2723 *key_type = PSA_KEY_TYPE_AES;
2724 *key_size = 192;
2725 break;
2726 case MBEDTLS_CIPHER_AES_256_CBC:
2727 *alg = PSA_ALG_CBC_NO_PADDING;
2728 *key_type = PSA_KEY_TYPE_AES;
2729 *key_size = 256;
2730 break;
2731 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002733 *key_type = PSA_KEY_TYPE_AES;
2734 *key_size = 256;
2735 break;
2736 case MBEDTLS_CIPHER_AES_256_GCM:
2737 *alg = PSA_ALG_GCM;
2738 *key_type = PSA_KEY_TYPE_AES;
2739 *key_size = 256;
2740 break;
2741 case MBEDTLS_CIPHER_ARIA_128_CBC:
2742 *alg = PSA_ALG_CBC_NO_PADDING;
2743 *key_type = PSA_KEY_TYPE_ARIA;
2744 *key_size = 128;
2745 break;
2746 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002748 *key_type = PSA_KEY_TYPE_ARIA;
2749 *key_size = 128;
2750 break;
2751 case MBEDTLS_CIPHER_ARIA_128_GCM:
2752 *alg = PSA_ALG_GCM;
2753 *key_type = PSA_KEY_TYPE_ARIA;
2754 *key_size = 128;
2755 break;
2756 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002758 *key_type = PSA_KEY_TYPE_ARIA;
2759 *key_size = 192;
2760 break;
2761 case MBEDTLS_CIPHER_ARIA_192_GCM:
2762 *alg = PSA_ALG_GCM;
2763 *key_type = PSA_KEY_TYPE_ARIA;
2764 *key_size = 192;
2765 break;
2766 case MBEDTLS_CIPHER_ARIA_256_CBC:
2767 *alg = PSA_ALG_CBC_NO_PADDING;
2768 *key_type = PSA_KEY_TYPE_ARIA;
2769 *key_size = 256;
2770 break;
2771 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002773 *key_type = PSA_KEY_TYPE_ARIA;
2774 *key_size = 256;
2775 break;
2776 case MBEDTLS_CIPHER_ARIA_256_GCM:
2777 *alg = PSA_ALG_GCM;
2778 *key_type = PSA_KEY_TYPE_ARIA;
2779 *key_size = 256;
2780 break;
2781 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2782 *alg = PSA_ALG_CBC_NO_PADDING;
2783 *key_type = PSA_KEY_TYPE_CAMELLIA;
2784 *key_size = 128;
2785 break;
2786 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002788 *key_type = PSA_KEY_TYPE_CAMELLIA;
2789 *key_size = 128;
2790 break;
2791 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2792 *alg = PSA_ALG_GCM;
2793 *key_type = PSA_KEY_TYPE_CAMELLIA;
2794 *key_size = 128;
2795 break;
2796 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002798 *key_type = PSA_KEY_TYPE_CAMELLIA;
2799 *key_size = 192;
2800 break;
2801 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2802 *alg = PSA_ALG_GCM;
2803 *key_type = PSA_KEY_TYPE_CAMELLIA;
2804 *key_size = 192;
2805 break;
2806 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2807 *alg = PSA_ALG_CBC_NO_PADDING;
2808 *key_type = PSA_KEY_TYPE_CAMELLIA;
2809 *key_size = 256;
2810 break;
2811 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002813 *key_type = PSA_KEY_TYPE_CAMELLIA;
2814 *key_size = 256;
2815 break;
2816 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2817 *alg = PSA_ALG_GCM;
2818 *key_type = PSA_KEY_TYPE_CAMELLIA;
2819 *key_size = 256;
2820 break;
2821 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2822 *alg = PSA_ALG_CHACHA20_POLY1305;
2823 *key_type = PSA_KEY_TYPE_CHACHA20;
2824 *key_size = 256;
2825 break;
2826 case MBEDTLS_CIPHER_NULL:
2827 *alg = MBEDTLS_SSL_NULL_CIPHER;
2828 *key_type = 0;
2829 *key_size = 0;
2830 break;
2831 default:
2832 return PSA_ERROR_NOT_SUPPORTED;
2833 }
2834
2835 return PSA_SUCCESS;
2836}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002837#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002838
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002839#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002840int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2841 const unsigned char *dhm_P, size_t P_len,
2842 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002843{
Janos Follath865b3eb2019-12-16 11:46:15 +00002844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 mbedtls_mpi_free(&conf->dhm_P);
2847 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2850 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2851 mbedtls_mpi_free(&conf->dhm_P);
2852 mbedtls_mpi_free(&conf->dhm_G);
2853 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002854 }
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002857}
Paul Bakker5121ce52009-01-03 21:22:43 +00002858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002860{
Janos Follath865b3eb2019-12-16 11:46:15 +00002861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 mbedtls_mpi_free(&conf->dhm_P);
2864 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2867 &conf->dhm_P)) != 0 ||
2868 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2869 &conf->dhm_G)) != 0) {
2870 mbedtls_mpi_free(&conf->dhm_P);
2871 mbedtls_mpi_free(&conf->dhm_G);
2872 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002873 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002876}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002877#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002878
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002879#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2880/*
2881 * Set the minimum length for Diffie-Hellman parameters
2882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002883void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2884 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002885{
2886 conf->dhm_min_bitlen = bitlen;
2887}
2888#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2889
Ronald Crone68ab4f2022-10-05 12:46:29 +02002890#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002891#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002892/*
2893 * Set allowed/preferred hashes for handshake signatures
2894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002895void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2896 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002897{
2898 conf->sig_hashes = hashes;
2899}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002900#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002901
Jerry Yuf017ee42022-01-12 15:49:48 +08002902/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002903void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2904 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002905{
Jerry Yuf017ee42022-01-12 15:49:48 +08002906#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2907 conf->sig_hashes = NULL;
2908#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2909 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002910}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002911#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002912
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002913#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002914#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002915/*
2916 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002917 *
2918 * mbedtls_ssl_setup() takes the provided list
2919 * and translates it to a list of IANA TLS group identifiers,
2920 * stored in ssl->handshake->group_list.
2921 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002923void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2924 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002925{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002926 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002927 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002928}
Brett Warrene0edc842021-08-17 09:53:13 +01002929#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002930#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002931
Brett Warrene0edc842021-08-17 09:53:13 +01002932/*
2933 * Set the allowed groups
2934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002935void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2936 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002937{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002938#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002939 conf->curve_list = NULL;
2940#endif
2941 conf->group_list = group_list;
2942}
2943
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002944#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002945int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002946{
Hanno Becker947194e2017-04-07 13:25:49 +01002947 /* Initialize to suppress unnecessary compiler warning */
2948 size_t hostname_len = 0;
2949
2950 /* Check if new hostname is valid before
2951 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 if (hostname != NULL) {
2953 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2957 }
Hanno Becker947194e2017-04-07 13:25:49 +01002958 }
2959
2960 /* Now it's clear that we will overwrite the old hostname,
2961 * so we can free it safely */
2962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002964 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002965 }
2966
2967 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002970 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 } else {
2972 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2973 if (ssl->hostname == NULL) {
2974 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2975 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002978
Hanno Becker947194e2017-04-07 13:25:49 +01002979 ssl->hostname[hostname_len] = '\0';
2980 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002983}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002984#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002985
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002986#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2988 int (*f_sni)(void *, mbedtls_ssl_context *,
2989 const unsigned char *, size_t),
2990 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002991{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002992 conf->f_sni = f_sni;
2993 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002994}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002998int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002999{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003000 size_t cur_len, tot_len;
3001 const char **p;
3002
3003 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003004 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3005 * MUST NOT be truncated."
3006 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003007 */
3008 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 for (p = protos; *p != NULL; p++) {
3010 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003011 tot_len += cur_len;
3012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if ((cur_len == 0) ||
3014 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3015 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3017 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003018 }
3019
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003020 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003023}
3024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003026{
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003028}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003030
Johan Pascalb62bb512015-12-03 21:56:45 +01003031#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003032void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3033 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003034{
3035 conf->dtls_srtp_mki_support = support_mki_value;
3036}
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3039 unsigned char *mki_value,
3040 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003041{
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003044 }
Ron Eldor591f1622018-01-22 12:30:04 +02003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3047 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003048 }
Ron Eldor591f1622018-01-22 12:30:04 +02003049
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003051 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003053}
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3056 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003057{
Johan Pascal253d0262020-09-22 13:04:45 +02003058 const mbedtls_ssl_srtp_profile *p;
3059 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003060
Johan Pascal253d0262020-09-22 13:04:45 +02003061 /* check the profiles list: all entry must be valid,
3062 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3064 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3065 p++) {
3066 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003067 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003069 /* unsupported value, stop parsing and set the size to an error value */
3070 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003071 }
3072 }
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3075 conf->dtls_srtp_profile_list = NULL;
3076 conf->dtls_srtp_profile_list_len = 0;
3077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003078 }
3079
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003080 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003081 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003084}
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3087 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003088{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003089 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3090 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003092 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003094 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3096 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003097 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003098}
Johan Pascalb62bb512015-12-03 21:56:45 +01003099#endif /* MBEDTLS_SSL_DTLS_SRTP */
3100
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303101#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003102void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003103{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003104 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003105}
3106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003108{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003109 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003110}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303111#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003112
Janos Follath088ce432017-04-10 12:42:31 +01003113#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003114void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3115 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003116{
3117 conf->cert_req_ca_list = cert_req_ca_list;
3118}
3119#endif
3120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003122void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003123{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003124 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003125}
3126#endif
3127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003129void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003130{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003131 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003132}
3133#endif
3134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003136int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003137{
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3139 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003141 }
3142
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003143 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003146}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003148
Gilles Peskine449bd832023-01-11 14:50:10 +01003149void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003150{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003151 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003152}
3153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003155void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003156{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003157 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003158}
3159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003161{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003162 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003163}
3164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3166 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003167{
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003169}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003173#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003174void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003175{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003176 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003177}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003178#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003179
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003180#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003181
Jerry Yud0766ec2022-09-22 10:46:57 +08003182#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003183void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3184 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003185{
Jerry Yud0766ec2022-09-22 10:46:57 +08003186 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003187}
3188#endif
3189
Gilles Peskine449bd832023-01-11 14:50:10 +01003190void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3191 mbedtls_ssl_ticket_write_t *f_ticket_write,
3192 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3193 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003194{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003195 conf->f_ticket_write = f_ticket_write;
3196 conf->f_ticket_parse = f_ticket_parse;
3197 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003198}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003199#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3203 mbedtls_ssl_export_keys_t *f_export_keys,
3204 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003205{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003206 ssl->f_export_keys = f_export_keys;
3207 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003208}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003209
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003210#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003211void mbedtls_ssl_conf_async_private_cb(
3212 mbedtls_ssl_config *conf,
3213 mbedtls_ssl_async_sign_t *f_async_sign,
3214 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3215 mbedtls_ssl_async_resume_t *f_async_resume,
3216 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003218{
3219 conf->f_async_sign_start = f_async_sign;
3220 conf->f_async_decrypt_start = f_async_decrypt;
3221 conf->f_async_resume = f_async_resume;
3222 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003223 conf->p_async_config_data = async_config_data;
3224}
3225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003227{
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003229}
3230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003232{
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 if (ssl->handshake == NULL) {
3234 return NULL;
3235 } else {
3236 return ssl->handshake->user_async_ctx;
3237 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003238}
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3241 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003242{
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003244 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003246}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003247#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003248
Paul Bakker5121ce52009-01-03 21:22:43 +00003249/*
3250 * SSL get accessors
3251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003252uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003253{
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if (ssl->session != NULL) {
3255 return ssl->session->verify_result;
3256 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (ssl->session_negotiate != NULL) {
3259 return ssl->session_negotiate->verify_result;
3260 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003261
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003263}
3264
Gilles Peskine449bd832023-01-11 14:50:10 +01003265int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003266{
Gilles Peskine449bd832023-01-11 14:50:10 +01003267 if (ssl == NULL || ssl->session == NULL) {
3268 return 0;
3269 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003270
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003272}
3273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003275{
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (ssl == NULL || ssl->session == NULL) {
3277 return NULL;
3278 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003281}
3282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003284{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3287 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003288 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003290 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003292 }
3293 }
3294#endif
3295
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003297 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003299 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003300 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003301 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003303 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003304}
3305
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003306#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003307size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003308{
David Horstmann95d516f2021-05-04 18:36:56 +01003309 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003310 size_t read_mfl;
3311
Jerry Yuddda0502022-12-01 19:43:12 +08003312#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003313 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3315 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3316 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003317 }
Jerry Yuddda0502022-12-01 19:43:12 +08003318#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003319
3320 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 if (ssl->session_out != NULL) {
3322 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3323 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003324 max_len = read_mfl;
3325 }
3326 }
3327
Jerry Yuddda0502022-12-01 19:43:12 +08003328 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (ssl->session_negotiate != NULL) {
3330 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3331 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003332 max_len = read_mfl;
3333 }
3334 }
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003337}
3338
Gilles Peskine449bd832023-01-11 14:50:10 +01003339size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003340{
3341 size_t max_len;
3342
3343 /*
3344 * Assume mfl_code is correct since it was checked when set
3345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003347
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003348 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 if (ssl->session_out != NULL &&
3350 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3351 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003352 }
3353
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003354 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 if (ssl->session_negotiate != NULL &&
3356 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3357 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003358 }
3359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003361}
3362#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3363
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003364#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003365size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003366{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003367 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3369 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3370 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3371 return 0;
3372 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003373
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3375 return ssl->mtu;
3376 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003377
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 if (ssl->mtu == 0) {
3379 return ssl->handshake->mtu;
3380 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 return ssl->mtu < ssl->handshake->mtu ?
3383 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003384}
3385#endif /* MBEDTLS_SSL_PROTO_DTLS */
3386
Gilles Peskine449bd832023-01-11 14:50:10 +01003387int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003388{
3389 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3390
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003391#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3392 !defined(MBEDTLS_SSL_PROTO_DTLS)
3393 (void) ssl;
3394#endif
3395
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003396#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003398
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003400 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003402#endif
3403
3404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3406 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3407 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003408 const size_t overhead = (size_t) ret;
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410 if (ret < 0) {
3411 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003412 }
3413
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 if (mtu <= overhead) {
3415 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3416 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3417 }
3418
3419 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003420 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003422 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003423#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003424
Hanno Becker0defedb2018-08-10 12:35:02 +01003425#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3426 !defined(MBEDTLS_SSL_PROTO_DTLS)
3427 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003428#endif
3429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003431}
3432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003434{
3435 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3436
3437#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3438 (void) ssl;
3439#endif
3440
3441#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003442 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003445 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003447#endif
3448
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003450}
3451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003453const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003454{
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 if (ssl == NULL || ssl->session == NULL) {
3456 return NULL;
3457 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003458
Hanno Beckere6824572019-02-07 13:18:46 +00003459#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003461#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003463#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003464}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003468int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3469 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003470{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003471 int ret;
3472
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003474 dst == NULL ||
3475 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3477 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003478 }
3479
Hanno Beckere810bbc2021-05-14 16:01:05 +01003480 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3481 * idempotent: Each session can only be exported once.
3482 *
3483 * (This is in preparation for TLS 1.3 support where we will
3484 * need the ability to export multiple sessions (aka tickets),
3485 * which will be achieved by calling mbedtls_ssl_get_session()
3486 * multiple times until it fails.)
3487 *
3488 * Check whether we have already exported the current session,
3489 * and fail if so.
3490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 if (ssl->session->exported == 1) {
3492 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3493 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003494
Gilles Peskine449bd832023-01-11 14:50:10 +01003495 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3496 if (ret != 0) {
3497 return ret;
3498 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003499
3500 /* Remember that we've exported the session. */
3501 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003503}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003505
Paul Bakker5121ce52009-01-03 21:22:43 +00003506/*
Hanno Beckera835da52019-05-16 12:39:07 +01003507 * Define ticket header determining Mbed TLS version
3508 * and structure of the ticket.
3509 */
3510
Hanno Becker94ef3b32019-05-16 12:50:45 +01003511/*
Hanno Becker50b59662019-05-28 14:30:45 +01003512 * Define bitflag determining compile-time settings influencing
3513 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003514 */
3515
Hanno Becker50b59662019-05-28 14:30:45 +01003516#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003517#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003518#else
Hanno Becker3e088662019-05-29 11:10:18 +01003519#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003520#endif /* MBEDTLS_HAVE_TIME */
3521
3522#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003523#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003524#else
Hanno Becker3e088662019-05-29 11:10:18 +01003525#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003526#endif /* MBEDTLS_X509_CRT_PARSE_C */
3527
3528#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003529#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003530#else
Hanno Becker3e088662019-05-29 11:10:18 +01003531#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003532#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3533
3534#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003536#else
Hanno Becker3e088662019-05-29 11:10:18 +01003537#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003538#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3539
Hanno Becker94ef3b32019-05-16 12:50:45 +01003540#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#else
Hanno Becker3e088662019-05-29 11:10:18 +01003543#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3545
Hanno Becker94ef3b32019-05-16 12:50:45 +01003546#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3547#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3548#else
3549#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3550#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3551
Hanno Becker3e088662019-05-29 11:10:18 +01003552#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3553#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3554#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3555#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003556#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3557#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003558
Hanno Becker50b59662019-05-28 14:30:45 +01003559#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003560 ((uint16_t) ( \
3561 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3562 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3563 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3564 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3565 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3566 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3567 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003568
Hanno Beckerf8787072019-05-16 12:41:07 +01003569static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003570 MBEDTLS_VERSION_MAJOR,
3571 MBEDTLS_VERSION_MINOR,
3572 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003573 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3574 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003575};
Hanno Beckera835da52019-05-16 12:39:07 +01003576
3577/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003578 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003579 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003580 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003581 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003582 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003583 * opaque mbedtls_version[3]; // library version: major, minor, patch
3584 * opaque session_format[2]; // library-version specific 16-bit field
3585 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003586 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003587 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003588 * Note: When updating the format, remember to keep
3589 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003590 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003591 * // In this version, `session_format` determines
3592 * // the setting of those compile-time
3593 * // configuration options which influence
3594 * // the structure of mbedtls_ssl_session.
3595 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003596 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003597 * // - TLS 1.2 (0x0303)
3598 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003599 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003600 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003601 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003602 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003603 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003604 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003605 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003606 *
3607 * };
3608 *
3609 * } serialized_session;
3610 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003611 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003612
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003614static int ssl_session_save(const mbedtls_ssl_session *session,
3615 unsigned char omit_header,
3616 unsigned char *buf,
3617 size_t buf_len,
3618 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003619{
3620 unsigned char *p = buf;
3621 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003622 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003623#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3624 size_t out_len;
3625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3626#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003627 if (session == NULL) {
3628 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3629 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003630
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003632 /*
3633 * Add Mbed TLS version identifier
3634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003635 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003636
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 if (used <= buf_len) {
3638 memcpy(p, ssl_serialized_session_header,
3639 sizeof(ssl_serialized_session_header));
3640 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003641 }
3642 }
3643
3644 /*
3645 * TLS version identifier
3646 */
3647 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003648 if (used <= buf_len) {
3649 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003650 }
3651
3652 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003653 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003655#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 case MBEDTLS_SSL_VERSION_TLS1_2:
3657 used += ssl_tls12_session_save(session, p, remaining_len);
3658 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003659#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3660
Jerry Yu251a12e2022-07-13 15:15:48 +08003661#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 case MBEDTLS_SSL_VERSION_TLS1_3:
3663 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3664 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3665 return ret;
3666 }
3667 used += out_len;
3668 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003669#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3670
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 default:
3672 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003673 }
3674
3675 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 if (used > buf_len) {
3677 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3678 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003679
Gilles Peskine449bd832023-01-11 14:50:10 +01003680 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003681}
3682
3683/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003684 * Public wrapper for ssl_session_save()
3685 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003686int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3687 unsigned char *buf,
3688 size_t buf_len,
3689 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003690{
Gilles Peskine449bd832023-01-11 14:50:10 +01003691 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003692}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003693
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003694/*
3695 * Deserialize session, see mbedtls_ssl_session_save() for format.
3696 *
3697 * This internal version is wrapped by a public function that cleans up in
3698 * case of error, and has an extra option omit_header.
3699 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003701static int ssl_session_load(mbedtls_ssl_session *session,
3702 unsigned char omit_header,
3703 const unsigned char *buf,
3704 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003705{
3706 const unsigned char *p = buf;
3707 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003708 size_t remaining_len;
3709
3710
Gilles Peskine449bd832023-01-11 14:50:10 +01003711 if (session == NULL) {
3712 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3713 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003714
Gilles Peskine449bd832023-01-11 14:50:10 +01003715 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003716 /*
3717 * Check Mbed TLS version identifier
3718 */
3719
Gilles Peskine449bd832023-01-11 14:50:10 +01003720 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003722 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003723
3724 if (memcmp(p, ssl_serialized_session_header,
3725 sizeof(ssl_serialized_session_header)) != 0) {
3726 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3727 }
3728 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003729 }
3730
3731 /*
3732 * TLS version identifier
3733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 if (1 > (size_t) (end - p)) {
3735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3736 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003737 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003738
3739 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003740 remaining_len = (end - p);
3741 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003742#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 case MBEDTLS_SSL_VERSION_TLS1_2:
3744 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003745#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3746
Jerry Yu438ddd82022-07-07 06:55:50 +00003747#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 case MBEDTLS_SSL_VERSION_TLS1_3:
3749 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003750#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3751
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 default:
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003754 }
3755}
3756
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003757/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003758 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003760int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3761 const unsigned char *buf,
3762 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003763{
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003765
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 if (ret != 0) {
3767 mbedtls_ssl_session_free(session);
3768 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003769
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003771}
3772
3773/*
Paul Bakker1961b702013-01-25 14:49:24 +01003774 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003775 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003776MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003777static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003778{
3779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3780
Ronald Cron66dbf912022-02-02 15:33:46 +01003781 /*
3782 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003783 * that were written into the output buffer by the previous handshake step,
3784 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003785 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3786 * We proceed to the next handshake step only when all data from the
3787 * previous one have been sent to the peer, thus we make sure that this is
3788 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3789 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3790 * we have to wait before to go ahead.
3791 * In the case of TLS 1.3, handshake step handlers do not send data to the
3792 * peer. Data are only sent here and through
3793 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003794 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003795 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3797 return ret;
3798 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003799
3800#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003801 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3802 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3803 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3804 return ret;
3805 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003806 }
3807#endif /* MBEDTLS_SSL_PROTO_DTLS */
3808
Gilles Peskine449bd832023-01-11 14:50:10 +01003809 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003810}
3811
Gilles Peskine449bd832023-01-11 14:50:10 +01003812int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003813{
Hanno Becker41934dd2021-08-07 19:13:43 +01003814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003815
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003817 ssl->conf == NULL ||
3818 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003821 }
3822
Gilles Peskine449bd832023-01-11 14:50:10 +01003823 ret = ssl_prepare_handshake_step(ssl);
3824 if (ret != 0) {
3825 return ret;
3826 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003827
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 ret = mbedtls_ssl_handle_pending_alert(ssl);
3829 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003830 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003831 }
Jerry Yue7047812021-09-13 19:26:39 +08003832
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003833 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3834 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3835 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003837#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3839 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003840 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003841
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003843 case MBEDTLS_SSL_HELLO_REQUEST:
3844 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003845 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003846 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003847
Ronald Cron9f0fba32022-02-10 16:45:15 +01003848 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003850 break;
3851
3852 default:
3853#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3855 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3856 } else {
3857 ret = mbedtls_ssl_handshake_client_step(ssl);
3858 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003859#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003860 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003861#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003863#endif
3864 }
Jerry Yub9930e72021-08-06 17:11:51 +08003865 }
Ronald Cron6291b232023-03-08 15:51:25 +01003866#endif /* MBEDTLS_SSL_CLI_C */
3867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003868#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003870#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3871 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003873 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003874 ret = mbedtls_ssl_handshake_server_step(ssl);
3875 }
Ronald Cron6291b232023-03-08 15:51:25 +01003876#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3877 ret = mbedtls_ssl_handshake_server_step(ssl);
3878#else
3879 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003880#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003881 }
3882#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003883
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003885 /* handshake_step return error. And it is same
3886 * with alert_reason.
3887 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (ssl->send_alert) {
3889 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003890 goto cleanup;
3891 }
3892 }
3893
3894cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003896}
3897
3898/*
3899 * Perform the SSL handshake
3900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003901int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003902{
3903 int ret = 0;
3904
Hanno Beckera817ea42020-10-20 15:20:23 +01003905 /* Sanity checks */
3906
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (ssl == NULL || ssl->conf == NULL) {
3908 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3909 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003910
Hanno Beckera817ea42020-10-20 15:20:23 +01003911#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3913 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3914 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3915 "mbedtls_ssl_set_timer_cb() for DTLS"));
3916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003917 }
3918#endif /* MBEDTLS_SSL_PROTO_DTLS */
3919
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003921
Hanno Beckera817ea42020-10-20 15:20:23 +01003922 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3924 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003925
Gilles Peskine449bd832023-01-11 14:50:10 +01003926 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003927 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 }
Paul Bakker1961b702013-01-25 14:49:24 +01003929 }
3930
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003932
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003934}
3935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003936#if defined(MBEDTLS_SSL_RENEGOTIATION)
3937#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003938/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003939 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003940 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003941MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003942static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003943{
Janos Follath865b3eb2019-12-16 11:46:15 +00003944 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003945
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003947
3948 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003949 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3950 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003951
Gilles Peskine449bd832023-01-11 14:50:10 +01003952 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3953 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3954 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003955 }
3956
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003958
Gilles Peskine449bd832023-01-11 14:50:10 +01003959 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003960}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003961#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003962
3963/*
3964 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965 * - any side: calling mbedtls_ssl_renegotiate(),
3966 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3967 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003968 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003969 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003970 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003971 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003972int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003973{
Janos Follath865b3eb2019-12-16 11:46:15 +00003974 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003977
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if ((ret = ssl_handshake_init(ssl)) != 0) {
3979 return ret;
3980 }
Paul Bakker48916f92012-09-16 19:57:18 +00003981
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003982 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
3983 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003984#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3986 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
3987 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003988 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003990 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02003992 }
3993#endif
3994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
3996 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00003997
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
3999 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4000 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004001 }
4002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004006}
4007
4008/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004009 * Renegotiate current connection on client,
4010 * or request renegotiation on server
4011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004012int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004013{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004014 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if (ssl == NULL || ssl->conf == NULL) {
4017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4018 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004020#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004021 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4023 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4025 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004027 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004028
4029 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 if (ssl->out_left != 0) {
4031 return mbedtls_ssl_flush_output(ssl);
4032 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004035 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004036#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004039 /*
4040 * On client, either start the renegotiation process or,
4041 * if already in progress, continue the handshake
4042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4044 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004046 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004047
4048 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4049 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4050 return ret;
4051 }
4052 } else {
4053 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4054 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4055 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004056 }
4057 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004058#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004061}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004062#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004065{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004066 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004069 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004071
Valerio Setti6f0441d2023-07-03 12:11:36 +02004072#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004073#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (ssl->handshake->group_list_heap_allocated) {
4075 mbedtls_free((void *) handshake->group_list);
4076 }
Brett Warrene0edc842021-08-17 09:53:13 +01004077 handshake->group_list = NULL;
4078#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004079#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004080
Ronald Crone68ab4f2022-10-05 12:46:29 +02004081#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004082#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 if (ssl->handshake->sig_algs_heap_allocated) {
4084 mbedtls_free((void *) handshake->sig_algs);
4085 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004086 handshake->sig_algs = NULL;
4087#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004088#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (ssl->handshake->certificate_request_context) {
4090 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004091 }
4092#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004093#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004094
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004095#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4097 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004098 handshake->async_in_progress = 0;
4099 }
4100#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4101
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004102#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004105#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004106 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004107#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004108#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004109#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004110#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004112#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004113 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004114#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004115#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004117#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004119#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004120#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004121 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004123#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004124
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004125#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004126#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004128 /*
4129 * Opaque keys are not stored in the handshake's data and it's the user
4130 * responsibility to destroy them. Clear ones, instead, are created by
4131 * the TLS library and should be destroyed at the same level
4132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4134 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004135 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004136 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4137#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004139#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004140#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004142 handshake->ecjpake_cache = NULL;
4143 handshake->ecjpake_cache_len = 0;
4144#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004145#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004146
Valerio Setti7aeec542023-07-05 18:57:21 +02004147#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004148 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004149 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004150 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004152#endif
4153
Ronald Cron73fe8df2022-10-05 14:31:43 +02004154#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004155#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004157 /* The maintenance of the external PSK key slot is the
4158 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (ssl->handshake->psk_opaque_is_internal) {
4160 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004161 ssl->handshake->psk_opaque_is_internal = 0;
4162 }
4163 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4164 }
Neil Armstronge952a302022-05-03 10:22:14 +02004165#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004167 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004168 }
Neil Armstronge952a302022-05-03 10:22:14 +02004169#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004170#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004172#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4173 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004174 /*
4175 * Free only the linked list wrapper, not the keys themselves
4176 * since the belong to the SNI callback
4177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004179#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004180
Gilles Peskineeccd8882020-03-10 12:19:08 +01004181#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4183 if (handshake->ecrs_peer_cert != NULL) {
4184 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4185 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004186 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004187#endif
4188
Hanno Becker75173122019-02-06 16:18:31 +00004189#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4190 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004192#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4193
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004194#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4196 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004197#endif /* MBEDTLS_SSL_CLI_C &&
4198 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004199
4200#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 mbedtls_ssl_flight_free(handshake->flight);
4202 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004203#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004204
Valerio Settiea59c432023-07-25 11:14:03 +02004205#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004206 if (handshake->xxdh_psa_privkey_is_external == 0) {
4207 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 }
Valerio Settiea59c432023-07-25 11:14:03 +02004209#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004210
Ronald Cron6f135e12021-12-08 16:57:54 +01004211#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 mbedtls_ssl_transform_free(handshake->transform_handshake);
4213 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004214#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4216 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004217#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004218#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004219
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004220
4221#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4222 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4223 * processes datagrams and the fact that a datagram is allowed to have
4224 * several records in it, it is possible that the I/O buffers are not
4225 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4227 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004228#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004229
Jerry Yuba9c7272021-10-30 11:54:10 +08004230 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 mbedtls_platform_zeroize(handshake,
4232 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004233}
4234
Gilles Peskine449bd832023-01-11 14:50:10 +01004235void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004236{
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004238 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004243#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004244
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004245#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004246#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4247 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004249#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004251#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004254}
4255
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004256#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004257
4258#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4259#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4260#else
4261#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4262#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4263
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004264#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004265
4266#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4267#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4268#else
4269#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4270#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4271
4272#if defined(MBEDTLS_SSL_ALPN)
4273#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4274#else
4275#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4276#endif /* MBEDTLS_SSL_ALPN */
4277
4278#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4280#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4281#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4282
4283#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 ((uint32_t) ( \
4285 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4286 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4287 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4288 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4289 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4290 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4291 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4292 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004293
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004294static unsigned char ssl_serialized_context_header[] = {
4295 MBEDTLS_VERSION_MAJOR,
4296 MBEDTLS_VERSION_MINOR,
4297 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4299 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4300 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4301 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4302 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004303};
4304
Paul Bakker5121ce52009-01-03 21:22:43 +00004305/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004306 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004307 *
4308 * The format of the serialized data is:
4309 * (in the presentation language of TLS, RFC 8446 section 3)
4310 *
4311 * // header
4312 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004313 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004314 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004315 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004316 * Note: When updating the format, remember to keep these
4317 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004318 *
4319 * // session sub-structure
4320 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4321 * // transform sub-structure
4322 * uint8 random[64]; // ServerHello.random+ClientHello.random
4323 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4324 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4325 * // fields from ssl_context
4326 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4327 * uint64 in_window_top; // DTLS: last validated record seq_num
4328 * uint64 in_window; // DTLS: bitmask for replay protection
4329 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4330 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4331 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4332 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4333 *
4334 * Note that many fields of the ssl_context or sub-structures are not
4335 * serialized, as they fall in one of the following categories:
4336 *
4337 * 1. forced value (eg in_left must be 0)
4338 * 2. pointer to dynamically-allocated memory (eg session, transform)
4339 * 3. value can be re-derived from other data (eg session keys from MS)
4340 * 4. value was temporary (eg content of input buffer)
4341 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004343int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4344 unsigned char *buf,
4345 size_t buf_len,
4346 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004347{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004348 unsigned char *p = buf;
4349 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004350 size_t session_len;
4351 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004352
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004353 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004354 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4355 * this function's documentation.
4356 *
4357 * These are due to assumptions/limitations in the implementation. Some of
4358 * them are likely to stay (no handshake in progress) some might go away
4359 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004360 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004361 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4363 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004365 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (ssl->handshake != NULL) {
4367 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4368 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004369 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004370 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (ssl->transform == NULL || ssl->session == NULL) {
4372 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4373 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004374 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004375 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (mbedtls_ssl_check_pending(ssl) != 0) {
4377 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4378 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004379 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (ssl->out_left != 0) {
4381 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004383 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004384 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4386 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004388 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004389 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4391 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004393 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004394 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4396 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004398 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004399 /* Renegotiation must not be enabled */
4400#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4402 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004404 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004405#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004406
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004407 /*
4408 * Version and format identifier
4409 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (used <= buf_len) {
4413 memcpy(p, ssl_serialized_context_header,
4414 sizeof(ssl_serialized_context_header));
4415 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004416 }
4417
4418 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004419 * Session (length + data)
4420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4422 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4423 return ret;
4424 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004425
4426 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 if (used <= buf_len) {
4428 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004429 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004430
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 ret = ssl_session_save(ssl->session, 1,
4432 p, session_len, &session_len);
4433 if (ret != 0) {
4434 return ret;
4435 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004436
4437 p += session_len;
4438 }
4439
4440 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004441 * Transform
4442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 used += sizeof(ssl->transform->randbytes);
4444 if (used <= buf_len) {
4445 memcpy(p, ssl->transform->randbytes,
4446 sizeof(ssl->transform->randbytes));
4447 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004448 }
4449
4450#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4451 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004453 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004455 p += ssl->transform->in_cid_len;
4456
4457 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004459 p += ssl->transform->out_cid_len;
4460 }
4461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4462
4463 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004464 * Saved fields from top-level ssl_context structure
4465 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004466 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 if (used <= buf_len) {
4468 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004469 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004470 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004471
4472#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4473 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (used <= buf_len) {
4475 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004476 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004477
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004479 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004480 }
4481#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4482
4483#if defined(MBEDTLS_SSL_PROTO_DTLS)
4484 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004486 *p++ = ssl->disable_datagram_packing;
4487 }
4488#endif /* MBEDTLS_SSL_PROTO_DTLS */
4489
Jerry Yuae0b2e22021-10-08 15:21:19 +08004490 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (used <= buf_len) {
4492 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004493 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004494 }
4495
4496#if defined(MBEDTLS_SSL_PROTO_DTLS)
4497 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (used <= buf_len) {
4499 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004500 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004501 }
4502#endif /* MBEDTLS_SSL_PROTO_DTLS */
4503
4504#if defined(MBEDTLS_SSL_ALPN)
4505 {
4506 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004508 : 0;
4509
4510 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004512 *p++ = alpn_len;
4513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (ssl->alpn_chosen != NULL) {
4515 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004516 p += alpn_len;
4517 }
4518 }
4519 }
4520#endif /* MBEDTLS_SSL_ALPN */
4521
4522 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004523 * Done
4524 */
4525 *olen = used;
4526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (used > buf_len) {
4528 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4529 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004534}
4535
4536/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004537 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004538 *
4539 * This internal version is wrapped by a public function that cleans up in
4540 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004541 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004542MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004543static int ssl_context_load(mbedtls_ssl_context *ssl,
4544 const unsigned char *buf,
4545 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004546{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004547 const unsigned char *p = buf;
4548 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004549 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004551#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004552 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004553#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004554
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004555 /*
4556 * The context should have been freshly setup or reset.
4557 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004558 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004559 * renegotiating, or if the user mistakenly loaded a session first.)
4560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4562 ssl->session != NULL) {
4563 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004564 }
4565
4566 /*
4567 * We can't check that the config matches the initial one, but we can at
4568 * least check it matches the requirements for serializing.
4569 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004570 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004571#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004572 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004573#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004574 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4575 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4576 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4577 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004579 }
4580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004582
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004583 /*
4584 * Check version identifier
4585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004588 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004589
4590 if (memcmp(p, ssl_serialized_context_header,
4591 sizeof(ssl_serialized_context_header)) != 0) {
4592 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4593 }
4594 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004595
4596 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004597 * Session
4598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if ((size_t) (end - p) < 4) {
4600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4601 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004602
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004603 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004604 p += 4;
4605
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004606 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004607 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004608 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004609 ssl->session_in = ssl->session;
4610 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004611 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if ((size_t) (end - p) < session_len) {
4614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4615 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 ret = ssl_session_load(ssl->session, 1, p, session_len);
4618 if (ret != 0) {
4619 mbedtls_ssl_session_free(ssl->session);
4620 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004621 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004622
4623 p += session_len;
4624
4625 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004626 * Transform
4627 */
4628
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004629 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004630 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004631#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004632 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004633 ssl->transform_in = ssl->transform;
4634 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004635 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004636#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004637
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004638#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4640 if (prf_func == NULL) {
4641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4642 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004643
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004644 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4647 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004648
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 ret = ssl_tls12_populate_transform(ssl->transform,
4650 ssl->session->ciphersuite,
4651 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004652#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004654#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 prf_func,
4656 p, /* currently pointing to randbytes */
4657 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4658 ssl->conf->endpoint,
4659 ssl);
4660 if (ret != 0) {
4661 return ret;
4662 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004663#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004665
4666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4667 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if ((size_t) (end - p) < 1) {
4669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4670 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004671
4672 ssl->transform->in_cid_len = *p++;
4673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4676 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004679 p += ssl->transform->in_cid_len;
4680
4681 ssl->transform->out_cid_len = *p++;
4682
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4684 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4685 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004688 p += ssl->transform->out_cid_len;
4689#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4690
4691 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004692 * Saved fields from top-level ssl_context structure
4693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if ((size_t) (end - p) < 4) {
4695 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4696 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004697
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004698 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004699 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004700
4701#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if ((size_t) (end - p) < 16) {
4703 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4704 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004705
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004706 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004707 p += 8;
4708
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004709 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004710 p += 8;
4711#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4712
4713#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if ((size_t) (end - p) < 1) {
4715 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4716 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717
4718 ssl->disable_datagram_packing = *p++;
4719#endif /* MBEDTLS_SSL_PROTO_DTLS */
4720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4723 }
4724 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4725 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004726
4727#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if ((size_t) (end - p) < 2) {
4729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4730 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004733 p += 2;
4734#endif /* MBEDTLS_SSL_PROTO_DTLS */
4735
4736#if defined(MBEDTLS_SSL_ALPN)
4737 {
4738 uint8_t alpn_len;
4739 const char **cur;
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if ((size_t) (end - p) < 1) {
4742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4743 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004744
4745 alpn_len = *p++;
4746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004748 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4750 if (strlen(*cur) == alpn_len &&
4751 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004752 ssl->alpn_chosen = *cur;
4753 break;
4754 }
4755 }
4756 }
4757
4758 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4761 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004762
4763 p += alpn_len;
4764 }
4765#endif /* MBEDTLS_SSL_ALPN */
4766
4767 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004768 * Forced fields from top-level ssl_context structure
4769 *
4770 * Most of them already set to the correct value by mbedtls_ssl_init() and
4771 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4772 */
4773 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004774 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004775
Hanno Becker361b10d2019-08-30 10:42:49 +01004776 /* Adjust pointers for header fields of outgoing records to
4777 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004779
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004780#if defined(MBEDTLS_SSL_PROTO_DTLS)
4781 ssl->in_epoch = 1;
4782#endif
4783
4784 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4785 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004786 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4787 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (ssl->handshake != NULL) {
4789 mbedtls_ssl_handshake_free(ssl);
4790 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004791 ssl->handshake = NULL;
4792 }
4793
4794 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004795 * Done - should have consumed entire buffer
4796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (p != end) {
4798 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4799 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004800
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004802}
4803
4804/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004805 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004806 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004807int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4808 const unsigned char *buf,
4809 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004810{
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (ret != 0) {
4814 mbedtls_ssl_free(context);
4815 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004818}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004819#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004820
4821/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004822 * Free an SSL context
4823 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004824void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004825{
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004827 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004833#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4834 size_t out_buf_len = ssl->out_buf_len;
4835#else
4836 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4837#endif
4838
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004839 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004840 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004841 }
4842
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004844#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4845 size_t in_buf_len = ssl->in_buf_len;
4846#else
4847 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4848#endif
4849
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004850 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004851 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004852 }
4853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (ssl->transform) {
4855 mbedtls_ssl_transform_free(ssl->transform);
4856 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004857 }
4858
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (ssl->handshake) {
4860 mbedtls_ssl_handshake_free(ssl);
4861 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004862
4863#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4865 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004866#endif
4867
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 mbedtls_ssl_session_free(ssl->session_negotiate);
4869 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004870 }
4871
Ronald Cron6f135e12021-12-08 16:57:54 +01004872#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_ssl_transform_free(ssl->transform_application);
4874 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004875#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (ssl->session) {
4878 mbedtls_ssl_session_free(ssl->session);
4879 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004880 }
4881
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004882#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004884 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004885 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004886#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004887
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004888#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004890#endif
4891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004893
Paul Bakker86f04f42013-02-14 11:20:09 +01004894 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004896}
4897
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004898/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004899 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004902{
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004904}
4905
Gilles Peskineae270bf2021-06-02 00:05:29 +02004906/* The selection should be the same as mbedtls_x509_crt_profile_default in
4907 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004908 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004909 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004910 * about this list.
4911 */
Brett Warrene0edc842021-08-17 09:53:13 +01004912static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004913#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004914 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004915#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004916#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004917 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004918#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004919#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004920 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004921#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004922#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004923 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004924#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004925#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004926 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004927#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004928#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004929 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004930#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004931#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004932 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004933#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004934#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004935 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004936#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004937#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004938 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4939 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4940 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4941 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4942 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4943#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004945};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004946
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004947static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004948 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4949 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4950 0
4951};
4952
Ronald Crone68ab4f2022-10-05 12:46:29 +02004953#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004954
Jerry Yu909df7b2022-01-22 11:56:27 +08004955/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004956 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004957 * rules SHOULD be upheld.
4958 * - No duplicate entries.
4959 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004960 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004961 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004962 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004963static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004964
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004965#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004966 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004967 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08004968 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004969 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
4970#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004971
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004972#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004973 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004974 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08004975 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004976 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
4977#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004978
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004979#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004980 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004981 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08004982 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004983 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
4984#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004987 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004988 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01004989#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004990 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004991
Gilles Peskine449bd832023-01-11 14:50:10 +01004992#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004993 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004994 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01004995#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004996 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004999 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005000 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005001#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005002 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005003
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005004#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005005 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005006#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005007
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005009 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005010#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005011
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005012#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005013 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005015
Gabor Mezei15b95a62022-05-09 16:37:58 +02005016 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005017};
5018
5019/* NOTICE: see above */
5020#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5021static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005023#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005025#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005026#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5027 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5028#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005029#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005031#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#endif /* MBEDTLS_MD_CAN_SHA512*/
5033#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005034#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005036#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005037#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5038 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5039#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005040#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005042#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005043#endif /* MBEDTLS_MD_CAN_SHA384*/
5044#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005045#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005047#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005048#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5049 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5050#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005051#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005053#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005054#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005055 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005056};
5057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5058/* NOTICE: see above */
5059static uint16_t ssl_preset_suiteb_sig_algs[] = {
5060
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005061#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005062 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005063 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005064 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005065 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5066#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005067
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005068#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005069 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005070 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005071 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005072 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5073#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005074
Gilles Peskine449bd832023-01-11 14:50:10 +01005075#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005076 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005077 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005078#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005079 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005080
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005081#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005082 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005083#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005084
Gabor Mezei15b95a62022-05-09 16:37:58 +02005085 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005086};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005087
Jerry Yu909df7b2022-01-22 11:56:27 +08005088/* NOTICE: see above */
5089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5090static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005091#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005092#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005094#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005095#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005097#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005098#endif /* MBEDTLS_MD_CAN_SHA256*/
5099#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005100#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005102#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005103#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005105#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005106#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005107 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005108};
Jerry Yu909df7b2022-01-22 11:56:27 +08005109#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5110
Ronald Crone68ab4f2022-10-05 12:46:29 +02005111#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005112
Brett Warrene0edc842021-08-17 09:53:13 +01005113static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005114#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005115 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005116#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005117#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005118 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005119#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005120 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005121};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005122
Ronald Crone68ab4f2022-10-05 12:46:29 +02005123#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005124/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005125 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005126MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005127static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005128{
5129 size_t i, j;
5130 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5133 for (j = 0; j < i; j++) {
5134 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005135 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 }
5137 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5138 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5139 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005140 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005141 }
5142 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005144}
5145
Ronald Crone68ab4f2022-10-05 12:46:29 +02005146#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005147
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005148/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005149 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005151int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5152 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005153{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005154#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005156#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005157
Ronald Crone68ab4f2022-10-05 12:46:29 +02005158#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5160 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5161 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005162 }
5163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5165 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5166 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005167 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005168
5169#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5171 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5172 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005173 }
5174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5176 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5177 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005178 }
5179#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005180#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005181
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005182 /* Use the functions here so that they are covered in tests,
5183 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 mbedtls_ssl_conf_endpoint(conf, endpoint);
5185 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005186
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005187 /*
5188 * Things that are common to all presets
5189 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005190#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005192 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5193#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5194 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5195#endif
5196 }
5197#endif
5198
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005199#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5200 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5201#endif
5202
5203#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5204 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5205#endif
5206
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005207#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005208 conf->f_cookie_write = ssl_cookie_write_dummy;
5209 conf->f_cookie_check = ssl_cookie_check_dummy;
5210#endif
5211
5212#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5213 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5214#endif
5215
Janos Follath088ce432017-04-10 12:42:31 +01005216#if defined(MBEDTLS_SSL_SRV_C)
5217 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005218 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005219#endif
5220
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005221#if defined(MBEDTLS_SSL_PROTO_DTLS)
5222 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5223 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5224#endif
5225
5226#if defined(MBEDTLS_SSL_RENEGOTIATION)
5227 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 memset(conf->renego_period, 0x00, 2);
5229 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005230#endif
5231
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005232#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005234 const unsigned char dhm_p[] =
5235 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5236 const unsigned char dhm_g[] =
5237 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5240 dhm_p, sizeof(dhm_p),
5241 dhm_g, sizeof(dhm_g))) != 0) {
5242 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005243 }
5244 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005245#endif
5246
Ronald Cron6f135e12021-12-08 16:57:54 +01005247#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005248
5249#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005250 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005251#if defined(MBEDTLS_SSL_SRV_C)
5252 mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005254#endif
5255#endif /* MBEDTLS_SSL_EARLY_DATA */
5256
Jerry Yud0766ec2022-09-22 10:46:57 +08005257#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005258 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005260#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005261 /*
5262 * Allow all TLS 1.3 key exchange modes by default.
5263 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005264 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005265#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005266
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005268#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005269 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005270 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005271#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005273#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005275#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005276 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5277 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005278#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5279 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5280 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5281#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5282 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5283 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5284#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005286#endif
5287 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005288
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005289 /*
5290 * Preset-specific defaults
5291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005293 /*
5294 * NSA Suite B
5295 */
5296 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005297
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005298 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005299
5300#if defined(MBEDTLS_X509_CRT_PARSE_C)
5301 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005302#endif
5303
Ronald Crone68ab4f2022-10-05 12:46:29 +02005304#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005305#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005307 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005309#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005311#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005312
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005313#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005314 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005315#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005316 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005317 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005318
5319 /*
5320 * Default
5321 */
5322 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005323
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005324 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005325
5326#if defined(MBEDTLS_X509_CRT_PARSE_C)
5327 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5328#endif
5329
Ronald Crone68ab4f2022-10-05 12:46:29 +02005330#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005331#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005333 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005335#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005337#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005338
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005339#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005340 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005341#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005342 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005343
5344#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5345 conf->dhm_min_bitlen = 1024;
5346#endif
5347 }
5348
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005350}
5351
5352/*
5353 * Free mbedtls_ssl_config
5354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005355void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005356{
5357#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 mbedtls_mpi_free(&conf->dhm_P);
5359 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005360#endif
5361
Ronald Cron73fe8df2022-10-05 14:31:43 +02005362#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005363#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005365 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5366 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005367#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005369 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005370 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005371 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005372 }
5373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005375 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005376 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005377 conf->psk_identity_len = 0;
5378 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005379#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005380
5381#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005383#endif
5384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005386}
5387
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005388#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005389 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005390/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005392 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005393unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005394{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5397 return MBEDTLS_SSL_SIG_RSA;
5398 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005399#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005400#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5402 return MBEDTLS_SSL_SIG_ECDSA;
5403 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005406}
5407
Gilles Peskine449bd832023-01-11 14:50:10 +01005408unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005409{
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005411 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005413 case MBEDTLS_PK_ECDSA:
5414 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005416 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005418 }
5419}
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005422{
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424#if defined(MBEDTLS_RSA_C)
5425 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005427#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005428#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005431#endif
5432 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005434 }
5435}
Valerio Settie9646ec2023-08-02 20:02:28 +02005436#endif /* MBEDTLS_PK_C &&
5437 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005438
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005439/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005440 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005441 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005442mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005443{
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005445#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005448#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005449#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005451 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005452#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005453#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005456#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005457#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005461#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005464#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005465#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005468#endif
5469 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005471 }
5472}
5473
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005474/*
5475 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5476 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005478{
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005480#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005481 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005483#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005484#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005485 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005487#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005488#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005489 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005491#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005492#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005493 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005496#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005497 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005499#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005500#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005501 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005503#endif
5504 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005506 }
5507}
5508
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005509/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005511 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005513int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005514{
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 if (group_list == NULL) {
5518 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005519 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 for (; *group_list != 0; group_list++) {
5522 if (*group_list == tls_id) {
5523 return 0;
5524 }
5525 }
5526
5527 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005528}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005529
Valerio Setti49e69072023-06-27 17:27:51 +02005530#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005531/*
5532 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5533 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005534int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005535{
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005539 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005543}
Valerio Setti49e69072023-06-27 17:27:51 +02005544#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005545
Valerio Setti18c9fed2022-12-30 17:44:24 +01005546static const struct {
5547 uint16_t tls_id;
5548 mbedtls_ecp_group_id ecp_group_id;
5549 psa_ecc_family_t psa_family;
5550 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005551} tls_id_match_table[] =
5552{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005553#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005554 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005555#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005556#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005557 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005558#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005559#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005560 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005561#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005562#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005563 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005564#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005565#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005566 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005567#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005568#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005569 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005570#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005571#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005572 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005573#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005574#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005575 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005576#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005577#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005578 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005579#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005580#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005581 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005582#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005583#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005584 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005585#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005586#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005587 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005588#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005589#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005590 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005591#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005592 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005593};
5594
Gilles Peskine449bd832023-01-11 14:50:10 +01005595int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005596 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005598{
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5600 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005601 if (type != NULL) {
5602 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 }
5604 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005605 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005607 return PSA_SUCCESS;
5608 }
5609 }
5610
5611 return PSA_ERROR_NOT_SUPPORTED;
5612}
5613
Gilles Peskine449bd832023-01-11 14:50:10 +01005614mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005615{
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5617 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005618 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005620 }
5621
5622 return MBEDTLS_ECP_DP_NONE;
5623}
5624
Gilles Peskine449bd832023-01-11 14:50:10 +01005625uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005626{
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5628 i++) {
5629 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005630 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632 }
5633
5634 return 0;
5635}
5636
Valerio Setti67419f02023-01-04 16:12:42 +01005637#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005638static const struct {
5639 uint16_t tls_id;
5640 const char *name;
5641} tls_id_curve_name_table[] =
5642{
Valerio Setti54e23792023-07-07 10:49:27 +02005643 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5644 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5645 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5646 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5647 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5648 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5649 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5650 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5651 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5652 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5653 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5654 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5655 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005656 { 0, NULL },
5657};
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005660{
Valerio Settiacd32c02023-06-29 18:06:29 +02005661 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5662 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5663 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005665 }
5666
5667 return NULL;
5668}
Valerio Setti67419f02023-01-04 16:12:42 +01005669#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005672int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5673 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5674 int cert_endpoint,
5675 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005676{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005677 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005678 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005679 const char *ext_oid;
5680 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005681
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005683 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 case MBEDTLS_KEY_EXCHANGE_RSA:
5686 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005687 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005688 break;
5689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005690 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5691 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5692 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5693 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005694 break;
5695
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5697 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005698 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005699 break;
5700
5701 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 case MBEDTLS_KEY_EXCHANGE_NONE:
5703 case MBEDTLS_KEY_EXCHANGE_PSK:
5704 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5705 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005706 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005707 usage = 0;
5708 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005710 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5711 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005712 }
5713
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005715 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005716 ret = -1;
5717 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005718
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5722 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005725 }
5726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005728 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005729 ret = -1;
5730 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005733}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005735
Jerry Yu148165c2021-09-24 23:20:59 +08005736#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005737int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5738 const mbedtls_md_type_t md,
5739 unsigned char *dst,
5740 size_t dst_len,
5741 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005742{
Ronald Cronf6893e12022-01-07 22:09:01 +01005743 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5744 psa_hash_operation_t *hash_operation_to_clone;
5745 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5746
Jerry Yu148165c2021-09-24 23:20:59 +08005747 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005750#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 case MBEDTLS_MD_SHA384:
5752 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5753 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005754#endif
5755
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005756#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 case MBEDTLS_MD_SHA256:
5758 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5759 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005760#endif
5761
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 default:
5763 goto exit;
5764 }
5765
5766 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5767 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005768 goto exit;
5769 }
5770
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5772 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005773 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005775
5776exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005777#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5778 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005779 (void) ssl;
5780#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005781 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005782}
5783#else /* MBEDTLS_USE_PSA_CRYPTO */
5784
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005785#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005786MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005787static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5788 unsigned char *dst,
5789 size_t dst_len,
5790 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005791{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005792 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005793 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 if (dst_len < 48) {
5796 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5797 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005798
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005799 mbedtls_md_init(&sha384);
5800 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005801 if (ret != 0) {
5802 goto exit;
5803 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005804 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005805 if (ret != 0) {
5806 goto exit;
5807 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005808
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005809 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005810 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811 goto exit;
5812 }
5813
5814 *olen = 48;
5815
5816exit:
5817
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005818 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005820}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005821#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005822
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005823#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005824MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005825static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5826 unsigned char *dst,
5827 size_t dst_len,
5828 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005829{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005830 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005831 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005832
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (dst_len < 32) {
5834 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5835 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005836
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005837 mbedtls_md_init(&sha256);
5838 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5839 if (ret != 0) {
5840 goto exit;
5841 }
5842 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5843 if (ret != 0) {
5844 goto exit;
5845 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005846
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005847 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5848 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005849 goto exit;
5850 }
5851
5852 *olen = 32;
5853
5854exit:
5855
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005856 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005858}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005859#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005860
Gilles Peskine449bd832023-01-11 14:50:10 +01005861int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5862 const mbedtls_md_type_t md,
5863 unsigned char *dst,
5864 size_t dst_len,
5865 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866{
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005868
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005869#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 case MBEDTLS_MD_SHA384:
5871 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005872#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005873
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005874#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 case MBEDTLS_MD_SHA256:
5876 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005877#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005878
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005880#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5881 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 (void) ssl;
5883 (void) dst;
5884 (void) dst_len;
5885 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005886#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005888 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005890}
XiaokangQian647719a2021-12-07 09:16:29 +00005891
Jerry Yu148165c2021-09-24 23:20:59 +08005892#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005893
Ronald Crone68ab4f2022-10-05 12:46:29 +02005894#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005895/* mbedtls_ssl_parse_sig_alg_ext()
5896 *
5897 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5898 * value (TLS 1.3 RFC8446):
5899 * enum {
5900 * ....
5901 * ecdsa_secp256r1_sha256( 0x0403 ),
5902 * ecdsa_secp384r1_sha384( 0x0503 ),
5903 * ecdsa_secp521r1_sha512( 0x0603 ),
5904 * ....
5905 * } SignatureScheme;
5906 *
5907 * struct {
5908 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5909 * } SignatureSchemeList;
5910 *
5911 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5912 * value (TLS 1.2 RFC5246):
5913 * enum {
5914 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5915 * sha512(6), (255)
5916 * } HashAlgorithm;
5917 *
5918 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5919 * SignatureAlgorithm;
5920 *
5921 * struct {
5922 * HashAlgorithm hash;
5923 * SignatureAlgorithm signature;
5924 * } SignatureAndHashAlgorithm;
5925 *
5926 * SignatureAndHashAlgorithm
5927 * supported_signature_algorithms<2..2^16-2>;
5928 *
5929 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5930 * generalization of the TLS 1.2 signature algorithm extension.
5931 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5932 * `SignatureScheme` field of TLS 1.3
5933 *
5934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005935int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5936 const unsigned char *buf,
5937 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005938{
5939 const unsigned char *p = buf;
5940 size_t supported_sig_algs_len = 0;
5941 const unsigned char *supported_sig_algs_end;
5942 uint16_t sig_alg;
5943 uint32_t common_idx = 0;
5944
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5946 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005947 p += 2;
5948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 memset(ssl->handshake->received_sig_algs, 0,
5950 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005951
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005953 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 while (p < supported_sig_algs_end) {
5955 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5956 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005957 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5959 sig_alg,
5960 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005961#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5963 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5964 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005965 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005966 }
5967#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5970 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005971
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005973 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5974 common_idx += 1;
5975 }
5976 }
5977 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 if (p != end) {
5979 MBEDTLS_SSL_DEBUG_MSG(1,
5980 ("Signature algorithms extension length misaligned"));
5981 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5982 MBEDTLS_ERR_SSL_DECODE_ERROR);
5983 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02005984 }
5985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 if (common_idx == 0) {
5987 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
5988 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
5989 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
5990 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02005991 }
5992
Gabor Mezei15b95a62022-05-09 16:37:58 +02005993 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02005995}
5996
Ronald Crone68ab4f2022-10-05 12:46:29 +02005997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02005998
Jerry Yudc7bd172022-02-17 13:44:15 +08005999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6000
6001#if defined(MBEDTLS_USE_PSA_CRYPTO)
6002
Gilles Peskine449bd832023-01-11 14:50:10 +01006003static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6004 mbedtls_svc_key_id_t key,
6005 psa_algorithm_t alg,
6006 const unsigned char *raw_psk, size_t raw_psk_length,
6007 const unsigned char *seed, size_t seed_length,
6008 const unsigned char *label, size_t label_length,
6009 const unsigned char *other_secret,
6010 size_t other_secret_length,
6011 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006012{
6013 psa_status_t status;
6014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 status = psa_key_derivation_setup(derivation, alg);
6016 if (status != PSA_SUCCESS) {
6017 return status;
6018 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6021 status = psa_key_derivation_input_bytes(derivation,
6022 PSA_KEY_DERIVATION_INPUT_SEED,
6023 seed, seed_length);
6024 if (status != PSA_SUCCESS) {
6025 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006026 }
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (other_secret != NULL) {
6029 status = psa_key_derivation_input_bytes(derivation,
6030 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6031 other_secret, other_secret_length);
6032 if (status != PSA_SUCCESS) {
6033 return status;
6034 }
6035 }
6036
6037 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006038 status = psa_key_derivation_input_bytes(
6039 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 raw_psk, raw_psk_length);
6041 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006042 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (status != PSA_SUCCESS) {
6046 return status;
6047 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 status = psa_key_derivation_input_bytes(derivation,
6050 PSA_KEY_DERIVATION_INPUT_LABEL,
6051 label, label_length);
6052 if (status != PSA_SUCCESS) {
6053 return status;
6054 }
6055 } else {
6056 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006057 }
6058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 status = psa_key_derivation_set_capacity(derivation, capacity);
6060 if (status != PSA_SUCCESS) {
6061 return status;
6062 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006065}
6066
Andrzej Kurek57d10632022-10-24 10:32:01 -04006067#if defined(PSA_WANT_ALG_SHA_384) || \
6068 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006069MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006070static int tls_prf_generic(mbedtls_md_type_t md_type,
6071 const unsigned char *secret, size_t slen,
6072 const char *label,
6073 const unsigned char *random, size_t rlen,
6074 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006075{
6076 psa_status_t status;
6077 psa_algorithm_t alg;
6078 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6079 psa_key_derivation_operation_t derivation =
6080 PSA_KEY_DERIVATION_OPERATION_INIT;
6081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006083 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006085 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006087
6088 /* Normally a "secret" should be long enough to be impossible to
6089 * find by brute force, and in particular should not be empty. But
6090 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6091 * and for this use case it makes sense to have a 0-length "secret".
6092 * Since the key API doesn't allow importing a key of length 0,
6093 * keep master_key=0, which setup_psa_key_derivation() understands
6094 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006096 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6098 psa_set_key_algorithm(&key_attributes, alg);
6099 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006100
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6102 if (status != PSA_SUCCESS) {
6103 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6104 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006105 }
6106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 status = setup_psa_key_derivation(&derivation,
6108 master_key, alg,
6109 NULL, 0,
6110 random, rlen,
6111 (unsigned char const *) label,
6112 (size_t) strlen(label),
6113 NULL, 0,
6114 dlen);
6115 if (status != PSA_SUCCESS) {
6116 psa_key_derivation_abort(&derivation);
6117 psa_destroy_key(master_key);
6118 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006119 }
6120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6122 if (status != PSA_SUCCESS) {
6123 psa_key_derivation_abort(&derivation);
6124 psa_destroy_key(master_key);
6125 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006126 }
6127
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 status = psa_key_derivation_abort(&derivation);
6129 if (status != PSA_SUCCESS) {
6130 psa_destroy_key(master_key);
6131 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006132 }
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 if (!mbedtls_svc_key_id_is_null(master_key)) {
6135 status = psa_destroy_key(master_key);
6136 }
6137 if (status != PSA_SUCCESS) {
6138 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6139 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006142}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006143#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006144#else /* MBEDTLS_USE_PSA_CRYPTO */
6145
Andrzej Kurek57d10632022-10-24 10:32:01 -04006146#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006147 (defined(MBEDTLS_MD_CAN_SHA256) || \
6148 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006149MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006150static int tls_prf_generic(mbedtls_md_type_t md_type,
6151 const unsigned char *secret, size_t slen,
6152 const char *label,
6153 const unsigned char *random, size_t rlen,
6154 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006155{
6156 size_t nb;
6157 size_t i, j, k, md_len;
6158 unsigned char *tmp;
6159 size_t tmp_len = 0;
6160 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6161 const mbedtls_md_info_t *md_info;
6162 mbedtls_md_context_t md_ctx;
6163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006166
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6168 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6169 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006170
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 tmp_len = md_len + strlen(label) + rlen;
6174 tmp = mbedtls_calloc(1, tmp_len);
6175 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006176 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6177 goto exit;
6178 }
6179
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 nb = strlen(label);
6181 memcpy(tmp + md_len, label, nb);
6182 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006183 nb += rlen;
6184
6185 /*
6186 * Compute P_<hash>(secret, label + random)[0..dlen]
6187 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006191
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6193 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 }
6196 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6197 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006198 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
6200 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6201 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 for (i = 0; i < dlen; i += md_len) {
6206 ret = mbedtls_md_hmac_reset(&md_ctx);
6207 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006208 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 }
6210 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6211 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006212 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 }
6214 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6215 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 ret = mbedtls_md_hmac_reset(&md_ctx);
6220 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 }
6223 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6224 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 }
6227 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006233
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006235 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006237 }
6238
6239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006241
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (tmp != NULL) {
6243 mbedtls_platform_zeroize(tmp, tmp_len);
6244 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006251}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006252#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006253#endif /* MBEDTLS_USE_PSA_CRYPTO */
6254
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006255#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006257static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6258 const char *label,
6259 const unsigned char *random, size_t rlen,
6260 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006261{
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6263 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006264}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006265#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006266
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006267#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006268MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006269static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6270 const char *label,
6271 const unsigned char *random, size_t rlen,
6272 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006273{
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6275 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006276}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006277#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006278
Jerry Yuf009d862022-02-17 14:01:37 +08006279/*
6280 * Set appropriate PRF function and other SSL / TLS1.2 functions
6281 *
6282 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006283 * - hash associated with the ciphersuite (only used by TLS 1.2)
6284 *
6285 * Outputs:
6286 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6287 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006289static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6290 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006291{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006292#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006294 handshake->tls_prf = tls_prf_sha384;
6295 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6296 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006298#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006299#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006300 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006301 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006302 handshake->tls_prf = tls_prf_sha256;
6303 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6304 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6305 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006306#else
Jerry Yuf009d862022-02-17 14:01:37 +08006307 {
Jerry Yuf009d862022-02-17 14:01:37 +08006308 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006309 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006311 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006312#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006315}
Jerry Yud6ab2352022-02-17 14:03:43 +08006316
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006317/*
6318 * Compute master secret if needed
6319 *
6320 * Parameters:
6321 * [in/out] handshake
6322 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6323 * (PSA-PSK) ciphersuite_info, psk_opaque
6324 * [out] premaster (cleared)
6325 * [out] master
6326 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6327 * debug: conf->f_dbg, conf->p_dbg
6328 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006329 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006330 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006331MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006332static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6333 unsigned char *master,
6334 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006335{
6336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6337
6338 /* cf. RFC 5246, Section 8.1:
6339 * "The master secret is always exactly 48 bytes in length." */
6340 size_t const master_secret_len = 48;
6341
6342#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6343 unsigned char session_hash[48];
6344#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6345
6346 /* The label for the KDF used for key expansion.
6347 * This is either "master secret" or "extended master secret"
6348 * depending on whether the Extended Master Secret extension
6349 * is used. */
6350 char const *lbl = "master secret";
6351
Przemek Stekielae4ed302022-04-05 17:15:55 +02006352 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006353 * - If the Extended Master Secret extension is not used,
6354 * this is ClientHello.Random + ServerHello.Random
6355 * (see Sect. 8.1 in RFC 5246).
6356 * - If the Extended Master Secret extension is used,
6357 * this is the transcript of the handshake so far.
6358 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006359 unsigned char const *seed = handshake->randbytes;
6360 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006361
6362#if !defined(MBEDTLS_DEBUG_C) && \
6363 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6364 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366 ssl = NULL; /* make sure we don't use it except for those cases */
6367 (void) ssl;
6368#endif
6369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (handshake->resume != 0) {
6371 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6372 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006373 }
6374
6375#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006377 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006378 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006379 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6380 if (ret != 0) {
6381 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6382 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006383
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6385 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006387#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006388
Przemek Stekiel99114f32022-04-22 11:20:09 +02006389#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006390 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006392 /* Perform PSK-to-MS expansion in a single step. */
6393 psa_status_t status;
6394 psa_algorithm_t alg;
6395 mbedtls_svc_key_id_t psk;
6396 psa_key_derivation_operation_t derivation =
6397 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006398 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006399
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006410 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006414 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006415 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006416 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006417 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006418 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006419 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006420 other_secret_len = 48;
6421 other_secret = handshake->premaster + 2;
6422 break;
6423 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006424 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006425 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6426 other_secret = handshake->premaster + 2;
6427 break;
6428 default:
6429 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006430 }
6431
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 status = setup_psa_key_derivation(&derivation, psk, alg,
6433 ssl->conf->psk, ssl->conf->psk_len,
6434 seed, seed_len,
6435 (unsigned char const *) lbl,
6436 (size_t) strlen(lbl),
6437 other_secret, other_secret_len,
6438 master_secret_len);
6439 if (status != PSA_SUCCESS) {
6440 psa_key_derivation_abort(&derivation);
6441 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006442 }
6443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 status = psa_key_derivation_output_bytes(&derivation,
6445 master,
6446 master_secret_len);
6447 if (status != PSA_SUCCESS) {
6448 psa_key_derivation_abort(&derivation);
6449 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006450 }
6451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 status = psa_key_derivation_abort(&derivation);
6453 if (status != PSA_SUCCESS) {
6454 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6455 }
6456 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006457#endif
6458 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006459#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6461 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006462 psa_status_t status;
6463 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6464 psa_key_derivation_operation_t derivation =
6465 PSA_KEY_DERIVATION_OPERATION_INIT;
6466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006468
6469 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 status = psa_key_derivation_setup(&derivation, alg);
6472 if (status != PSA_SUCCESS) {
6473 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006474 }
6475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 status = psa_key_derivation_set_capacity(&derivation,
6477 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6478 if (status != PSA_SUCCESS) {
6479 psa_key_derivation_abort(&derivation);
6480 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006481 }
6482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6484 &derivation);
6485 if (status != PSA_SUCCESS) {
6486 psa_key_derivation_abort(&derivation);
6487 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006488 }
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 status = psa_key_derivation_output_bytes(&derivation,
6491 handshake->premaster,
6492 handshake->pmslen);
6493 if (status != PSA_SUCCESS) {
6494 psa_key_derivation_abort(&derivation);
6495 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6496 }
6497
6498 status = psa_key_derivation_abort(&derivation);
6499 if (status != PSA_SUCCESS) {
6500 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006501 }
6502 }
6503#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6505 lbl, seed, seed_len,
6506 master,
6507 master_secret_len);
6508 if (ret != 0) {
6509 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6510 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006511 }
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6514 handshake->premaster,
6515 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 mbedtls_platform_zeroize(handshake->premaster,
6518 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006519 }
6520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006522}
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006525{
6526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6527 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6528 ssl->handshake->ciphersuite_info;
6529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006531
6532 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006534 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 if (ret != 0) {
6536 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6537 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006538 }
6539
6540 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 ret = ssl_compute_master(ssl->handshake,
6542 ssl->session_negotiate->master,
6543 ssl);
6544 if (ret != 0) {
6545 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6546 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006547 }
6548
6549 /* Swap the client and server random values:
6550 * - MS derivation wanted client+server (RFC 5246 8.1)
6551 * - key derivation wants server+client (RFC 5246 6.3) */
6552 {
6553 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 memcpy(tmp, ssl->handshake->randbytes, 64);
6555 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6556 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6557 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006558 }
6559
6560 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6562 ssl->session_negotiate->ciphersuite,
6563 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006564#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006566#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 ssl->handshake->tls_prf,
6568 ssl->handshake->randbytes,
6569 ssl->tls_version,
6570 ssl->conf->endpoint,
6571 ssl);
6572 if (ret != 0) {
6573 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6574 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006575 }
6576
6577 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6579 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006580
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006582
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006584}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006585
Gilles Peskine449bd832023-01-11 14:50:10 +01006586int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006587{
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006589#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006590 case MBEDTLS_SSL_HASH_SHA384:
6591 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6592 break;
6593#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006594#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006595 case MBEDTLS_SSL_HASH_SHA256:
6596 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6597 break;
6598#endif
6599 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006601 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006602#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6603 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006604 (void) ssl;
6605#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006607}
6608
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006609#if defined(MBEDTLS_USE_PSA_CRYPTO)
6610static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6611 const psa_hash_operation_t *hs_op,
6612 size_t buffer_size,
6613 unsigned char *hash,
6614 size_t *hlen)
6615{
6616 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006617 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006618
6619#if !defined(MBEDTLS_DEBUG_C)
6620 (void) ssl;
6621#endif
6622 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006623 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006624 if (status != PSA_SUCCESS) {
6625 goto exit;
6626 }
6627
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006628 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006629 if (status != PSA_SUCCESS) {
6630 goto exit;
6631 }
6632
6633 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6634 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6635
6636exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006637 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006638 return mbedtls_md_error_from_psa(status);
6639}
6640#else
6641static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6642 const mbedtls_md_context_t *hs_ctx,
6643 unsigned char *hash,
6644 size_t *hlen)
6645{
6646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006647 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006648
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006649 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006650
6651#if !defined(MBEDTLS_DEBUG_C)
6652 (void) ssl;
6653#endif
6654 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6655
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006656 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006657 if (ret != 0) {
6658 goto exit;
6659 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006660 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006661 if (ret != 0) {
6662 goto exit;
6663 }
6664
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006665 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006666 if (ret != 0) {
6667 goto exit;
6668 }
6669
6670 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6671
6672 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6673 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6674
6675exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006676 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006677 return ret;
6678}
6679#endif /* MBEDTLS_USE_PSA_CRYPTO */
6680
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006681#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006682int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6683 unsigned char *hash,
6684 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006685{
6686#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006687 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6688 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006689#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006690 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6691 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006692#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006693}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006694#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006695
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006696#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006697int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6698 unsigned char *hash,
6699 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006700{
6701#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006702 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6703 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006704#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006705 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6706 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006707#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006708}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006709#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006710
Neil Armstrong80f6f322022-05-03 17:56:38 +02006711#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6712 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006713int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006714{
6715 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006717 const unsigned char *psk = NULL;
6718 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006722 /*
6723 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006724 * checked before calling this function.
6725 *
6726 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006727 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006728 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6730 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6731 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006732 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006733 }
6734
6735 /*
6736 * PMS = struct {
6737 * opaque other_secret<0..2^16-1>;
6738 * opaque psk<0..2^16-1>;
6739 * };
6740 * with "other_secret" depending on the particular key exchange
6741 */
6742#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6744 if (end - p < 2) {
6745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6746 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006747
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006749 p += 2;
6750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 if (end < p || (size_t) (end - p) < psk_len) {
6752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6753 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006754
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006756 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006758#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6759#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006761 /*
6762 * other_secret already set by the ClientKeyExchange message,
6763 * and is 48 bytes long
6764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 if (end - p < 2) {
6766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6767 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006768
6769 *p++ = 0;
6770 *p++ = 48;
6771 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006773#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6774#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6777 size_t len;
6778
6779 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6781 p + 2, end - (p + 2), &len,
6782 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6783 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6784 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006785 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006787 p += 2 + len;
6788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6790 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006791#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006792#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006794 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6795 size_t zlen;
6796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6798 p + 2, end - (p + 2),
6799 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6800 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6801 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006802 }
6803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006805 p += 2 + zlen;
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6808 MBEDTLS_DEBUG_ECDH_Z);
6809 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006810#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6813 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006814 }
6815
6816 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 if (end - p < 2) {
6818 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6819 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 p += 2;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (end < p || (size_t) (end - p) < psk_len) {
6825 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6826 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006829 p += psk_len;
6830
6831 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006834}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006835#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006836
6837#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006838MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006839static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006840
6841#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006842int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006843{
6844 /* If renegotiation is not enforced, retransmit until we would reach max
6845 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006847 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6848 unsigned char doublings = 1;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006851 ++doublings;
6852 ratio >>= 1;
6853 }
6854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 if (++ssl->renego_records_seen > doublings) {
6856 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6857 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006858 }
6859 }
6860
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006862}
6863#endif
6864#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006865
Jerry Yud9526692022-02-17 14:23:47 +08006866/*
6867 * Handshake functions
6868 */
6869#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6870/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006871int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006872{
6873 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6874 ssl->handshake->ciphersuite_info;
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6879 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006880 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006882 }
6883
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6885 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006886}
6887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006889{
6890 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6891 ssl->handshake->ciphersuite_info;
6892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6896 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006897 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006899 }
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6902 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006903}
6904
6905#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6906/* Some certificate support -> implement write and parse */
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006909{
6910 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6911 size_t i, n;
6912 const mbedtls_x509_crt *crt;
6913 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6914 ssl->handshake->ciphersuite_info;
6915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6919 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006920 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006922 }
6923
6924#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6926 if (ssl->handshake->client_auth == 0) {
6927 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006928 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006930 }
6931 }
6932#endif /* MBEDTLS_SSL_CLI_C */
6933#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6935 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006936 /* Should never happen because we shouldn't have picked the
6937 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006939 }
6940 }
6941#endif
6942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006944
6945 /*
6946 * 0 . 0 handshake type
6947 * 1 . 3 handshake length
6948 * 4 . 6 length of all certs
6949 * 7 . 9 length of cert. 1
6950 * 10 . n-1 peer certificate
6951 * n . n+2 length of cert. 2
6952 * n+3 . ... upper level cert, etc.
6953 */
6954 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006956
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006958 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6960 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6961 " > %" MBEDTLS_PRINTF_SIZET,
6962 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6963 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006964 }
6965
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6967 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6968 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006969
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006971 i += n; crt = crt->next;
6972 }
6973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6975 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6976 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006977
6978 ssl->out_msglen = i;
6979 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6980 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6981
6982 ssl->state++;
6983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6985 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6986 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006987 }
6988
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006992}
6993
6994#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6995
6996#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006997MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006998static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6999 unsigned char *crt_buf,
7000 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007001{
7002 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 if (peer_crt == NULL) {
7005 return -1;
7006 }
Jerry Yud9526692022-02-17 14:23:47 +08007007
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 if (peer_crt->raw.len != crt_buf_len) {
7009 return -1;
7010 }
Jerry Yud9526692022-02-17 14:23:47 +08007011
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007013}
7014#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007016static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7017 unsigned char *crt_buf,
7018 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007019{
7020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7021 unsigned char const * const peer_cert_digest =
7022 ssl->session->peer_cert_digest;
7023 mbedtls_md_type_t const peer_cert_digest_type =
7024 ssl->session->peer_cert_digest_type;
7025 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007027 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7028 size_t digest_len;
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (peer_cert_digest == NULL || digest_info == NULL) {
7031 return -1;
7032 }
Jerry Yud9526692022-02-17 14:23:47 +08007033
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 digest_len = mbedtls_md_get_size(digest_info);
7035 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7036 return -1;
7037 }
Jerry Yud9526692022-02-17 14:23:47 +08007038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7040 if (ret != 0) {
7041 return -1;
7042 }
Jerry Yud9526692022-02-17 14:23:47 +08007043
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007045}
7046#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7047#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7048
7049/*
7050 * Once the certificate message is read, parse it into a cert chain and
7051 * perform basic checks, but leave actual verification to the caller
7052 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007053MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007054static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7055 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007056{
7057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7058#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007060#endif
7061 size_t i, n;
7062 uint8_t alert;
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7065 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7066 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7067 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7068 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007069 }
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7072 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7073 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7074 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007075 }
7076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7078 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7079 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7080 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7081 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007082 }
7083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007085
7086 /*
7087 * Same message structure as in mbedtls_ssl_write_certificate()
7088 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 if (ssl->in_msg[i] != 0 ||
7092 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7093 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7094 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7095 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7096 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007097 }
7098
7099 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7100 i += 3;
7101
7102 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007104 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if (i + 3 > ssl->in_hslen) {
7106 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7107 mbedtls_ssl_send_alert_message(ssl,
7108 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7109 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7110 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007111 }
7112 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7113 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 if (ssl->in_msg[i] != 0) {
7115 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7116 mbedtls_ssl_send_alert_message(ssl,
7117 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7118 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7119 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007120 }
7121
7122 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007124 | (unsigned int) ssl->in_msg[i + 2];
7125 i += 3;
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 if (n < 128 || i + n > ssl->in_hslen) {
7128 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7129 mbedtls_ssl_send_alert_message(ssl,
7130 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7131 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7132 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007133 }
7134
7135 /* Check if we're handling the first CRT in the chain. */
7136#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007138 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007140 /* During client-side renegotiation, check that the server's
7141 * end-CRTs hasn't changed compared to the initial handshake,
7142 * mitigating the triple handshake attack. On success, reuse
7143 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7145 if (ssl_check_peer_crt_unchanged(ssl,
7146 &ssl->in_msg[i],
7147 n) != 0) {
7148 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7149 mbedtls_ssl_send_alert_message(ssl,
7150 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7151 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7152 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007153 }
7154
7155 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007157 }
7158#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7159
7160 /* Parse the next certificate in the chain. */
7161#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007163#else
7164 /* If we don't need to store the CRT chain permanently, parse
7165 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007167#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007169 case 0: /*ok*/
7170 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7171 /* Ignore certificate with an unknown algorithm: maybe a
7172 prior certificate was already trusted. */
7173 break;
7174
7175 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7176 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7177 goto crt_parse_der_failed;
7178
7179 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7180 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7181 goto crt_parse_der_failed;
7182
7183 default:
7184 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007185crt_parse_der_failed:
7186 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7187 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7188 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007189 }
7190
7191 i += n;
7192 }
7193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7195 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007196}
7197
7198#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007199MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007200static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007201{
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7203 return -1;
7204 }
Jerry Yud9526692022-02-17 14:23:47 +08007205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007207 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7208 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7210 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7211 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007212 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007214}
7215#endif /* MBEDTLS_SSL_SRV_C */
7216
7217/* Check if a certificate message is expected.
7218 * Return either
7219 * - SSL_CERTIFICATE_EXPECTED, or
7220 * - SSL_CERTIFICATE_SKIP
7221 * indicating whether a Certificate message is expected or not.
7222 */
7223#define SSL_CERTIFICATE_EXPECTED 0
7224#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007225MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007226static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7227 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007228{
7229 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7230 ssl->handshake->ciphersuite_info;
7231
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7233 return SSL_CERTIFICATE_SKIP;
7234 }
Jerry Yud9526692022-02-17 14:23:47 +08007235
7236#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7238 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7239 return SSL_CERTIFICATE_SKIP;
7240 }
Jerry Yud9526692022-02-17 14:23:47 +08007241
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007243 ssl->session_negotiate->verify_result =
7244 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007246 }
7247 }
7248#else
7249 ((void) authmode);
7250#endif /* MBEDTLS_SSL_SRV_C */
7251
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007253}
7254
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007255MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007256static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7257 int authmode,
7258 mbedtls_x509_crt *chain,
7259 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007260{
7261 int ret = 0;
7262 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7263 ssl->handshake->ciphersuite_info;
7264 int have_ca_chain = 0;
7265
7266 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7267 void *p_vrfy;
7268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7270 return 0;
7271 }
Jerry Yud9526692022-02-17 14:23:47 +08007272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 if (ssl->f_vrfy != NULL) {
7274 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007275 f_vrfy = ssl->f_vrfy;
7276 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 } else {
7278 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007279 f_vrfy = ssl->conf->f_vrfy;
7280 p_vrfy = ssl->conf->p_vrfy;
7281 }
7282
7283 /*
7284 * Main check: verify certificate
7285 */
7286#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007288 ((void) rs_ctx);
7289 have_ca_chain = 1;
7290
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007292 ret = mbedtls_x509_crt_verify_with_ca_cb(
7293 chain,
7294 ssl->conf->f_ca_cb,
7295 ssl->conf->p_ca_cb,
7296 ssl->conf->cert_profile,
7297 ssl->hostname,
7298 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 f_vrfy, p_vrfy);
7300 } else
Jerry Yud9526692022-02-17 14:23:47 +08007301#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7302 {
7303 mbedtls_x509_crt *ca_chain;
7304 mbedtls_x509_crl *ca_crl;
7305
7306#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007308 ca_chain = ssl->handshake->sni_ca_chain;
7309 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 } else
Jerry Yud9526692022-02-17 14:23:47 +08007311#endif
7312 {
7313 ca_chain = ssl->conf->ca_chain;
7314 ca_crl = ssl->conf->ca_crl;
7315 }
7316
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007318 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 }
Jerry Yud9526692022-02-17 14:23:47 +08007320
7321 ret = mbedtls_x509_crt_verify_restartable(
7322 chain,
7323 ca_chain, ca_crl,
7324 ssl->conf->cert_profile,
7325 ssl->hostname,
7326 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007328 }
7329
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (ret != 0) {
7331 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007332 }
7333
7334#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7336 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7337 }
Jerry Yud9526692022-02-17 14:23:47 +08007338#endif
7339
7340 /*
7341 * Secondary checks: always done, but change 'ret' only if it was 0
7342 */
7343
Valerio Settiacd32c02023-06-29 18:06:29 +02007344#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007345 {
7346 const mbedtls_pk_context *pk = &chain->pk;
7347
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007348 /* If certificate uses an EC key, make sure the curve is OK.
7349 * This is a public key, so it can't be opaque, so can_do() is a good
7350 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007352 /* and in the unlikely case the above assumption no longer holds
7353 * we are making sure that pk_ec() here does not return a NULL
7354 */
Valerio Settid0405092023-05-24 13:16:40 +02007355 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7356 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7357 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007359 }
Valerio Setti97207782023-05-18 18:59:06 +02007360 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007361 ssl->session_negotiate->verify_result |=
7362 MBEDTLS_X509_BADCERT_BAD_KEY;
7363
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7365 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007366 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007367 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007368 }
Jerry Yud9526692022-02-17 14:23:47 +08007369 }
7370 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007371#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007372
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 if (mbedtls_ssl_check_cert_usage(chain,
7374 ciphersuite_info,
7375 !ssl->conf->endpoint,
7376 &ssl->session_negotiate->verify_result) != 0) {
7377 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7378 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007379 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 }
Jerry Yud9526692022-02-17 14:23:47 +08007381 }
7382
7383 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7384 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7385 * with details encoded in the verification flags. All other kinds
7386 * of error codes, including those from the user provided f_vrfy
7387 * functions, are treated as fatal and lead to a failure of
7388 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7390 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7391 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007392 ret = 0;
7393 }
7394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7396 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007397 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7398 }
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007401 uint8_t alert;
7402
7403 /* The certificate may have been rejected for several reasons.
7404 Pick one and send the corresponding alert. Which alert to send
7405 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007407 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007411 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007413 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007415 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007417 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007419 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007421 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007423 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007425 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007427 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 }
7429 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7430 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007431 }
7432
7433#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 if (ssl->session_negotiate->verify_result != 0) {
7435 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7436 (unsigned int) ssl->session_negotiate->verify_result));
7437 } else {
7438 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007439 }
7440#endif /* MBEDTLS_DEBUG_C */
7441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007443}
7444
7445#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007447static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7448 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007449{
7450 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7451 /* Remember digest of the peer's end-CRT. */
7452 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7454 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7455 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7456 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7457 mbedtls_ssl_send_alert_message(ssl,
7458 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7459 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007460
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007462 }
7463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 ret = mbedtls_md(mbedtls_md_info_from_type(
7465 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7466 start, len,
7467 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007468
7469 ssl->session_negotiate->peer_cert_digest_type =
7470 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7471 ssl->session_negotiate->peer_cert_digest_len =
7472 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007475}
7476
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007478static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7479 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007480{
7481 unsigned char *end = start + len;
7482 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7483
7484 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7486 ret = mbedtls_pk_parse_subpubkey(&start, end,
7487 &ssl->handshake->peer_pubkey);
7488 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007489 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007491 }
7492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007494}
7495#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007498{
7499 int ret = 0;
7500 int crt_expected;
7501#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7502 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7503 ? ssl->handshake->sni_authmode
7504 : ssl->conf->authmode;
7505#else
7506 const int authmode = ssl->conf->authmode;
7507#endif
7508 void *rs_ctx = NULL;
7509 mbedtls_x509_crt *chain = NULL;
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7514 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7515 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007516 goto exit;
7517 }
7518
7519#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (ssl->handshake->ecrs_enabled &&
7521 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007522 chain = ssl->handshake->ecrs_peer_cert;
7523 ssl->handshake->ecrs_peer_cert = NULL;
7524 goto crt_verify;
7525 }
7526#endif
7527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007529 /* mbedtls_ssl_read_record may have sent an alert already. We
7530 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007532 goto exit;
7533 }
7534
7535#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007537 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007540 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 }
Jerry Yud9526692022-02-17 14:23:47 +08007542
7543 goto exit;
7544 }
7545#endif /* MBEDTLS_SSL_SRV_C */
7546
7547 /* Clear existing peer CRT structure in case we tried to
7548 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7552 if (chain == NULL) {
7553 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7554 sizeof(mbedtls_x509_crt)));
7555 mbedtls_ssl_send_alert_message(ssl,
7556 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7557 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007558
7559 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7560 goto exit;
7561 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 ret = ssl_parse_certificate_chain(ssl, chain);
7565 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007566 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 }
Jerry Yud9526692022-02-17 14:23:47 +08007568
7569#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007571 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 }
Jerry Yud9526692022-02-17 14:23:47 +08007573
7574crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007576 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 }
Jerry Yud9526692022-02-17 14:23:47 +08007578#endif
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 ret = ssl_parse_certificate_verify(ssl, authmode,
7581 chain, rs_ctx);
7582 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007583 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 }
Jerry Yud9526692022-02-17 14:23:47 +08007585
7586#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7587 {
7588 unsigned char *crt_start, *pk_start;
7589 size_t crt_len, pk_len;
7590
7591 /* We parse the CRT chain without copying, so
7592 * these pointers point into the input buffer,
7593 * and are hence still valid after freeing the
7594 * CRT chain. */
7595
7596 crt_start = chain->raw.p;
7597 crt_len = chain->raw.len;
7598
7599 pk_start = chain->pk_raw.p;
7600 pk_len = chain->pk_raw.len;
7601
7602 /* Free the CRT structures before computing
7603 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 mbedtls_x509_crt_free(chain);
7605 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007606 chain = NULL;
7607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7609 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007610 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 }
Jerry Yud9526692022-02-17 14:23:47 +08007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7614 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007615 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 }
Jerry Yud9526692022-02-17 14:23:47 +08007617 }
7618#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7619 /* Pass ownership to session structure. */
7620 ssl->session_negotiate->peer_cert = chain;
7621 chain = NULL;
7622#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007625
7626exit:
7627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007629 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 }
Jerry Yud9526692022-02-17 14:23:47 +08007631
7632#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007634 ssl->handshake->ecrs_peer_cert = chain;
7635 chain = NULL;
7636 }
7637#endif
7638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (chain != NULL) {
7640 mbedtls_x509_crt_free(chain);
7641 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007642 }
7643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007645}
7646#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7647
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007648static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7649 unsigned char *padbuf, size_t hlen,
7650 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007651{
7652 int len = 12;
7653 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007654#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007655 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007656 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007657 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007658 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007659#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007660 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007661 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007662 mbedtls_md_context_t cloned_ctx;
7663 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007664#endif
7665
7666 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007668 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007672 ? "client finished"
7673 : "server finished";
7674
7675#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007676 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007677
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007678 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007680 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007681 }
7682
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007683 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007685 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007686 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007687 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007688#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007689 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007690
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007691 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007692 if (ret != 0) {
7693 goto exit;
7694 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007695 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007696 if (ret != 0) {
7697 goto exit;
7698 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007699
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007700 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007701 if (ret != 0) {
7702 goto exit;
7703 }
7704#endif /* MBEDTLS_USE_PSA_CRYPTO */
7705
7706 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7707
Jerry Yu615bd6f2022-02-17 14:25:15 +08007708 /*
7709 * TLSv1.2:
7710 * hash = PRF( master, finished_label,
7711 * Hash( handshake ) )[0.11]
7712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007714 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007715
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007717
Paul Elliottecb95be2023-08-11 16:41:04 +01007718 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007719
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007720 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007721
7722exit:
7723#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007724 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007725 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007726#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007727 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007728 return ret;
7729#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007730}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007731
7732#if defined(MBEDTLS_MD_CAN_SHA256)
7733static int ssl_calc_finished_tls_sha256(
7734 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7735{
7736 unsigned char padbuf[32];
7737 return ssl_calc_finished_tls_generic(ssl,
7738#if defined(MBEDTLS_USE_PSA_CRYPTO)
7739 &ssl->handshake->fin_sha256_psa,
7740#else
7741 &ssl->handshake->fin_sha256,
7742#endif
7743 padbuf, sizeof(padbuf),
7744 buf, from);
7745}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007746#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007747
Jerry Yub7ba49e2022-02-17 14:25:53 +08007748
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007749#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007750static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007752{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007753 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007754 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007755#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007756 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007757#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007758 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007759#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007760 padbuf, sizeof(padbuf),
7761 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007762}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007763#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007764
Gilles Peskine449bd832023-01-11 14:50:10 +01007765void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007766{
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007768
7769 /*
7770 * Free our handshake params
7771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 mbedtls_ssl_handshake_free(ssl);
7773 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007774 ssl->handshake = NULL;
7775
7776 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007777 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007778 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 if (ssl->transform) {
7780 mbedtls_ssl_transform_free(ssl->transform);
7781 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007782 }
7783 ssl->transform = ssl->transform_negotiate;
7784 ssl->transform_negotiate = NULL;
7785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007787}
7788
Gilles Peskine449bd832023-01-11 14:50:10 +01007789void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007790{
7791 int resume = ssl->handshake->resume;
7792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007794
7795#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007797 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7798 ssl->renego_records_seen = 0;
7799 }
7800#endif
7801
7802 /*
7803 * Free the previous session and switch in the current one
7804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007806#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7807 /* RFC 7366 3.1: keep the EtM state */
7808 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007810#endif
7811
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 mbedtls_ssl_session_free(ssl->session);
7813 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007814 }
7815 ssl->session = ssl->session_negotiate;
7816 ssl->session_negotiate = NULL;
7817
7818 /*
7819 * Add cache entry
7820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007822 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 resume == 0) {
7824 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7825 ssl->session->id,
7826 ssl->session->id_len,
7827 ssl->session) != 0) {
7828 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7829 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007830 }
7831
7832#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7834 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007835 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007837
7838 /* Keep last flight around in case we need to resend it:
7839 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7841 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007842#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007844
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007845 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007846
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007848}
7849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007851{
7852 int ret, hash_len;
7853
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007857
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007858 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7859 if (ret != 0) {
7860 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7861 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007862
7863 /*
7864 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7865 * may define some other value. Currently (early 2016), no defined
7866 * ciphersuite does this (and this is unlikely to change as activity has
7867 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7868 */
7869 hash_len = 12;
7870
7871#if defined(MBEDTLS_SSL_RENEGOTIATION)
7872 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007874#endif
7875
7876 ssl->out_msglen = 4 + hash_len;
7877 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7878 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7879
7880 /*
7881 * In case of session resuming, invert the client and server
7882 * ChangeCipherSpec messages order.
7883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007885#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007887 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007889#endif
7890#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007892 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007894#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007896 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007898
7899 /*
7900 * Switch to our negotiated transform and session parameters for outbound
7901 * data.
7902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904
7905#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007907 unsigned char i;
7908
7909 /* Remember current epoch settings for resending */
7910 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7912 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007913
7914 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007916
7917
7918 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 for (i = 2; i > 0; i--) {
7920 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 }
7923 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007924
7925 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (i == 0) {
7927 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7928 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007929 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007931#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933
7934 ssl->transform_out = ssl->transform_negotiate;
7935 ssl->session_out = ssl->session_negotiate;
7936
7937#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7939 mbedtls_ssl_send_flight_completed(ssl);
7940 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941#endif
7942
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7944 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7945 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007946 }
7947
7948#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7950 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7951 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7952 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007953 }
7954#endif
7955
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007959}
7960
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007961#define SSL_MAX_HASH_LEN 12
7962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007964{
7965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7966 unsigned int hash_len = 12;
7967 unsigned char buf[SSL_MAX_HASH_LEN];
7968
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007970
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007971 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7972 if (ret != 0) {
7973 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7974 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7977 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007978 goto exit;
7979 }
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7982 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7983 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7984 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007985 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7986 goto exit;
7987 }
7988
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7990 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7991 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007992 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7993 goto exit;
7994 }
7995
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7997 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7998 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7999 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008000 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8001 goto exit;
8002 }
8003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8005 buf, hash_len) != 0) {
8006 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8007 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8008 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008009 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8010 goto exit;
8011 }
8012
8013#if defined(MBEDTLS_SSL_RENEGOTIATION)
8014 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008016#endif
8017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008019#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008021 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008023#endif
8024#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008026 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008028#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008030 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008032
8033#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8035 mbedtls_ssl_recv_flight_completed(ssl);
8036 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008037#endif
8038
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008040
8041exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 mbedtls_platform_zeroize(buf, hash_len);
8043 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008044}
8045
Jerry Yu392112c2022-02-17 14:34:10 +08008046#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8047/*
8048 * Helper to get TLS 1.2 PRF from ciphersuite
8049 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008051static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008052{
Jerry Yu392112c2022-02-17 14:34:10 +08008053 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008055#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8057 return tls_prf_sha384;
8058 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008059#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008060#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008061 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8063 return tls_prf_sha256;
8064 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008065 }
8066#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008067#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8068 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008069 (void) ciphersuite_info;
8070#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008073}
8074#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008075
Gilles Peskine449bd832023-01-11 14:50:10 +01008076static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008077{
8078 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008079#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (tls_prf == tls_prf_sha384) {
8081 return MBEDTLS_SSL_TLS_PRF_SHA384;
8082 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008083#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008084#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 if (tls_prf == tls_prf_sha256) {
8086 return MBEDTLS_SSL_TLS_PRF_SHA256;
8087 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008088#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008090}
8091
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008092/*
8093 * Populate a transform structure with session keys and all the other
8094 * necessary information.
8095 *
8096 * Parameters:
8097 * - [in/out]: transform: structure to populate
8098 * [in] must be just initialised with mbedtls_ssl_transform_init()
8099 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8100 * - [in] ciphersuite
8101 * - [in] master
8102 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008103 * - [in] tls_prf: pointer to PRF to use for key derivation
8104 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008105 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008106 * - [in] endpoint: client or server
8107 * - [in] ssl: used for:
8108 * - ssl->conf->{f,p}_export_keys
8109 * [in] optionally used for:
8110 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8111 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008112MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008113static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8114 int ciphersuite,
8115 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008116#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008118#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 ssl_tls_prf_t tls_prf,
8120 const unsigned char randbytes[64],
8121 mbedtls_ssl_protocol_version tls_version,
8122 unsigned endpoint,
8123 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008124{
8125 int ret = 0;
8126 unsigned char keyblk[256];
8127 unsigned char *key1;
8128 unsigned char *key2;
8129 unsigned char *mac_enc;
8130 unsigned char *mac_dec;
8131 size_t mac_key_len = 0;
8132 size_t iv_copy_len;
8133 size_t keylen;
8134 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008135 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008136#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008137 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008138 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008139#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008140
8141#if defined(MBEDTLS_USE_PSA_CRYPTO)
8142 psa_key_type_t key_type;
8143 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8144 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008145 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008146 size_t key_bits;
8147 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8148#endif
8149
8150#if !defined(MBEDTLS_DEBUG_C) && \
8151 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008153 ssl = NULL; /* make sure we don't use it except for these cases */
8154 (void) ssl;
8155 }
8156#endif
8157
8158 /*
8159 * Some data just needs copying into the structure
8160 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008161#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008162 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008163#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008164 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008165
8166#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008168#endif
8169
8170#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008172 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8173 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008175 }
8176#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8177
8178 /*
8179 * Get various info structures
8180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8182 if (ciphersuite_info == NULL) {
8183 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8184 ciphersuite));
8185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008186 }
8187
Neil Armstrongab555e02022-04-04 11:07:59 +02008188 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008189#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008191#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008193
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008195 transform->taglen =
8196 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008198
8199#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008200 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 transform->taglen,
8202 &alg,
8203 &key_type,
8204 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008205 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008207 goto end;
8208 }
8209#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008210 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 if (cipher_info == NULL) {
8212 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8213 ciphersuite_info->cipher));
8214 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008215 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008216#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008217
Neil Armstronge4512952022-03-08 09:08:22 +01008218#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008219 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008221 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 (unsigned) ciphersuite_info->mac));
8223 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008224 }
8225#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008226 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if (md_info == NULL) {
8228 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8229 (unsigned) ciphersuite_info->mac));
8230 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008231 }
Neil Armstronge4512952022-03-08 09:08:22 +01008232#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008233
8234#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8235 /* Copy own and peer's CID if the use of the CID
8236 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8238 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008239
8240 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8242 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8243 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008244
8245 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8247 ssl->handshake->peer_cid_len);
8248 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8249 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250 }
8251#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8252
8253 /*
8254 * Compute key block using the PRF
8255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8257 if (ret != 0) {
8258 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8259 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008260 }
8261
Gilles Peskine449bd832023-01-11 14:50:10 +01008262 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8263 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8264 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8265 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8266 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267
8268 /*
8269 * Determine the appropriate key, IV and MAC length.
8270 */
8271
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008272#if defined(MBEDTLS_USE_PSA_CRYPTO)
8273 keylen = PSA_BITS_TO_BYTES(key_bits);
8274#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008276#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277
Valerio Settie5707042023-10-11 11:54:42 +02008278#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008280 size_t explicit_ivlen;
8281
8282 transform->maclen = 0;
8283 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284
8285 /* All modes haves 96-bit IVs, but the length of the static parts vary
8286 * with mode and version:
8287 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8288 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8289 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8290 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8291 * sequence number).
8292 */
8293 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008294
8295 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008296#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008298#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8300 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008301#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008302
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008304 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008306 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008308
8309 /* Minimum length of encrypted record */
8310 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8311 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 } else
Valerio Settie5707042023-10-11 11:54:42 +02008313#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008314#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008316 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008318#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008320#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008321 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008322#endif /* MBEDTLS_USE_PSA_CRYPTO */
8323
8324#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008325 /* Get MAC length */
8326 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8327#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008328 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8330 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8331 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008332 goto end;
8333 }
8334
8335 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008337#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008338 transform->maclen = mac_key_len;
8339
8340 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008343#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008344 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008345#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008346
8347 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008349 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008351 /*
8352 * GenericBlockCipher:
8353 * 1. if EtM is in use: one block plus MAC
8354 * otherwise: * first multiple of blocklen greater than maclen
8355 * 2. IV
8356 */
8357#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008359 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 + block_size;
8361 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008362#endif
8363 {
8364 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 + block_size
8366 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008367 }
8368
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008370 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 } else {
8372 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008373 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8374 goto end;
8375 }
8376 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008378#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8379 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8381 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008382 }
8383
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8385 (unsigned) keylen,
8386 (unsigned) transform->minlen,
8387 (unsigned) transform->ivlen,
8388 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008389
8390 /*
8391 * Finally setup the cipher contexts, IVs and MAC secrets.
8392 */
8393#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008395 key1 = keyblk + mac_key_len * 2;
8396 key2 = keyblk + mac_key_len * 2 + keylen;
8397
8398 mac_enc = keyblk;
8399 mac_dec = keyblk + mac_key_len;
8400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 iv_copy_len = (transform->fixed_ivlen) ?
8402 transform->fixed_ivlen : transform->ivlen;
8403 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8404 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8405 iv_copy_len);
8406 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008407#endif /* MBEDTLS_SSL_CLI_C */
8408#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008410 key1 = keyblk + mac_key_len * 2 + keylen;
8411 key2 = keyblk + mac_key_len * 2;
8412
8413 mac_enc = keyblk + mac_key_len;
8414 mac_dec = keyblk;
8415
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 iv_copy_len = (transform->fixed_ivlen) ?
8417 transform->fixed_ivlen : transform->ivlen;
8418 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8419 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8420 iv_copy_len);
8421 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008422#endif /* MBEDTLS_SSL_SRV_C */
8423 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008424 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008425 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8426 goto end;
8427 }
8428
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 if (ssl != NULL && ssl->f_export_keys != NULL) {
8430 ssl->f_export_keys(ssl->p_export_keys,
8431 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8432 master, 48,
8433 randbytes + 32,
8434 randbytes,
8435 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008436 }
8437
8438#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439 transform->psa_alg = alg;
8440
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8442 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8443 psa_set_key_algorithm(&attributes, alg);
8444 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008445
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 if ((status = psa_import_key(&attributes,
8447 key1,
8448 PSA_BITS_TO_BYTES(key_bits),
8449 &transform->psa_key_enc)) != PSA_SUCCESS) {
8450 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008451 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453 goto end;
8454 }
8455
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008457
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 if ((status = psa_import_key(&attributes,
8459 key2,
8460 PSA_BITS_TO_BYTES(key_bits),
8461 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008462 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008464 goto end;
8465 }
8466 }
8467#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8469 cipher_info)) != 0) {
8470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008471 goto end;
8472 }
8473
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8475 cipher_info)) != 0) {
8476 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008477 goto end;
8478 }
8479
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8481 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8482 MBEDTLS_ENCRYPT)) != 0) {
8483 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008484 goto end;
8485 }
8486
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8488 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8489 MBEDTLS_DECRYPT)) != 0) {
8490 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008491 goto end;
8492 }
8493
8494#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8496 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8497 MBEDTLS_PADDING_NONE)) != 0) {
8498 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008499 goto end;
8500 }
8501
Gilles Peskine449bd832023-01-11 14:50:10 +01008502 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8503 MBEDTLS_PADDING_NONE)) != 0) {
8504 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505 goto end;
8506 }
8507 }
8508#endif /* MBEDTLS_CIPHER_MODE_CBC */
8509#endif /* MBEDTLS_USE_PSA_CRYPTO */
8510
Neil Armstrong29c0c042022-03-17 17:47:28 +01008511#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8512 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8513 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008515#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008517
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8519 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8520 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008521
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 if ((status = psa_import_key(&attributes,
8523 mac_enc, mac_key_len,
8524 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008525 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008527 goto end;
8528 }
8529
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8531 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008532#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008534#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008536 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8538 PSA_KEY_USAGE_VERIFY_HASH);
8539 } else {
8540 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8541 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008542
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 if ((status = psa_import_key(&attributes,
8544 mac_dec, mac_key_len,
8545 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008546 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008548 goto end;
8549 }
8550#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8552 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008553 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 }
8555 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8556 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008557 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008559#endif /* MBEDTLS_USE_PSA_CRYPTO */
8560 }
8561#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8562
8563 ((void) mac_dec);
8564 ((void) mac_enc);
8565
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008566end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8568 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008569}
8570
Valerio Settia08b1a42022-11-17 15:10:02 +01008571#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8572 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008573int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 psa_pake_operation_t *pake_ctx,
8575 const unsigned char *buf,
8576 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008577{
8578 psa_status_t status;
8579 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008580 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008581 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8582 * At round two perform a single cycle
8583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 for (; remaining_steps > 0; remaining_steps--) {
8587 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008588 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008590 /* Length is stored at the first byte */
8591 size_t length = buf[input_offset];
8592 input_offset += 1;
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008595 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8596 }
8597
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 status = psa_pake_input(pake_ctx, step,
8599 buf + input_offset, length);
8600 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008601 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008602 }
8603
8604 input_offset += length;
8605 }
8606 }
8607
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008609 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008613}
8614
Valerio Setti6b3dab02022-11-17 17:14:54 +01008615int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 psa_pake_operation_t *pake_ctx,
8617 unsigned char *buf,
8618 size_t len, size_t *olen,
8619 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008620{
8621 psa_status_t status;
8622 size_t output_offset = 0;
8623 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008624 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008625 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8626 * At round two perform a single cycle
8627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008629
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 for (; remaining_steps > 0; remaining_steps--) {
8631 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8632 step <= PSA_PAKE_STEP_ZK_PROOF;
8633 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008634 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008635 * For each step, prepend 1 byte with the length of the data as
8636 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 status = psa_pake_output(pake_ctx, step,
8639 buf + output_offset + 1,
8640 len - output_offset - 1,
8641 &output_len);
8642 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008643 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008644 }
8645
Valerio Setti99d88c12022-11-22 16:03:43 +01008646 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008647
8648 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008649 }
8650 }
8651
8652 *olen = output_offset;
8653
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008655}
Valerio Settia08b1a42022-11-17 15:10:02 +01008656#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8657
Jerry Yuee40f9d2022-02-17 14:55:16 +08008658#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008659int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8660 unsigned char *hash, size_t *hashlen,
8661 unsigned char *data, size_t data_len,
8662 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008663{
8664 psa_status_t status;
8665 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008666 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008667
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008669
Gilles Peskine449bd832023-01-11 14:50:10 +01008670 if ((status = psa_hash_setup(&hash_operation,
8671 hash_alg)) != PSA_SUCCESS) {
8672 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008673 goto exit;
8674 }
8675
Gilles Peskine449bd832023-01-11 14:50:10 +01008676 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8677 64)) != PSA_SUCCESS) {
8678 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008679 goto exit;
8680 }
8681
Gilles Peskine449bd832023-01-11 14:50:10 +01008682 if ((status = psa_hash_update(&hash_operation,
8683 data, data_len)) != PSA_SUCCESS) {
8684 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008685 goto exit;
8686 }
8687
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8689 hashlen)) != PSA_SUCCESS) {
8690 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8691 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008692 }
8693
8694exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008695 if (status != PSA_SUCCESS) {
8696 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8697 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8698 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008699 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008701 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8702 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008703 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008704 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008706 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008708 }
8709 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008711}
8712
8713#else
8714
Gilles Peskine449bd832023-01-11 14:50:10 +01008715int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8716 unsigned char *hash, size_t *hashlen,
8717 unsigned char *data, size_t data_len,
8718 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008719{
8720 int ret = 0;
8721 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8723 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008724
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008726
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728
8729 /*
8730 * digitally-signed struct {
8731 * opaque client_random[32];
8732 * opaque server_random[32];
8733 * ServerDHParams params;
8734 * };
8735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008736 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8737 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008738 goto exit;
8739 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008740 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8741 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008742 goto exit;
8743 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008746 goto exit;
8747 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008748 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8749 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008750 goto exit;
8751 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8753 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008754 goto exit;
8755 }
8756
8757exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 if (ret != 0) {
8761 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8762 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8763 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008764
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008766}
8767#endif /* MBEDTLS_USE_PSA_CRYPTO */
8768
Jerry Yud9d91da2022-02-17 14:57:06 +08008769#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8770
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008771/* Find the preferred hash for a given signature algorithm. */
8772unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 mbedtls_ssl_context *ssl,
8774 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008775{
Gabor Mezei078e8032022-04-27 21:17:56 +02008776 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008777 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008778
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8780 return MBEDTLS_SSL_HASH_NONE;
8781 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008782
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008784 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8786 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008787 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8789 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008790
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008791 mbedtls_md_type_t md_alg =
8792 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8793 if (md_alg == MBEDTLS_MD_NONE) {
8794 continue;
8795 }
8796
Gilles Peskine449bd832023-01-11 14:50:10 +01008797 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008800 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008801 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008802
Gilles Peskine449bd832023-01-11 14:50:10 +01008803 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8804 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8805 PSA_ALG_ECDSA(psa_hash_alg),
8806 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008807 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008809
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8811 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8812 PSA_ALG_RSA_PKCS1V15_SIGN(
8813 psa_hash_alg),
8814 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008815 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008817 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008818#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008819
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008821 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008822 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008823
Gilles Peskine449bd832023-01-11 14:50:10 +01008824 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008825}
8826
8827#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8828
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008829/* Serialization of TLS 1.2 sessions:
8830 *
8831 * struct {
8832 * uint64 start_time;
8833 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008834 * uint8 session_id_len; // at most 32
8835 * opaque session_id[32];
8836 * opaque master[48]; // fixed length in the standard
8837 * uint32 verify_result;
8838 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8839 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8840 * uint32 ticket_lifetime;
8841 * uint8 mfl_code; // up to 255 according to standard
8842 * uint8 encrypt_then_mac; // 0 or 1
8843 * } serialized_session_tls12;
8844 *
8845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008846static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8847 unsigned char *buf,
8848 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008849{
8850 unsigned char *p = buf;
8851 size_t used = 0;
8852
8853#if defined(MBEDTLS_HAVE_TIME)
8854 uint64_t start;
8855#endif
8856#if defined(MBEDTLS_X509_CRT_PARSE_C)
8857#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8858 size_t cert_len;
8859#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8860#endif /* MBEDTLS_X509_CRT_PARSE_C */
8861
8862 /*
8863 * Time
8864 */
8865#if defined(MBEDTLS_HAVE_TIME)
8866 used += 8;
8867
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008869 start = (uint64_t) session->start;
8870
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008872 p += 8;
8873 }
8874#endif /* MBEDTLS_HAVE_TIME */
8875
8876 /*
8877 * Basic mandatory fields
8878 */
8879 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008880 + 1 /* id_len */
8881 + sizeof(session->id)
8882 + sizeof(session->master)
8883 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008884
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if (used <= buf_len) {
8886 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008887 p += 2;
8888
Gilles Peskine449bd832023-01-11 14:50:10 +01008889 *p++ = MBEDTLS_BYTE_0(session->id_len);
8890 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008891 p += 32;
8892
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008894 p += 48;
8895
Gilles Peskine449bd832023-01-11 14:50:10 +01008896 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008897 p += 4;
8898 }
8899
8900 /*
8901 * Peer's end-entity certificate
8902 */
8903#if defined(MBEDTLS_X509_CRT_PARSE_C)
8904#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008906 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008908 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008910
8911 used += 3 + cert_len;
8912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 if (used <= buf_len) {
8914 *p++ = MBEDTLS_BYTE_2(cert_len);
8915 *p++ = MBEDTLS_BYTE_1(cert_len);
8916 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008917
Gilles Peskine449bd832023-01-11 14:50:10 +01008918 if (session->peer_cert != NULL) {
8919 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008920 p += cert_len;
8921 }
8922 }
8923#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008925 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008927 *p++ = (unsigned char) session->peer_cert_digest_type;
8928 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008929 memcpy(p, session->peer_cert_digest,
8930 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008931 p += session->peer_cert_digest_len;
8932 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008933 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008934 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008935 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008936 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8937 *p++ = 0;
8938 }
8939 }
8940#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8941#endif /* MBEDTLS_X509_CRT_PARSE_C */
8942
8943 /*
8944 * Session ticket if any, plus associated data
8945 */
8946#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8947 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8948
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 if (used <= buf_len) {
8950 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8951 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8952 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008953
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 if (session->ticket != NULL) {
8955 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008956 p += session->ticket_len;
8957 }
8958
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008960 p += 4;
8961 }
8962#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8963
8964 /*
8965 * Misc extension-related info
8966 */
8967#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8968 used += 1;
8969
Gilles Peskine449bd832023-01-11 14:50:10 +01008970 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008971 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973#endif
8974
8975#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8976 used += 1;
8977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if (used <= buf_len) {
8979 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8980 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008981#endif
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008984}
8985
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008986MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008987static int ssl_tls12_session_load(mbedtls_ssl_session *session,
8988 const unsigned char *buf,
8989 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990{
8991#if defined(MBEDTLS_HAVE_TIME)
8992 uint64_t start;
8993#endif
8994#if defined(MBEDTLS_X509_CRT_PARSE_C)
8995#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8996 size_t cert_len;
8997#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8998#endif /* MBEDTLS_X509_CRT_PARSE_C */
8999
9000 const unsigned char *p = buf;
9001 const unsigned char * const end = buf + len;
9002
9003 /*
9004 * Time
9005 */
9006#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 if (8 > (size_t) (end - p)) {
9008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9009 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009010
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009011 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009012 p += 8;
9013
9014 session->start = (time_t) start;
9015#endif /* MBEDTLS_HAVE_TIME */
9016
9017 /*
9018 * Basic mandatory fields
9019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009020 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9022 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009023
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009025 p += 2;
9026
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 p += 32;
9030
Gilles Peskine449bd832023-01-11 14:50:10 +01009031 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009032 p += 48;
9033
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009034 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009035 p += 4;
9036
9037 /* Immediately clear invalid pointer values that have been read, in case
9038 * we exit early before we replaced them with valid ones. */
9039#if defined(MBEDTLS_X509_CRT_PARSE_C)
9040#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9041 session->peer_cert = NULL;
9042#else
9043 session->peer_cert_digest = NULL;
9044#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9045#endif /* MBEDTLS_X509_CRT_PARSE_C */
9046#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9047 session->ticket = NULL;
9048#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9049
9050 /*
9051 * Peer certificate
9052 */
9053#if defined(MBEDTLS_X509_CRT_PARSE_C)
9054#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9055 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009056 if (3 > (size_t) (end - p)) {
9057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9058 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009059
Gilles Peskine449bd832023-01-11 14:50:10 +01009060 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009061 p += 3;
9062
Gilles Peskine449bd832023-01-11 14:50:10 +01009063 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 if (cert_len > (size_t) (end - p)) {
9067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9068 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009069
Gilles Peskine449bd832023-01-11 14:50:10 +01009070 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009071
Gilles Peskine449bd832023-01-11 14:50:10 +01009072 if (session->peer_cert == NULL) {
9073 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9074 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009075
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009077
Gilles Peskine449bd832023-01-11 14:50:10 +01009078 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9079 p, cert_len)) != 0) {
9080 mbedtls_x509_crt_free(session->peer_cert);
9081 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009082 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009084 }
9085
9086 p += cert_len;
9087 }
9088#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9089 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009090 if (2 > (size_t) (end - p)) {
9091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9092 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009093
9094 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
9095 session->peer_cert_digest_len = (size_t) *p++;
9096
Gilles Peskine449bd832023-01-11 14:50:10 +01009097 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009098 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9100 if (md_info == NULL) {
9101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9102 }
9103 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9105 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009106
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9108 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9109 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009110
9111 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 mbedtls_calloc(1, session->peer_cert_digest_len);
9113 if (session->peer_cert_digest == NULL) {
9114 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9115 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009116
Gilles Peskine449bd832023-01-11 14:50:10 +01009117 memcpy(session->peer_cert_digest, p,
9118 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009119 p += session->peer_cert_digest_len;
9120 }
9121#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9122#endif /* MBEDTLS_X509_CRT_PARSE_C */
9123
9124 /*
9125 * Session ticket and associated data
9126 */
9127#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 if (3 > (size_t) (end - p)) {
9129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9130 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009133 p += 3;
9134
Gilles Peskine449bd832023-01-11 14:50:10 +01009135 if (session->ticket_len != 0) {
9136 if (session->ticket_len > (size_t) (end - p)) {
9137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9138 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009139
Gilles Peskine449bd832023-01-11 14:50:10 +01009140 session->ticket = mbedtls_calloc(1, session->ticket_len);
9141 if (session->ticket == NULL) {
9142 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9143 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009146 p += session->ticket_len;
9147 }
9148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if (4 > (size_t) (end - p)) {
9150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9151 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009152
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009153 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009154 p += 4;
9155#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9156
9157 /*
9158 * Misc extension-related info
9159 */
9160#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 if (1 > (size_t) (end - p)) {
9162 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9163 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009164
9165 session->mfl_code = *p++;
9166#endif
9167
9168#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if (1 > (size_t) (end - p)) {
9170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9171 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009172
9173 session->encrypt_then_mac = *p++;
9174#endif
9175
9176 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (p != end) {
9178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9179 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009180
Gilles Peskine449bd832023-01-11 14:50:10 +01009181 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009182}
Jerry Yudc7bd172022-02-17 13:44:15 +08009183#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9184
XiaokangQian75d40ef2022-04-20 11:05:24 +00009185int mbedtls_ssl_validate_ciphersuite(
9186 const mbedtls_ssl_context *ssl,
9187 const mbedtls_ssl_ciphersuite_t *suite_info,
9188 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009189 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009190{
9191 (void) ssl;
9192
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 if (suite_info == NULL) {
9194 return -1;
9195 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009196
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 if ((suite_info->min_tls_version > max_tls_version) ||
9198 (suite_info->max_tls_version < min_tls_version)) {
9199 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009200 }
9201
XiaokangQian060d8672022-04-21 09:24:56 +00009202#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009203#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009204#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9206 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009207#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9209 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009210#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009211 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009213 }
9214#endif
9215
9216 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9217#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9219 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9220 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009221 }
9222#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9223#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9224
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009226}
9227
Ronald Crone68ab4f2022-10-05 12:46:29 +02009228#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009229/*
9230 * Function for writing a signature algorithm extension.
9231 *
9232 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9233 * value (TLS 1.3 RFC8446):
9234 * enum {
9235 * ....
9236 * ecdsa_secp256r1_sha256( 0x0403 ),
9237 * ecdsa_secp384r1_sha384( 0x0503 ),
9238 * ecdsa_secp521r1_sha512( 0x0603 ),
9239 * ....
9240 * } SignatureScheme;
9241 *
9242 * struct {
9243 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9244 * } SignatureSchemeList;
9245 *
9246 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9247 * value (TLS 1.2 RFC5246):
9248 * enum {
9249 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9250 * sha512(6), (255)
9251 * } HashAlgorithm;
9252 *
9253 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9254 * SignatureAlgorithm;
9255 *
9256 * struct {
9257 * HashAlgorithm hash;
9258 * SignatureAlgorithm signature;
9259 * } SignatureAndHashAlgorithm;
9260 *
9261 * SignatureAndHashAlgorithm
9262 * supported_signature_algorithms<2..2^16-2>;
9263 *
9264 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9265 * generalization of the TLS 1.2 signature algorithm extension.
9266 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9267 * `SignatureScheme` field of TLS 1.3
9268 *
9269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009270int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9271 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009272{
9273 unsigned char *p = buf;
9274 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9275 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9276
9277 *out_len = 0;
9278
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009280
9281 /* Check if we have space for header and length field:
9282 * - extension_type (2 bytes)
9283 * - extension_data_length (2 bytes)
9284 * - supported_signature_algorithms_length (2 bytes)
9285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009286 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009287 p += 6;
9288
9289 /*
9290 * Write supported_signature_algorithms
9291 */
9292 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009293 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9294 if (sig_alg == NULL) {
9295 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9296 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009297
Gilles Peskine449bd832023-01-11 14:50:10 +01009298 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9299 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9300 *sig_alg,
9301 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9302 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009303 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009304 }
9305 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9306 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009307 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009308 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9309 *sig_alg,
9310 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009311 }
9312
9313 /* Length of supported_signature_algorithms */
9314 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 if (supported_sig_alg_len == 0) {
9316 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9317 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009318 }
9319
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9321 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9322 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009323
XiaokangQianeaf36512022-04-24 09:07:44 +00009324 *out_len = p - buf;
9325
9326#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009327 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009328#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009331}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009332#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009333
XiaokangQian40a35232022-05-07 09:02:40 +00009334#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009335/*
9336 * mbedtls_ssl_parse_server_name_ext
9337 *
9338 * Structure of server_name extension:
9339 *
9340 * enum {
9341 * host_name(0), (255)
9342 * } NameType;
9343 * opaque HostName<1..2^16-1>;
9344 *
9345 * struct {
9346 * NameType name_type;
9347 * select (name_type) {
9348 * case host_name: HostName;
9349 * } name;
9350 * } ServerName;
9351 * struct {
9352 * ServerName server_name_list<1..2^16-1>
9353 * } ServerNameList;
9354 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009355MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009356int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9357 const unsigned char *buf,
9358 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009359{
9360 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9361 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009362 size_t server_name_list_len, hostname_len;
9363 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009364
Gilles Peskine449bd832023-01-11 14:50:10 +01009365 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009366
Gilles Peskine449bd832023-01-11 14:50:10 +01009367 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9368 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009369 p += 2;
9370
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009372 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009373 while (p < server_name_list_end) {
9374 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9375 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9376 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9377 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009378
Gilles Peskine449bd832023-01-11 14:50:10 +01009379 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009380 /* sni_name is intended to be used only during the parsing of the
9381 * ClientHello message (it is reset to NULL before the end of
9382 * the message parsing). Thus it is ok to just point to the
9383 * reception buffer and not make a copy of it.
9384 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009385 ssl->handshake->sni_name = p + 3;
9386 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 if (ssl->conf->f_sni == NULL) {
9388 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009389 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9391 ssl, p + 3, hostname_len);
9392 if (ret != 0) {
9393 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9394 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9395 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9396 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9397 }
9398 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009399 }
9400
9401 p += hostname_len + 3;
9402 }
9403
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009405}
9406#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9407
XiaokangQianacb39922022-06-17 10:18:48 +00009408#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009409MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009410int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9411 const unsigned char *buf,
9412 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009413{
9414 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009415 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009416 const unsigned char *protocol_name_list;
9417 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009418 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009419
9420 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 if (ssl->conf->alpn_list == NULL) {
9422 return 0;
9423 }
XiaokangQianacb39922022-06-17 10:18:48 +00009424
9425 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009426 * RFC7301, section 3.1
9427 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009428 *
XiaokangQianc7403452022-06-23 03:24:12 +00009429 * struct {
9430 * ProtocolName protocol_name_list<2..2^16-1>
9431 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009432 */
9433
XiaokangQianc7403452022-06-23 03:24:12 +00009434 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009435 * protocol_name_list_len 2 bytes
9436 * protocol_name_len 1 bytes
9437 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009440
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009442 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009443 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009444 protocol_name_list = p;
9445 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009446
9447 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009448 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009449 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009450 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9451 protocol_name_len);
9452 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009453 MBEDTLS_SSL_PEND_FATAL_ALERT(
9454 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9456 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009457 }
9458
9459 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009460 }
9461
9462 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009463 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9464 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009465 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009466 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009467 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009468 if (protocol_name_len == alpn_len &&
9469 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009470 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009471 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009472 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009473
9474 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009475 }
9476 }
9477
XiaokangQian95d5f542022-06-24 02:29:26 +00009478 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009479 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9481 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9482 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009483}
9484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9486 unsigned char *buf,
9487 unsigned char *end,
9488 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009489{
9490 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009491 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009492 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009493
Gilles Peskine449bd832023-01-11 14:50:10 +01009494 if (ssl->alpn_chosen == NULL) {
9495 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009496 }
9497
Gilles Peskine449bd832023-01-11 14:50:10 +01009498 protocol_name_len = strlen(ssl->alpn_chosen);
9499 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009500
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009502 /*
9503 * 0 . 1 ext identifier
9504 * 2 . 3 ext length
9505 * 4 . 5 protocol list length
9506 * 6 . 6 protocol name length
9507 * 7 . 7+n protocol name
9508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009509 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009510
XiaokangQian95d5f542022-06-24 02:29:26 +00009511 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009512
Gilles Peskine449bd832023-01-11 14:50:10 +01009513 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9514 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009515 /* Note: the length of the chosen protocol has been checked to be less
9516 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9517 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009519
Gilles Peskine449bd832023-01-11 14:50:10 +01009520 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009521
9522#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009523 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009524#endif
9525
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009527}
9528#endif /* MBEDTLS_SSL_ALPN */
9529
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009530#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009531 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009532 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009533 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009534int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9535 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009536{
9537 /* Initialize to suppress unnecessary compiler warning */
9538 size_t hostname_len = 0;
9539
9540 /* Check if new hostname is valid before
9541 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009542 if (hostname != NULL) {
9543 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9546 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9547 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009548 }
9549
9550 /* Now it's clear that we will overwrite the old hostname,
9551 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009553 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009554 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009555 }
9556
9557 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009559 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 } else {
9561 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9562 if (session->hostname == NULL) {
9563 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9564 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009565
Gilles Peskine449bd832023-01-11 14:50:10 +01009566 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009567 }
9568
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009570}
Xiaokang Qian03409292022-10-12 02:49:52 +00009571#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9572 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009573 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009574 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009576#endif /* MBEDTLS_SSL_TLS_C */