blob: 42d1b86b11404bff3206caa44acc1a895acb0f32 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/debug.h"
24#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
134 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000241
242#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
247 if (dst->peer_cert == NULL) {
248 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
249 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
254 src->peer_cert->raw.len)) != 0) {
255 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 }
259 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000260#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000262 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 mbedtls_calloc(1, src->peer_cert_digest_len);
264 if (dst->peer_cert_digest == NULL) {
265 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
266 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
269 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000270 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000271 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 }
273#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (src->ticket != NULL) {
279 dst->ticket = mbedtls_calloc(1, src->ticket_len);
280 if (dst->ticket == NULL) {
281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
282 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200285 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000286
287#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
288 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
292 if (ret != 0) {
293 return ret;
294 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000295 }
296#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
297 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200298#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301}
302
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500303#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100305static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500306{
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
308 if (resized_buffer == NULL) {
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500309 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500311
312 /* We want to copy len_new bytes when downsizing the buffer, and
313 * len_old bytes when upsizing, so we choose the smaller of two sizes,
314 * to fit one buffer into another. Size checks, ensuring that no data is
315 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 memcpy(resized_buffer, *buffer,
317 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100318 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319
320 *buffer = resized_buffer;
321 *len_old = len_new;
322
323 return 0;
324}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
327 size_t in_buf_new_len,
328 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200329{
330 int modified = 0;
331 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
332 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200334 written_in = ssl->in_msg - ssl->in_buf;
335 iv_offset_in = ssl->in_iv - ssl->in_buf;
336 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200338 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 ssl->in_buf_len < in_buf_new_len) {
340 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
341 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
342 } else {
343 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
344 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 modified = 1;
346 }
347 }
348 }
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 written_out = ssl->out_msg - ssl->out_buf;
352 iv_offset_out = ssl->out_iv - ssl->out_buf;
353 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200355 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 ssl->out_buf_len < out_buf_new_len) {
357 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
358 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
359 } else {
360 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
361 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 modified = 1;
363 }
364 }
365 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200369 /* Fields below might not be properly updated with record
370 * splitting or with CID, so they are manually updated here. */
371 ssl->out_msg = ssl->out_buf + written_out;
372 ssl->out_len = ssl->out_buf + len_offset_out;
373 ssl->out_iv = ssl->out_buf + iv_offset_out;
374
375 ssl->in_msg = ssl->in_buf + written_in;
376 ssl->in_len = ssl->in_buf + len_offset_in;
377 ssl->in_iv = ssl->in_buf + iv_offset_in;
378 }
379}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500380#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
381
Jerry Yudb8c48a2022-01-27 14:54:54 +0800382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800383
384#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100385typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
386 const char *label,
387 const unsigned char *random, size_t rlen,
388 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800391
392#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
393
394/* Type for the TLS PRF */
395typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
396 const unsigned char *, size_t,
397 unsigned char *, size_t);
398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
401 int ciphersuite,
402 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200405#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 ssl_tls_prf_t tls_prf,
407 const unsigned char randbytes[64],
408 mbedtls_ssl_protocol_version tls_version,
409 unsigned endpoint,
410 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800411
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100412#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100414static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300415 const char *label,
416 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100418static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
419static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100420
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100421#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100422
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100423#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100424MBEDTLS_CHECK_RETURN_CRITICAL
425static int tls_prf_sha384(const unsigned char *secret, size_t slen,
426 const char *label,
427 const unsigned char *random, size_t rlen,
428 unsigned char *dstbuf, size_t dlen);
429
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100430static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
431static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100432#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
434static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
435 unsigned char *buf,
436 size_t buf_len);
437
438MBEDTLS_CHECK_RETURN_CRITICAL
439static int ssl_tls12_session_load(mbedtls_ssl_session *session,
440 const unsigned char *buf,
441 size_t len);
442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
443
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100445
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100446#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100447static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100450#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100452#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100453
454int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
455 const unsigned char *secret, size_t slen,
456 const char *label,
457 const unsigned char *random, size_t rlen,
458 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300459{
460 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
461
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300463#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300465 case MBEDTLS_SSL_TLS_PRF_SHA384:
466 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100468#endif /* MBEDTLS_MD_CAN_SHA384*/
469#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470 case MBEDTLS_SSL_TLS_PRF_SHA256:
471 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100473#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 default:
476 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 }
478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300480}
481
Jerry Yuc73c6182022-02-08 20:29:25 +0800482#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800484{
485#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 if (session->peer_cert != NULL) {
487 mbedtls_x509_crt_free(session->peer_cert);
488 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800489 session->peer_cert = NULL;
490 }
491#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800493 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800495 session->peer_cert_digest = NULL;
496 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
497 session->peer_cert_digest_len = 0;
498 }
499#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
500}
501#endif /* MBEDTLS_X509_CRT_PARSE_C */
502
Gilles Peskine449bd832023-01-11 14:50:10 +0100503uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800504{
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800506 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800508
509 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800511
512 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100513 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800514
515 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800517
518 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
Jan Bruckner151f6422023-02-10 12:45:19 +0100584 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
585 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
586
Jerry Yu7a485c12022-10-31 13:08:18 +0800587 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593}
594
Gilles Peskine449bd832023-01-11 14:50:10 +0100595uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800596{
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800598}
599
Jerry Yud25cab02022-10-31 12:48:30 +0800600#if defined(MBEDTLS_DEBUG_C)
601static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800602 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800603 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
604 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
605 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
606 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
607 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
608 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
609 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
610 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
611 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
612 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
613 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
614 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
615 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
616 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
618 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
619 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
620 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
621 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
622 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
623 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
624 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
625 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
626 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
627 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
628 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100629 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
630 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800631};
632
Gilles Peskine449bd832023-01-11 14:50:10 +0100633static unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800634 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
635 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
636 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
637 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
639 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
640 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
641 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
642 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
643 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
644 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
645 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
646 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
647 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
648 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
650 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
651 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
652 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
653 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
654 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
655 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
656 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
657 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
658 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
659 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
660 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100661 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
662 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800663};
664
Gilles Peskine449bd832023-01-11 14:50:10 +0100665const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800666{
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return extension_name_table[
668 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800669}
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800674 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800676 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800678 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800680 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800682 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800684 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800690}
691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
693 int level, const char *file, int line,
694 int hs_msg_type, unsigned int extension_type,
695 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800696{
697 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800699 mbedtls_debug_print_msg(
700 ssl, level, file, line,
701 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 ssl_tls13_get_hs_msg_name(hs_msg_type),
703 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800704 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800706 return;
707 }
708
709 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type), extension_type,
715 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800716 return;
717 }
718
719 mbedtls_debug_print_msg(
720 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
722 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800723}
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
726 int level, const char *file, int line,
727 int hs_msg_type, uint32_t extensions_mask,
728 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800729{
730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 for (unsigned i = 0;
732 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
733 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800734 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800735 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800737 }
738}
739
Pengyu Lvee455c02023-01-12 14:37:24 +0800740#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800741static const char *ticket_flag_name_table[] =
742{
743 [0] = "ALLOW_PSK_RESUMPTION",
744 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
745 [3] = "ALLOW_EARLY_DATA",
746};
747
Pengyu Lv4938a562023-01-16 11:28:49 +0800748void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
749 int level, const char *file, int line,
750 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800751{
752 size_t i;
753
754 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800755 "print ticket_flags (0x%02x)", flags);
756
757 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800758
759 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800760 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800761 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
762 ticket_flag_name_table[i]);
763 }
764 }
765}
766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
767
Jerry Yud25cab02022-10-31 12:48:30 +0800768#endif /* MBEDTLS_DEBUG_C */
769
Gilles Peskine449bd832023-01-11 14:50:10 +0100770void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
771 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800772{
773 ((void) ciphersuite_info);
774
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100775#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800777 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800779#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100780#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800782 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800784#endif
785 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800787 return;
788 }
789}
790
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100791int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100792 unsigned hs_type,
793 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100794{
795 unsigned char hs_hdr[4];
796
797 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
799 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
800 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
801 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100804}
805
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100806int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100807 unsigned hs_type,
808 unsigned char const *msg,
809 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100810{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100811 int ret;
812 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100813 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100815 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100816 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817}
818
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100819int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800820{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100821#if defined(MBEDTLS_MD_CAN_SHA256) || \
822 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100823#if defined(MBEDTLS_USE_PSA_CRYPTO)
824 psa_status_t status;
825#else
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
827#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100828#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800829 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100830#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100831#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100833 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
834 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200835 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100836 }
837 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
838 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200839 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800841#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100842 mbedtls_md_free(&ssl->handshake->fin_sha256);
843 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100844 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
845 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
846 0);
847 if (ret != 0) {
848 return ret;
849 }
850 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 if (ret != 0) {
852 return ret;
853 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#endif
855#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100856#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
859 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200860 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100861 }
862 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
863 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200864 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100867 mbedtls_md_free(&ssl->handshake->fin_sha384);
868 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100869 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
870 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
871 if (ret != 0) {
872 return ret;
873 }
874 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100875 if (ret != 0) {
876 return ret;
877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100883static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100884 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800885{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100886#if defined(MBEDTLS_MD_CAN_SHA256) || \
887 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100888#if defined(MBEDTLS_USE_PSA_CRYPTO)
889 psa_status_t status;
890#else
891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
892#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100893#else /* SHA-256 or SHA-384 */
894 ((void) ssl);
895 (void) buf;
896 (void) len;
897#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
901 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200902 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100903 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800904#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100905 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100906 if (ret != 0) {
907 return ret;
908 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800909#endif
910#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100911#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800912#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100913 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
914 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200915 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100916 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800917#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100918 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100919 if (ret != 0) {
920 return ret;
921 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800922#endif
923#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100924 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800925}
926
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100927#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100928static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100929 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800930{
931#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200932 return mbedtls_md_error_from_psa(psa_hash_update(
933 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100935 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800936#endif
937}
938#endif
939
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100940#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100941static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100942 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800943{
944#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200945 return mbedtls_md_error_from_psa(psa_hash_update(
946 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100948 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800949#endif
950}
951#endif
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100957#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500958#if defined(MBEDTLS_USE_PSA_CRYPTO)
959 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500960#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100961 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200962#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500963#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100964#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500965#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500966 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500967#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100968 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200969#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200971
972 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200977#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200978 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200981#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200982#if defined(MBEDTLS_USE_PSA_CRYPTO)
983 handshake->psa_pake_ctx = psa_pake_operation_init();
984 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
985#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200987#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200988#if defined(MBEDTLS_SSL_CLI_C)
989 handshake->ecjpake_cache = NULL;
990 handshake->ecjpake_cache_len = 0;
991#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200992#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200993
Gilles Peskineeccd8882020-03-10 12:19:08 +0100994#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200996#endif
997
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200998#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
999 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1000#endif
Hanno Becker75173122019-02-06 16:18:31 +00001001
1002#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1003 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001005#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006}
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009{
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001011
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001012#if defined(MBEDTLS_USE_PSA_CRYPTO)
1013 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1014 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001015#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1017 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001018#endif
1019
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001020#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001021#if defined(MBEDTLS_USE_PSA_CRYPTO)
1022 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1023 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 mbedtls_md_init(&transform->md_ctx_enc);
1026 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001027#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001028#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029}
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032{
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034}
1035
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001038{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001039 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1040
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001042#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 if (ssl->transform_negotiate) {
1044 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1045 }
Jerry Yu2e199812022-12-01 18:57:19 +08001046#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 if (ssl->session_negotiate) {
1048 mbedtls_ssl_session_free(ssl->session_negotiate);
1049 }
1050 if (ssl->handshake) {
1051 mbedtls_ssl_handshake_free(ssl);
1052 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001055 /*
1056 * Either the pointers are now NULL or cleared properly and can be freed.
1057 * Now allocate missing structures.
1058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->transform_negotiate == NULL) {
1060 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001061 }
Jerry Yu2e199812022-12-01 18:57:19 +08001062#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (ssl->session_negotiate == NULL) {
1065 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001066 }
Paul Bakker48916f92012-09-16 19:57:18 +00001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 if (ssl->handshake == NULL) {
1069 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001070 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001071#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1072 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1075 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001076#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001077
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001078 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001080#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001081 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001082#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 ssl->session_negotiate == NULL) {
1084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001087 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001088
1089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001091 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001092#endif
1093
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001095 ssl->session_negotiate = NULL;
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001098 }
1099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_ssl_session_init(ssl->session_negotiate);
1102 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001103
Jerry Yu2e199812022-12-01 18:57:19 +08001104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001106#endif
1107
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001108 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001109 ret = mbedtls_ssl_reset_checksum(ssl);
1110 if (ret != 0) {
1111 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1112 return ret;
1113 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001114
Jerry Yud0766ec2022-09-22 10:46:57 +08001115#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1116 defined(MBEDTLS_SSL_SRV_C) && \
1117 defined(MBEDTLS_SSL_SESSION_TICKETS)
1118 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001120#endif
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001124 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001127 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001129 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001133 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001134#endif
1135
Brett Warrene0edc842021-08-17 09:53:13 +01001136/*
1137 * curve_list is translated to IANA TLS group identifiers here because
1138 * mbedtls_ssl_conf_curves returns void and so can't return
1139 * any error codes.
1140 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001141#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001142#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1143 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001145 size_t length;
1146 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1147
Thomas Daubney850a0792023-05-22 12:05:03 +01001148 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 }
Brett Warrene0edc842021-08-17 09:53:13 +01001150
1151 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1153 if (group_list == NULL) {
1154 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1155 }
Brett Warrene0edc842021-08-17 09:53:13 +01001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001158 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 curve_list[i]);
1160 if (tls_id == 0) {
1161 mbedtls_free(group_list);
1162 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001163 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001164 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001165 }
1166
1167 group_list[length] = 0;
1168
1169 ssl->handshake->group_list = group_list;
1170 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001172 ssl->handshake->group_list = ssl->conf->group_list;
1173 ssl->handshake->group_list_heap_allocated = 0;
1174 }
1175#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001176#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Ronald Crone68ab4f2022-10-05 12:46:29 +02001178#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001179#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001180#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001181 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1182 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1184 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001185 const int *md;
1186 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001187 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001188 uint16_t *p;
1189
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001190 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1191 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1192 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1195 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001197 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001198#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001200#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001201
Jerry Yub476a442022-01-21 18:14:45 +08001202#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001204#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1206 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1207 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001208 }
1209
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1211 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1212 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1215 sizeof(uint16_t));
1216 if (ssl->handshake->sig_algs == NULL) {
1217 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1218 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001219
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 p = (uint16_t *) ssl->handshake->sig_algs;
1221 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1222 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1223 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001224 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001226#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001229#endif
1230#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001232 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001233#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001234 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001235 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001236 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001238#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001239 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 ssl->handshake->sig_algs_heap_allocated = 0;
1241 }
Jerry Yucc539102022-06-27 16:27:35 +08001242#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001243#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001245}
1246
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001247#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001248/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001249MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001250static int ssl_cookie_write_dummy(void *ctx,
1251 unsigned char **p, unsigned char *end,
1252 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001253{
1254 ((void) ctx);
1255 ((void) p);
1256 ((void) end);
1257 ((void) cli_id);
1258 ((void) cli_id_len);
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001261}
1262
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001263MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001264static int ssl_cookie_check_dummy(void *ctx,
1265 const unsigned char *cookie, size_t cookie_len,
1266 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001267{
1268 ((void) ctx);
1269 ((void) cookie);
1270 ((void) cookie_len);
1271 ((void) cli_id);
1272 ((void) cli_id_len);
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001276#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001277
Paul Bakker5121ce52009-01-03 21:22:43 +00001278/*
1279 * Initialize an SSL context
1280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001281void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001282{
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001284}
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001288{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001289 const mbedtls_ssl_config *conf = ssl->conf;
1290
Ronald Cron6f135e12021-12-08 16:57:54 +01001291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1293 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001296 }
1297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1299 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001300 }
1301#endif
1302
1303#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1305 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1306 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001307 }
1308#endif
1309
Ronald Cron6f135e12021-12-08 16:57:54 +01001310#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1312 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1313 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1314 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001315 }
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1318 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001319 }
1320#endif
1321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1323 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001324}
1325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001326MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001327static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1328{
1329 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 ret = ssl_conf_version_check(ssl);
1331 if (ret != 0) {
1332 return ret;
1333 }
Jerry Yu60835a82021-08-04 10:13:52 +08001334
Jerry Yudef7ae42022-10-30 14:13:19 +08001335#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1336 /* RFC 8446 section 4.4.3
1337 *
1338 * If the verification fails, the receiver MUST terminate the handshake with
1339 * a "decrypt_error" alert.
1340 *
1341 * If the client is configured as TLS 1.3 only with optional verify, return
1342 * bad config.
1343 *
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 if (mbedtls_ssl_conf_tls13_ephemeral_enabled(
1346 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001347 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1348 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1349 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001351 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 1, ("Optional verify auth mode "
1353 "is not available for TLS 1.3 client"));
1354 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001355 }
1356#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1357
Jerry Yu60835a82021-08-04 10:13:52 +08001358 /* Space for further checks */
1359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001361}
1362
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001363/*
1364 * Setup an SSL context
1365 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001366
Gilles Peskine449bd832023-01-11 14:50:10 +01001367int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1368 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001369{
Janos Follath865b3eb2019-12-16 11:46:15 +00001370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001371 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1372 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001374 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 if ((ret = ssl_conf_check(ssl)) != 0) {
1377 return ret;
1378 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001379 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001380
Paul Bakker62f2dee2012-09-28 07:31:51 +00001381 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001382 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001383 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001384
1385 /* Set to NULL in case of an error condition */
1386 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001387
Darryl Greenb33cc762019-11-28 14:29:44 +00001388#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1389 ssl->in_buf_len = in_buf_len;
1390#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1392 if (ssl->in_buf == NULL) {
1393 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001394 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001395 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001396 }
1397
Darryl Greenb33cc762019-11-28 14:29:44 +00001398#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1399 ssl->out_buf_len = out_buf_len;
1400#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1402 if (ssl->out_buf == NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001404 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001405 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001406 }
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001409
Johan Pascalb62bb512015-12-03 21:56:45 +01001410#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001412#endif
1413
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001415 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419
1420error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 mbedtls_free(ssl->in_buf);
1422 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424 ssl->conf = NULL;
1425
Darryl Greenb33cc762019-11-28 14:29:44 +00001426#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1427 ssl->in_buf_len = 0;
1428 ssl->out_buf_len = 0;
1429#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001430 ssl->in_buf = NULL;
1431 ssl->out_buf = NULL;
1432
1433 ssl->in_hdr = NULL;
1434 ssl->in_ctr = NULL;
1435 ssl->in_len = NULL;
1436 ssl->in_iv = NULL;
1437 ssl->in_msg = NULL;
1438
1439 ssl->out_hdr = NULL;
1440 ssl->out_ctr = NULL;
1441 ssl->out_len = NULL;
1442 ssl->out_iv = NULL;
1443 ssl->out_msg = NULL;
1444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001446}
1447
1448/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001449 * Reset an initialized and used SSL context for re-use while retaining
1450 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001451 *
1452 * If partial is non-zero, keep data in the input buffer and client ID.
1453 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1456 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457{
Darryl Greenb33cc762019-11-28 14:29:44 +00001458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1459 size_t in_buf_len = ssl->in_buf_len;
1460 size_t out_buf_len = ssl->out_buf_len;
1461#else
1462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1463 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1464#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001465
Hanno Beckerb0302c42021-08-03 09:39:42 +01001466#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1467 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001468#endif
1469
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001470 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001474
1475 /* Reset incoming message parsing */
1476 ssl->in_offt = NULL;
1477 ssl->nb_zero = 0;
1478 ssl->in_msgtype = 0;
1479 ssl->in_msglen = 0;
1480 ssl->in_hslen = 0;
1481 ssl->keep_current_message = 0;
1482 ssl->transform_in = NULL;
1483
1484#if defined(MBEDTLS_SSL_PROTO_DTLS)
1485 ssl->next_record_offset = 0;
1486 ssl->in_epoch = 0;
1487#endif
1488
1489 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001491 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493 }
1494
Ronald Cronad8c17b2022-06-10 17:18:09 +02001495 ssl->send_alert = 0;
1496
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 /* Reset outgoing message writing */
1498 ssl->out_msgtype = 0;
1499 ssl->out_msglen = 0;
1500 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 memset(ssl->out_buf, 0, out_buf_len);
1502 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001503 ssl->transform_out = NULL;
1504
1505#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507#endif
1508
XiaokangQian2b01dc32022-01-21 02:53:13 +00001509#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (ssl->transform) {
1511 mbedtls_ssl_transform_free(ssl->transform);
1512 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 ssl->transform = NULL;
1514 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1516
XiaokangQian2b01dc32022-01-21 02:53:13 +00001517#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 mbedtls_ssl_transform_free(ssl->transform_application);
1519 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520 ssl->transform_application = NULL;
1521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001523#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1525 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001526 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1530 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531 ssl->handshake->transform_handshake = NULL;
1532 }
1533
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538{
1539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1540
1541 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
1542
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001544
1545 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_RENEGOTIATION)
1547 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001549
1550 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1552 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001555
Hanno Beckerb0302c42021-08-03 09:39:42 +01001556 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001557 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 if (ssl->session) {
1559 mbedtls_ssl_session_free(ssl->session);
1560 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001561 ssl->session = NULL;
1562 }
1563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001565 ssl->alpn_chosen = NULL;
1566#endif
1567
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001568#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001569 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001570#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001572#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 if (free_cli_id) {
1574 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001575 ssl->cli_id = NULL;
1576 ssl->cli_id_len = 0;
1577 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001578#endif
1579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if ((ret = ssl_handshake_init(ssl)) != 0) {
1581 return ret;
1582 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001585}
1586
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001587/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001588 * Reset an initialized and used SSL context for re-use while retaining
1589 * all application-set variables, function pointers and data.
1590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592{
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001594}
1595
1596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 * SSL set accessors
1598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001600{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001601 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001602}
1603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001607}
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001610void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001611{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001612 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001613}
1614#endif
1615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001619}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1624 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001625{
1626 ssl->disable_datagram_packing = !allow_packing;
1627}
1628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1630 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001631{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001632 conf->hs_timeout_min = min;
1633 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001634}
1635#endif
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001638{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001639 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001640}
1641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001643void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1644 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1645 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001647 conf->f_vrfy = f_vrfy;
1648 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001649}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1653 int (*f_rng)(void *, unsigned char *, size_t),
1654 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001656 conf->f_rng = f_rng;
1657 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1661 void (*f_dbg)(void *, int, const char *, int, const char *),
1662 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_dbg = f_dbg;
1665 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001666}
1667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1669 void *p_bio,
1670 mbedtls_ssl_send_t *f_send,
1671 mbedtls_ssl_recv_t *f_recv,
1672 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001673{
1674 ssl->p_bio = p_bio;
1675 ssl->f_send = f_send;
1676 ssl->f_recv = f_recv;
1677 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001678}
1679
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682{
1683 ssl->mtu = mtu;
1684}
1685#endif
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001688{
1689 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690}
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1693 void *p_timer,
1694 mbedtls_ssl_set_timer_t *f_set_timer,
1695 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696{
1697 ssl->p_timer = p_timer;
1698 ssl->f_set_timer = f_set_timer;
1699 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001700
1701 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703}
1704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001706void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1707 void *p_cache,
1708 mbedtls_ssl_cache_get_t *f_get_cache,
1709 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001710{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001711 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001713 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001718int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001719{
Janos Follath865b3eb2019-12-16 11:46:15 +00001720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001723 session == NULL ||
1724 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (ssl->handshake->resume == 1) {
1730 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1731 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001732
Jerry Yu21092062022-10-10 21:21:31 +08001733#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu21092062022-10-10 21:21:31 +08001735 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001739 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1741 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1742 session->ciphersuite));
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001744 }
Jerry Yu40afab62022-10-08 10:42:13 +08001745 }
Jerry Yu21092062022-10-10 21:21:31 +08001746#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1749 session)) != 0) {
1750 return ret;
1751 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001752
Paul Bakker0a597072012-09-25 21:55:46 +00001753 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001756}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1760 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001761{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001762 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001763}
1764
Ronald Cron6f135e12021-12-08 16:57:54 +01001765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1767 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001768{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001769 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001770}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001771
1772#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001773void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1774 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001775{
1776 conf->early_data_enabled = early_data_enabled;
1777}
Jerry Yucc4e0072022-11-22 17:22:22 +08001778
1779#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001780void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001782{
Jerry Yu39da9852022-12-06 16:58:36 +08001783 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001784}
1785#endif /* MBEDTLS_SSL_SRV_C */
1786
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001787#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1792 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001793{
1794 conf->cert_profile = profile;
1795}
1796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001798{
1799 mbedtls_ssl_key_cert *cur = key_cert, *next;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001802 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001804 cur = next;
1805 }
1806}
1807
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001808/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1811 mbedtls_x509_crt *cert,
1812 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001813{
niisato8ee24222018-06-25 19:05:48 +09001814 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001819 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001821 }
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1824 if (new_cert == NULL) {
1825 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1826 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827
niisato8ee24222018-06-25 19:05:48 +09001828 new_cert->cert = cert;
1829 new_cert->key = key;
1830 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001831
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001834 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001836 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001838 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 }
niisato8ee24222018-06-25 19:05:48 +09001840 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841 }
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001844}
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001847 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849{
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001851}
1852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001854 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001856{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001857 conf->ca_chain = ca_chain;
1858 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001859
1860#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1861 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1862 * cannot be used together. */
1863 conf->f_ca_cb = NULL;
1864 conf->p_ca_cb = NULL;
1865#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001866}
Hanno Becker5adaad92019-03-27 16:54:37 +00001867
1868#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001869void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1871 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001872{
1873 conf->f_ca_cb = f_ca_cb;
1874 conf->p_ca_cb = p_ca_cb;
1875
1876 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1877 * cannot be used together. */
1878 conf->ca_chain = NULL;
1879 conf->ca_crl = NULL;
1880}
1881#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001883
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001884#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001885const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1886 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001887{
1888 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001890}
1891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1893 mbedtls_x509_crt *own_cert,
1894 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001895{
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1897 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1901 mbedtls_x509_crt *ca_chain,
1902 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001903{
1904 ssl->handshake->sni_ca_chain = ca_chain;
1905 ssl->handshake->sni_ca_crl = ca_crl;
1906}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001907
Glenn Strauss999ef702022-03-11 01:37:23 -05001908#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1910 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001911{
1912 ssl->handshake->dn_hints = crt;
1913}
1914#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1917 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001918{
1919 ssl->handshake->sni_authmode = authmode;
1920}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1922
Hanno Becker8927c832019-04-03 12:52:50 +01001923#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001924void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1926 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001927{
1928 ssl->f_vrfy = f_vrfy;
1929 ssl->p_vrfy = p_vrfy;
1930}
1931#endif
1932
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Valerio Setti016f6822022-12-09 14:17:50 +01001935#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001936static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1937static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1938
Valerio Setti016f6822022-12-09 14:17:50 +01001939static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 mbedtls_ssl_context *ssl,
1941 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001942{
1943 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001944 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001945 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001946 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001947 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001948 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1950 psa_pake_cs_set_primitive(&cipher_suite,
1951 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1952 PSA_ECC_FAMILY_SECP_R1,
1953 256));
1954 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1957 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001958 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001962 user = jpake_server_id;
1963 user_len = sizeof(jpake_server_id);
1964 peer = jpake_client_id;
1965 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001967 user = jpake_client_id;
1968 user_len = sizeof(jpake_client_id);
1969 peer = jpake_server_id;
1970 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001972
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001973 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1974 if (status != PSA_SUCCESS) {
1975 return status;
1976 }
1977
1978 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001980 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Valerio Setti016f6822022-12-09 14:17:50 +01001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1984 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001985 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 }
Valerio Setti016f6822022-12-09 14:17:50 +01001987
1988 ssl->handshake->psa_pake_ctx_is_ok = 1;
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1994 const unsigned char *pw,
1995 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001996{
1997 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1998 psa_status_t status;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if (ssl->handshake == NULL || ssl->conf == NULL) {
2001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002002 }
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 /* Empty password is not valid */
2005 if ((pw == NULL) || (pw_len == 0)) {
2006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2007 }
2008
2009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2010 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2011 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2012
2013 status = psa_import_key(&attributes, pw, pw_len,
2014 &ssl->handshake->psa_pake_password);
2015 if (status != PSA_SUCCESS) {
2016 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2017 }
2018
2019 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2020 ssl->handshake->psa_pake_password);
2021 if (status != PSA_SUCCESS) {
2022 psa_destroy_key(ssl->handshake->psa_pake_password);
2023 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2024 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2025 }
2026
2027 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002028}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2031 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002032{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002033 psa_status_t status;
2034
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (ssl->handshake == NULL || ssl->conf == NULL) {
2036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (mbedtls_svc_key_id_is_null(pwd)) {
2040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2041 }
2042
2043 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2044 if (status != PSA_SUCCESS) {
2045 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2046 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2047 }
2048
2049 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002050}
2051#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2053 const unsigned char *pw,
2054 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002055{
2056 mbedtls_ecjpake_role role;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ssl->handshake == NULL || ssl->conf == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002061
Valerio Settic689ed82022-12-07 14:40:38 +01002062 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if ((pw == NULL) || (pw_len == 0)) {
2064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2065 }
Valerio Settic689ed82022-12-07 14:40:38 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002070 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2074 role,
2075 MBEDTLS_MD_SHA256,
2076 MBEDTLS_ECP_DP_SECP256R1,
2077 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002078}
Valerio Setti02c25b52022-11-15 14:08:42 +01002079#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002080#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002083int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002084{
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (conf->psk_identity == NULL ||
2086 conf->psk_identity_len == 0) {
2087 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002088 }
2089
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002090#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2092 return 1;
2093 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002094#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (conf->psk != NULL && conf->psk_len != 0) {
2097 return 1;
2098 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101}
2102
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
2105 /* Remove reference to existing PSK, if any. */
2106#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108 /* The maintenance of the PSK key slot is the
2109 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002110 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002112#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002114 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115 conf->psk = NULL;
2116 conf->psk_len = 0;
2117 }
2118
2119 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (conf->psk_identity != NULL) {
2121 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 conf->psk_identity = NULL;
2123 conf->psk_identity_len = 0;
2124 }
2125}
2126
Hanno Becker7390c712018-11-15 13:33:04 +00002127/* This function assumes that PSK identity in the SSL config is unset.
2128 * It checks that the provided identity is well-formed and attempts
2129 * to make a copy of it in the SSL config.
2130 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002132static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2133 unsigned char const *psk_identity,
2134 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002135{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002136 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002138 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 (psk_identity_len >> 16) != 0 ||
2140 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002142 }
2143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2145 if (conf->psk_identity == NULL) {
2146 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2147 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002148
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002149 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002153}
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2156 const unsigned char *psk, size_t psk_len,
2157 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002158{
Janos Follath865b3eb2019-12-16 11:46:15 +00002159 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002160
2161 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2163 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2164 }
Hanno Becker7390c712018-11-15 13:33:04 +00002165
2166 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (psk == NULL) {
2168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2169 }
2170 if (psk_len == 0) {
2171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2172 }
2173 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2175 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2178 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2179 }
Hanno Becker7390c712018-11-15 13:33:04 +00002180 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002182
2183 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2185 if (ret != 0) {
2186 ssl_conf_remove_psk(conf);
2187 }
Hanno Becker7390c712018-11-15 13:33:04 +00002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002193{
2194#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002196 /* The maintenance of the external PSK key slot is the
2197 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (ssl->handshake->psk_opaque_is_internal) {
2199 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002200 ssl->handshake->psk_opaque_is_internal = 0;
2201 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002202 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002203 }
Neil Armstronge952a302022-05-03 10:22:14 +02002204#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002206 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002208 ssl->handshake->psk_len = 0;
2209 }
Neil Armstronge952a302022-05-03 10:22:14 +02002210#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002211}
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2214 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002215{
Neil Armstrong501c9322022-05-03 09:35:09 +02002216#if defined(MBEDTLS_USE_PSA_CRYPTO)
2217 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002219 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002220 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002221#endif /* MBEDTLS_USE_PSA_CRYPTO */
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 if (psk == NULL || ssl->handshake == NULL) {
2224 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2225 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2229 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002232
Neil Armstrong501c9322022-05-03 09:35:09 +02002233#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2236 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2237 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2238 } else {
2239 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2240 }
2241 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002242 }
2243#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002244
Jerry Yu568ec252022-07-22 21:27:34 +08002245#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2247 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2248 psa_set_key_usage_flags(&key_attributes,
2249 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002250 }
2251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 psa_set_key_algorithm(&key_attributes, alg);
2254 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2257 if (status != PSA_SUCCESS) {
2258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2259 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002260
2261 /* Allow calling psa_destroy_key() on psk remove */
2262 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002264#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
2269 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002273#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002274}
2275
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002276#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002277int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2278 mbedtls_svc_key_id_t psk,
2279 const unsigned char *psk_identity,
2280 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002281{
Janos Follath865b3eb2019-12-16 11:46:15 +00002282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002283
2284 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2286 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2287 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002288
Hanno Becker7390c712018-11-15 13:33:04 +00002289 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (mbedtls_svc_key_id_is_null(psk)) {
2291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2292 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002293 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002294
2295 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2297 psk_identity_len);
2298 if (ret != 0) {
2299 ssl_conf_remove_psk(conf);
2300 }
Hanno Becker7390c712018-11-15 13:33:04 +00002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303}
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2306 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002307{
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if ((mbedtls_svc_key_id_is_null(psk)) ||
2309 (ssl->handshake == NULL)) {
2310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2311 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002314 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002316}
2317#endif /* MBEDTLS_USE_PSA_CRYPTO */
2318
Jerry Yu8897c072022-08-12 13:56:53 +08002319#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002320void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2321 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2322 size_t),
2323 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002324{
2325 conf->f_psk = f_psk;
2326 conf->p_psk = p_psk;
2327}
Jerry Yu8897c072022-08-12 13:56:53 +08002328#endif /* MBEDTLS_SSL_SRV_C */
2329
Ronald Cron73fe8df2022-10-05 14:31:43 +02002330#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331
2332#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002333static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002335{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002336#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (alg == PSA_ALG_CBC_NO_PADDING) {
2338 return MBEDTLS_SSL_MODE_CBC;
2339 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002340#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (PSA_ALG_IS_AEAD(alg)) {
2342 return MBEDTLS_SSL_MODE_AEAD;
2343 }
2344 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002345}
2346
2347#else /* MBEDTLS_USE_PSA_CRYPTO */
2348
2349static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002351{
2352#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (mode == MBEDTLS_MODE_CBC) {
2354 return MBEDTLS_SSL_MODE_CBC;
2355 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002356#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2357
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002358#if defined(MBEDTLS_GCM_C) || \
2359 defined(MBEDTLS_CCM_C) || \
2360 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 mode == MBEDTLS_MODE_CHACHAPOLY) {
2364 return MBEDTLS_SSL_MODE_AEAD;
2365 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002366#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002369}
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002371
Gilles Peskinee108d982022-04-26 16:50:40 +02002372static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2373 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002375{
2376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2378 base_mode == MBEDTLS_SSL_MODE_CBC) {
2379 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002380 }
2381#else
2382 (void) encrypt_then_mac;
2383#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002385}
2386
Neil Armstrongab555e02022-04-04 11:07:59 +02002387mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002389{
Gilles Peskinee108d982022-04-26 16:50:40 +02002390 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002393#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002395#endif
2396 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002397
Gilles Peskinee108d982022-04-26 16:50:40 +02002398 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002399#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002400 encrypt_then_mac = transform->encrypt_then_mac;
2401#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403}
2404
Neil Armstrongab555e02022-04-04 11:07:59 +02002405mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002406#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002408#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002410{
Gilles Peskinee108d982022-04-26 16:50:40 +02002411 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2412
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002413#if defined(MBEDTLS_USE_PSA_CRYPTO)
2414 psa_status_t status;
2415 psa_algorithm_t alg;
2416 psa_key_type_t type;
2417 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002418 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2419 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (status == PSA_SUCCESS) {
2421 base_mode = mbedtls_ssl_get_base_mode(alg);
2422 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002423#else
2424 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002425 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 base_mode =
2428 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002430 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#endif /* MBEDTLS_USE_PSA_CRYPTO */
2432
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2434 int encrypt_then_mac = 0;
2435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437}
2438
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002439#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002440
2441#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu438ddd82022-07-07 06:55:50 +00002442/* Serialization of TLS 1.3 sessions:
2443 *
2444 * struct {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002445 * opaque hostname<0..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002446 * uint64 ticket_received;
2447 * uint32 ticket_lifetime;
Jerry Yu34191072022-08-18 10:32:09 +08002448 * opaque ticket<1..2^16-1>;
Jerry Yu438ddd82022-07-07 06:55:50 +00002449 * } ClientOnlyData;
2450 *
2451 * struct {
2452 * uint8 endpoint;
2453 * uint8 ciphersuite[2];
2454 * uint32 ticket_age_add;
2455 * uint8 ticket_flags;
2456 * opaque resumption_key<0..255>;
Jerry Yu02e3a072022-12-12 15:13:20 +08002457 * uint32 max_early_data_size;
Jerry Yu438ddd82022-07-07 06:55:50 +00002458 * select ( endpoint ) {
2459 * case client: ClientOnlyData;
Jerry Yu25ba4d42023-11-10 14:12:20 +08002460 * case server: uint64 ticket_creation_time_time;
Jerry Yu438ddd82022-07-07 06:55:50 +00002461 * };
2462 * } serialized_session_tls13;
2463 *
2464 */
2465#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yue36fdd62022-08-17 21:31:36 +08002466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002467static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2468 unsigned char *buf,
2469 size_t buf_len,
2470 size_t *olen)
Jerry Yu438ddd82022-07-07 06:55:50 +00002471{
2472 unsigned char *p = buf;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002473#if defined(MBEDTLS_SSL_CLI_C) && \
2474 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 size_t hostname_len = (session->hostname == NULL) ?
2476 0 : strlen(session->hostname) + 1;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002477#endif
Jerry Yubc7c1a42022-07-21 22:57:37 +08002478 size_t needed = 1 /* endpoint */
2479 + 2 /* ciphersuite */
2480 + 4 /* ticket_age_add */
Jerry Yu34191072022-08-18 10:32:09 +08002481 + 1 /* ticket_flags */
2482 + 1; /* resumption_key length */
Jerry Yue36fdd62022-08-17 21:31:36 +08002483 *olen = 0;
Jerry Yu34191072022-08-18 10:32:09 +08002484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
2486 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2487 }
Jerry Yu34191072022-08-18 10:32:09 +08002488 needed += session->resumption_key_len; /* resumption_key */
2489
Jerry Yu02e3a072022-12-12 15:13:20 +08002490#if defined(MBEDTLS_SSL_EARLY_DATA)
2491 needed += 4; /* max_early_data_size */
2492#endif
2493
Jerry Yu438ddd82022-07-07 06:55:50 +00002494#if defined(MBEDTLS_HAVE_TIME)
2495 needed += 8; /* start_time or ticket_received */
2496#endif
2497
2498#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +00002500#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00002501 needed += 2 /* hostname_len */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 + hostname_len; /* hostname */
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00002503#endif
2504
Jerry Yu438ddd82022-07-07 06:55:50 +00002505 needed += 4 /* ticket_lifetime */
Jerry Yue36fdd62022-08-17 21:31:36 +08002506 + 2; /* ticket_len */
Jerry Yu34191072022-08-18 10:32:09 +08002507
2508 /* Check size_t overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 if (session->ticket_len > SIZE_MAX - needed) {
2510 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2511 }
Jerry Yu34191072022-08-18 10:32:09 +08002512
Jerry Yue28d9742022-08-18 15:44:03 +08002513 needed += session->ticket_len; /* ticket */
Jerry Yu438ddd82022-07-07 06:55:50 +00002514 }
2515#endif /* MBEDTLS_SSL_CLI_C */
2516
Jerry Yue36fdd62022-08-17 21:31:36 +08002517 *olen = needed;
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 if (needed > buf_len) {
2519 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
2520 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002521
2522 p[0] = session->endpoint;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 1);
2524 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002525 p[7] = session->ticket_flags;
2526
2527 /* save resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002528 p[8] = session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002529 p += 9;
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 memcpy(p, session->resumption_key, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002531 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002532
Jerry Yu02e3a072022-12-12 15:13:20 +08002533#if defined(MBEDTLS_SSL_EARLY_DATA)
2534 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
2535 p += 4;
2536#endif
2537
Jerry Yu438ddd82022-07-07 06:55:50 +00002538#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu25ba4d42023-11-10 14:12:20 +08002540 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002541 p += 8;
2542 }
2543#endif /* MBEDTLS_HAVE_TIME */
2544
2545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002547#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002549 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (hostname_len > 0) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002551 /* save host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 memcpy(p, session->hostname, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002553 p += hostname_len;
2554 }
2555#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2556
Jerry Yu438ddd82022-07-07 06:55:50 +00002557#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_received, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002559 p += 8;
2560#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002562 p += 4;
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002565 p += 2;
Jerry Yu34191072022-08-18 10:32:09 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (session->ticket != NULL && session->ticket_len > 0) {
2568 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002569 p += session->ticket_len;
2570 }
2571 }
2572#endif /* MBEDTLS_SSL_CLI_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002574}
2575
2576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_session_load(mbedtls_ssl_session *session,
2578 const unsigned char *buf,
2579 size_t len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002580{
2581 const unsigned char *p = buf;
2582 const unsigned char *end = buf + len;
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (end - p < 9) {
2585 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2586 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002587 session->endpoint = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 1);
2589 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 3);
Jerry Yu438ddd82022-07-07 06:55:50 +00002590 session->ticket_flags = p[7];
2591
2592 /* load resumption_key */
Jerry Yubc7c1a42022-07-21 22:57:37 +08002593 session->resumption_key_len = p[8];
Jerry Yu438ddd82022-07-07 06:55:50 +00002594 p += 9;
2595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (end - p < session->resumption_key_len) {
2597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2598 }
Jerry Yu438ddd82022-07-07 06:55:50 +00002599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (sizeof(session->resumption_key) < session->resumption_key_len) {
2601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2602 }
2603 memcpy(session->resumption_key, p, session->resumption_key_len);
Jerry Yubc7c1a42022-07-21 22:57:37 +08002604 p += session->resumption_key_len;
Jerry Yu438ddd82022-07-07 06:55:50 +00002605
Jerry Yu02e3a072022-12-12 15:13:20 +08002606#if defined(MBEDTLS_SSL_EARLY_DATA)
2607 if (end - p < 4) {
2608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2609 }
2610 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
2611 p += 4;
2612#endif
2613
Jerry Yu438ddd82022-07-07 06:55:50 +00002614#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
2616 if (end - p < 8) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2618 }
Jerry Yu25ba4d42023-11-10 14:12:20 +08002619 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002620 p += 8;
2621 }
2622#endif /* MBEDTLS_HAVE_TIME */
2623
2624#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002626#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002628 size_t hostname_len;
2629 /* load host name */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (end - p < 2) {
2631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2632 }
2633 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002634 p += 2;
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (end - p < (long int) hostname_len) {
2637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2638 }
2639 if (hostname_len > 0) {
2640 session->hostname = mbedtls_calloc(1, hostname_len);
2641 if (session->hostname == NULL) {
2642 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2643 }
2644 memcpy(session->hostname, p, hostname_len);
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002645 p += hostname_len;
2646 }
2647#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION &&
2648 MBEDTLS_SSL_SESSION_TICKETS */
2649
Jerry Yu438ddd82022-07-07 06:55:50 +00002650#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (end - p < 8) {
2652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2653 }
2654 session->ticket_received = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002655 p += 8;
2656#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (end - p < 4) {
2658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2659 }
2660 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002661 p += 4;
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (end - p < 2) {
2664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2665 }
2666 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu438ddd82022-07-07 06:55:50 +00002667 p += 2;
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (end - p < (long int) session->ticket_len) {
2670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2671 }
2672 if (session->ticket_len > 0) {
2673 session->ticket = mbedtls_calloc(1, session->ticket_len);
2674 if (session->ticket == NULL) {
2675 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2676 }
2677 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00002678 p += session->ticket_len;
2679 }
2680 }
2681#endif /* MBEDTLS_SSL_CLI_C */
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return 0;
Jerry Yu438ddd82022-07-07 06:55:50 +00002684
2685}
2686#else /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yue36fdd62022-08-17 21:31:36 +08002687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002688static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
2689 unsigned char *buf,
2690 size_t buf_len,
2691 size_t *olen)
Jerry Yu251a12e2022-07-13 15:15:48 +08002692{
2693 ((void) session);
2694 ((void) buf);
2695 ((void) buf_len);
Jerry Yue36fdd62022-08-17 21:31:36 +08002696 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu251a12e2022-07-13 15:15:48 +08002698}
Jerry Yu438ddd82022-07-07 06:55:50 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
2701 unsigned char *buf,
2702 size_t buf_len)
Jerry Yu438ddd82022-07-07 06:55:50 +00002703{
2704 ((void) session);
2705 ((void) buf);
2706 ((void) buf_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Jerry Yu438ddd82022-07-07 06:55:50 +00002708}
2709#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu251a12e2022-07-13 15:15:48 +08002710#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2713 size_t taglen,
2714 psa_algorithm_t *alg,
2715 psa_key_type_t *key_type,
2716 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002717{
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 switch (mbedtls_cipher_type) {
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002719 case MBEDTLS_CIPHER_AES_128_CBC:
2720 *alg = PSA_ALG_CBC_NO_PADDING;
2721 *key_type = PSA_KEY_TYPE_AES;
2722 *key_size = 128;
2723 break;
2724 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002726 *key_type = PSA_KEY_TYPE_AES;
2727 *key_size = 128;
2728 break;
2729 case MBEDTLS_CIPHER_AES_128_GCM:
2730 *alg = PSA_ALG_GCM;
2731 *key_type = PSA_KEY_TYPE_AES;
2732 *key_size = 128;
2733 break;
2734 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002736 *key_type = PSA_KEY_TYPE_AES;
2737 *key_size = 192;
2738 break;
2739 case MBEDTLS_CIPHER_AES_192_GCM:
2740 *alg = PSA_ALG_GCM;
2741 *key_type = PSA_KEY_TYPE_AES;
2742 *key_size = 192;
2743 break;
2744 case MBEDTLS_CIPHER_AES_256_CBC:
2745 *alg = PSA_ALG_CBC_NO_PADDING;
2746 *key_type = PSA_KEY_TYPE_AES;
2747 *key_size = 256;
2748 break;
2749 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002751 *key_type = PSA_KEY_TYPE_AES;
2752 *key_size = 256;
2753 break;
2754 case MBEDTLS_CIPHER_AES_256_GCM:
2755 *alg = PSA_ALG_GCM;
2756 *key_type = PSA_KEY_TYPE_AES;
2757 *key_size = 256;
2758 break;
2759 case MBEDTLS_CIPHER_ARIA_128_CBC:
2760 *alg = PSA_ALG_CBC_NO_PADDING;
2761 *key_type = PSA_KEY_TYPE_ARIA;
2762 *key_size = 128;
2763 break;
2764 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002766 *key_type = PSA_KEY_TYPE_ARIA;
2767 *key_size = 128;
2768 break;
2769 case MBEDTLS_CIPHER_ARIA_128_GCM:
2770 *alg = PSA_ALG_GCM;
2771 *key_type = PSA_KEY_TYPE_ARIA;
2772 *key_size = 128;
2773 break;
2774 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002776 *key_type = PSA_KEY_TYPE_ARIA;
2777 *key_size = 192;
2778 break;
2779 case MBEDTLS_CIPHER_ARIA_192_GCM:
2780 *alg = PSA_ALG_GCM;
2781 *key_type = PSA_KEY_TYPE_ARIA;
2782 *key_size = 192;
2783 break;
2784 case MBEDTLS_CIPHER_ARIA_256_CBC:
2785 *alg = PSA_ALG_CBC_NO_PADDING;
2786 *key_type = PSA_KEY_TYPE_ARIA;
2787 *key_size = 256;
2788 break;
2789 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002791 *key_type = PSA_KEY_TYPE_ARIA;
2792 *key_size = 256;
2793 break;
2794 case MBEDTLS_CIPHER_ARIA_256_GCM:
2795 *alg = PSA_ALG_GCM;
2796 *key_type = PSA_KEY_TYPE_ARIA;
2797 *key_size = 256;
2798 break;
2799 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2800 *alg = PSA_ALG_CBC_NO_PADDING;
2801 *key_type = PSA_KEY_TYPE_CAMELLIA;
2802 *key_size = 128;
2803 break;
2804 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002806 *key_type = PSA_KEY_TYPE_CAMELLIA;
2807 *key_size = 128;
2808 break;
2809 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2810 *alg = PSA_ALG_GCM;
2811 *key_type = PSA_KEY_TYPE_CAMELLIA;
2812 *key_size = 128;
2813 break;
2814 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002816 *key_type = PSA_KEY_TYPE_CAMELLIA;
2817 *key_size = 192;
2818 break;
2819 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2820 *alg = PSA_ALG_GCM;
2821 *key_type = PSA_KEY_TYPE_CAMELLIA;
2822 *key_size = 192;
2823 break;
2824 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2825 *alg = PSA_ALG_CBC_NO_PADDING;
2826 *key_type = PSA_KEY_TYPE_CAMELLIA;
2827 *key_size = 256;
2828 break;
2829 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002831 *key_type = PSA_KEY_TYPE_CAMELLIA;
2832 *key_size = 256;
2833 break;
2834 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2835 *alg = PSA_ALG_GCM;
2836 *key_type = PSA_KEY_TYPE_CAMELLIA;
2837 *key_size = 256;
2838 break;
2839 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2840 *alg = PSA_ALG_CHACHA20_POLY1305;
2841 *key_type = PSA_KEY_TYPE_CHACHA20;
2842 *key_size = 256;
2843 break;
2844 case MBEDTLS_CIPHER_NULL:
2845 *alg = MBEDTLS_SSL_NULL_CIPHER;
2846 *key_type = 0;
2847 *key_size = 0;
2848 break;
2849 default:
2850 return PSA_ERROR_NOT_SUPPORTED;
2851 }
2852
2853 return PSA_SUCCESS;
2854}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002855#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002856
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002857#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002858int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2859 const unsigned char *dhm_P, size_t P_len,
2860 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002861{
Janos Follath865b3eb2019-12-16 11:46:15 +00002862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 mbedtls_mpi_free(&conf->dhm_P);
2865 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2868 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2869 mbedtls_mpi_free(&conf->dhm_P);
2870 mbedtls_mpi_free(&conf->dhm_G);
2871 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002872 }
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002875}
Paul Bakker5121ce52009-01-03 21:22:43 +00002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002878{
Janos Follath865b3eb2019-12-16 11:46:15 +00002879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 mbedtls_mpi_free(&conf->dhm_P);
2882 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2885 &conf->dhm_P)) != 0 ||
2886 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2887 &conf->dhm_G)) != 0) {
2888 mbedtls_mpi_free(&conf->dhm_P);
2889 mbedtls_mpi_free(&conf->dhm_G);
2890 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002891 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002894}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002895#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002896
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002897#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2898/*
2899 * Set the minimum length for Diffie-Hellman parameters
2900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2902 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002903{
2904 conf->dhm_min_bitlen = bitlen;
2905}
2906#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2907
Ronald Crone68ab4f2022-10-05 12:46:29 +02002908#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002909#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002910/*
2911 * Set allowed/preferred hashes for handshake signatures
2912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2914 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002915{
2916 conf->sig_hashes = hashes;
2917}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002918#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002919
Jerry Yuf017ee42022-01-12 15:49:48 +08002920/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002921void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2922 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002923{
Jerry Yuf017ee42022-01-12 15:49:48 +08002924#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2925 conf->sig_hashes = NULL;
2926#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2927 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002928}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002929#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002930
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002931#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002932#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002933/*
2934 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002935 *
2936 * mbedtls_ssl_setup() takes the provided list
2937 * and translates it to a list of IANA TLS group identifiers,
2938 * stored in ssl->handshake->group_list.
2939 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002941void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2942 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002943{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002944 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002945 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002946}
Brett Warrene0edc842021-08-17 09:53:13 +01002947#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002948#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002949
Brett Warrene0edc842021-08-17 09:53:13 +01002950/*
2951 * Set the allowed groups
2952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002953void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2954 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002955{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002956#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002957 conf->curve_list = NULL;
2958#endif
2959 conf->group_list = group_list;
2960}
2961
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002962#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002963int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002964{
Hanno Becker947194e2017-04-07 13:25:49 +01002965 /* Initialize to suppress unnecessary compiler warning */
2966 size_t hostname_len = 0;
2967
2968 /* Check if new hostname is valid before
2969 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 if (hostname != NULL) {
2971 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2974 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2975 }
Hanno Becker947194e2017-04-07 13:25:49 +01002976 }
2977
2978 /* Now it's clear that we will overwrite the old hostname,
2979 * so we can free it safely */
2980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002982 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002983 }
2984
2985 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002988 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 } else {
2990 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2991 if (ssl->hostname == NULL) {
2992 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2993 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002996
Hanno Becker947194e2017-04-07 13:25:49 +01002997 ssl->hostname[hostname_len] = '\0';
2998 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003001}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003002#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003003
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003004#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003005void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3006 int (*f_sni)(void *, mbedtls_ssl_context *,
3007 const unsigned char *, size_t),
3008 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003009{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003010 conf->f_sni = f_sni;
3011 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00003012}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01003016int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003017{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003018 size_t cur_len, tot_len;
3019 const char **p;
3020
3021 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08003022 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
3023 * MUST NOT be truncated."
3024 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003025 */
3026 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 for (p = protos; *p != NULL; p++) {
3028 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003029 tot_len += cur_len;
3030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if ((cur_len == 0) ||
3032 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
3033 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
3034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3035 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003036 }
3037
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003038 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003041}
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003044{
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003046}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003048
Johan Pascalb62bb512015-12-03 21:56:45 +01003049#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01003050void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3051 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02003052{
3053 conf->dtls_srtp_mki_support = support_mki_value;
3054}
3055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3057 unsigned char *mki_value,
3058 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02003059{
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
3061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02003062 }
Ron Eldor591f1622018-01-22 12:30:04 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
3065 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02003066 }
Ron Eldor591f1622018-01-22 12:30:04 +02003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02003069 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02003071}
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
3074 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01003075{
Johan Pascal253d0262020-09-22 13:04:45 +02003076 const mbedtls_ssl_srtp_profile *p;
3077 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003078
Johan Pascal253d0262020-09-22 13:04:45 +02003079 /* check the profiles list: all entry must be valid,
3080 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
3082 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
3083 p++) {
3084 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003085 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003087 /* unsupported value, stop parsing and set the size to an error value */
3088 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01003089 }
3090 }
3091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
3093 conf->dtls_srtp_profile_list = NULL;
3094 conf->dtls_srtp_profile_list_len = 0;
3095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02003096 }
3097
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003098 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02003099 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01003100
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01003102}
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3105 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01003106{
Johan Pascal2258a4f2020-10-28 13:53:09 +01003107 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
3108 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003110 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01003112 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
3114 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01003115 }
Johan Pascalb62bb512015-12-03 21:56:45 +01003116}
Johan Pascalb62bb512015-12-03 21:56:45 +01003117#endif /* MBEDTLS_SSL_DTLS_SRTP */
3118
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303119#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01003120void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00003121{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003122 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003123}
3124
Gilles Peskine449bd832023-01-11 14:50:10 +01003125void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003126{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003127 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003128}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05303129#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003130
Janos Follath088ce432017-04-10 12:42:31 +01003131#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003132void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3133 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01003134{
3135 conf->cert_req_ca_list = cert_req_ca_list;
3136}
3137#endif
3138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01003140void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003141{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003142 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003143}
3144#endif
3145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01003147void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003148{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003149 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003150}
3151#endif
3152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003154int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003155{
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3157 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3158 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003159 }
3160
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003161 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003162
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003164}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003168{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003169 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003170}
3171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003173void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003174{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003175 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003176}
3177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003179{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003180 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003181}
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3184 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003185{
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003187}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003191#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003192void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003193{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003194 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003195}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003196#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003197
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003198#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003199
Jerry Yud0766ec2022-09-22 10:46:57 +08003200#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003201void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3202 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003203{
Jerry Yud0766ec2022-09-22 10:46:57 +08003204 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003205}
3206#endif
3207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3209 mbedtls_ssl_ticket_write_t *f_ticket_write,
3210 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3211 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003212{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003213 conf->f_ticket_write = f_ticket_write;
3214 conf->f_ticket_parse = f_ticket_parse;
3215 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003216}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003217#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3221 mbedtls_ssl_export_keys_t *f_export_keys,
3222 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003223{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003224 ssl->f_export_keys = f_export_keys;
3225 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003226}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003227
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003228#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003229void mbedtls_ssl_conf_async_private_cb(
3230 mbedtls_ssl_config *conf,
3231 mbedtls_ssl_async_sign_t *f_async_sign,
3232 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3233 mbedtls_ssl_async_resume_t *f_async_resume,
3234 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003236{
3237 conf->f_async_sign_start = f_async_sign;
3238 conf->f_async_decrypt_start = f_async_decrypt;
3239 conf->f_async_resume = f_async_resume;
3240 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003241 conf->p_async_config_data = async_config_data;
3242}
3243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003245{
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003247}
3248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003250{
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (ssl->handshake == NULL) {
3252 return NULL;
3253 } else {
3254 return ssl->handshake->user_async_ctx;
3255 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003256}
3257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3259 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003260{
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003262 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003264}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003265#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003266
Paul Bakker5121ce52009-01-03 21:22:43 +00003267/*
3268 * SSL get accessors
3269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003270uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003271{
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (ssl->session != NULL) {
3273 return ssl->session->verify_result;
3274 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (ssl->session_negotiate != NULL) {
3277 return ssl->session_negotiate->verify_result;
3278 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003279
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003281}
3282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003284{
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 if (ssl == NULL || ssl->session == NULL) {
3286 return 0;
3287 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003290}
3291
Gilles Peskine449bd832023-01-11 14:50:10 +01003292const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003293{
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (ssl == NULL || ssl->session == NULL) {
3295 return NULL;
3296 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003299}
3300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003302{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003304 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3305 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003306 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003308 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003310 }
3311 }
3312#endif
3313
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003315 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003317 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003319 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003321 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003322}
3323
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003324#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003325size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003326{
David Horstmann95d516f2021-05-04 18:36:56 +01003327 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003328 size_t read_mfl;
3329
Jerry Yuddda0502022-12-01 19:43:12 +08003330#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003331 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003332 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3333 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3334 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003335 }
Jerry Yuddda0502022-12-01 19:43:12 +08003336#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003337
3338 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (ssl->session_out != NULL) {
3340 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3341 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003342 max_len = read_mfl;
3343 }
3344 }
3345
Jerry Yuddda0502022-12-01 19:43:12 +08003346 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 if (ssl->session_negotiate != NULL) {
3348 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3349 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003350 max_len = read_mfl;
3351 }
3352 }
3353
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003355}
3356
Gilles Peskine449bd832023-01-11 14:50:10 +01003357size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003358{
3359 size_t max_len;
3360
3361 /*
3362 * Assume mfl_code is correct since it was checked when set
3363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003365
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003366 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 if (ssl->session_out != NULL &&
3368 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3369 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003370 }
3371
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003372 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 if (ssl->session_negotiate != NULL &&
3374 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3375 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003376 }
3377
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003379}
3380#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3381
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003382#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003383size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003384{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003385 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003386 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3387 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3388 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3389 return 0;
3390 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3393 return ssl->mtu;
3394 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003395
Gilles Peskine449bd832023-01-11 14:50:10 +01003396 if (ssl->mtu == 0) {
3397 return ssl->handshake->mtu;
3398 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 return ssl->mtu < ssl->handshake->mtu ?
3401 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003402}
3403#endif /* MBEDTLS_SSL_PROTO_DTLS */
3404
Gilles Peskine449bd832023-01-11 14:50:10 +01003405int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003406{
3407 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3408
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003409#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3410 !defined(MBEDTLS_SSL_PROTO_DTLS)
3411 (void) ssl;
3412#endif
3413
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003414#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003416
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003418 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003420#endif
3421
3422#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3424 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3425 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003426 const size_t overhead = (size_t) ret;
3427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 if (ret < 0) {
3429 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003430 }
3431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 if (mtu <= overhead) {
3433 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3434 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3435 }
3436
3437 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003438 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003439 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003440 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003441#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003442
Hanno Becker0defedb2018-08-10 12:35:02 +01003443#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
3444 !defined(MBEDTLS_SSL_PROTO_DTLS)
3445 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003446#endif
3447
Gilles Peskine449bd832023-01-11 14:50:10 +01003448 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003449}
3450
Gilles Peskine449bd832023-01-11 14:50:10 +01003451int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003452{
3453 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3454
3455#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3456 (void) ssl;
3457#endif
3458
3459#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003463 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003464 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003465#endif
3466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003468}
3469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003471const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003472{
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 if (ssl == NULL || ssl->session == NULL) {
3474 return NULL;
3475 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003476
Hanno Beckere6824572019-02-07 13:18:46 +00003477#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003479#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003481#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003482}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003486int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3487 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003488{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003489 int ret;
3490
Gilles Peskine449bd832023-01-11 14:50:10 +01003491 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003492 dst == NULL ||
3493 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003496 }
3497
Hanno Beckere810bbc2021-05-14 16:01:05 +01003498 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3499 * idempotent: Each session can only be exported once.
3500 *
3501 * (This is in preparation for TLS 1.3 support where we will
3502 * need the ability to export multiple sessions (aka tickets),
3503 * which will be achieved by calling mbedtls_ssl_get_session()
3504 * multiple times until it fails.)
3505 *
3506 * Check whether we have already exported the current session,
3507 * and fail if so.
3508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 if (ssl->session->exported == 1) {
3510 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3511 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003512
Gilles Peskine449bd832023-01-11 14:50:10 +01003513 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3514 if (ret != 0) {
3515 return ret;
3516 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003517
3518 /* Remember that we've exported the session. */
3519 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003521}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003523
Paul Bakker5121ce52009-01-03 21:22:43 +00003524/*
Hanno Beckera835da52019-05-16 12:39:07 +01003525 * Define ticket header determining Mbed TLS version
3526 * and structure of the ticket.
3527 */
3528
Hanno Becker94ef3b32019-05-16 12:50:45 +01003529/*
Hanno Becker50b59662019-05-28 14:30:45 +01003530 * Define bitflag determining compile-time settings influencing
3531 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003532 */
3533
Hanno Becker50b59662019-05-28 14:30:45 +01003534#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003535#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003536#else
Hanno Becker3e088662019-05-29 11:10:18 +01003537#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003538#endif /* MBEDTLS_HAVE_TIME */
3539
3540#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003541#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003542#else
Hanno Becker3e088662019-05-29 11:10:18 +01003543#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003544#endif /* MBEDTLS_X509_CRT_PARSE_C */
3545
3546#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003547#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003548#else
Hanno Becker3e088662019-05-29 11:10:18 +01003549#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003550#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3551
3552#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003553#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003554#else
Hanno Becker3e088662019-05-29 11:10:18 +01003555#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003556#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3557
Hanno Becker94ef3b32019-05-16 12:50:45 +01003558#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003559#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003560#else
Hanno Becker3e088662019-05-29 11:10:18 +01003561#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003562#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3563
Hanno Becker94ef3b32019-05-16 12:50:45 +01003564#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3565#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3566#else
3567#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3568#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3569
Hanno Becker3e088662019-05-29 11:10:18 +01003570#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3571#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3572#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3573#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003574#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3575#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
Hanno Becker3e088662019-05-29 11:10:18 +01003576
Hanno Becker50b59662019-05-28 14:30:45 +01003577#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003578 ((uint16_t) ( \
3579 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3580 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3581 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3582 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3583 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3584 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
3585 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003586
Hanno Beckerf8787072019-05-16 12:41:07 +01003587static unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003588 MBEDTLS_VERSION_MAJOR,
3589 MBEDTLS_VERSION_MINOR,
3590 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3592 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003593};
Hanno Beckera835da52019-05-16 12:39:07 +01003594
3595/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003596 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003597 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003598 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003599 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003600 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003601 * opaque mbedtls_version[3]; // library version: major, minor, patch
3602 * opaque session_format[2]; // library-version specific 16-bit field
3603 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003604 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003605 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003606 * Note: When updating the format, remember to keep
3607 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003608 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003609 * // In this version, `session_format` determines
3610 * // the setting of those compile-time
3611 * // configuration options which influence
3612 * // the structure of mbedtls_ssl_session.
3613 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003614 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003615 * // - TLS 1.2 (0x0303)
3616 * // - TLS 1.3 (0x0304)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003617 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003618 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003619 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003620 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003621 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003622 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003623 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003624 *
3625 * };
3626 *
3627 * } serialized_session;
3628 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003629 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003630
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003632static int ssl_session_save(const mbedtls_ssl_session *session,
3633 unsigned char omit_header,
3634 unsigned char *buf,
3635 size_t buf_len,
3636 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003637{
3638 unsigned char *p = buf;
3639 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003640 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003641#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3642 size_t out_len;
3643 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3644#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003645 if (session == NULL) {
3646 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3647 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003650 /*
3651 * Add Mbed TLS version identifier
3652 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003654
Gilles Peskine449bd832023-01-11 14:50:10 +01003655 if (used <= buf_len) {
3656 memcpy(p, ssl_serialized_session_header,
3657 sizeof(ssl_serialized_session_header));
3658 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003659 }
3660 }
3661
3662 /*
3663 * TLS version identifier
3664 */
3665 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 if (used <= buf_len) {
3667 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003668 }
3669
3670 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003671 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003672 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 case MBEDTLS_SSL_VERSION_TLS1_2:
3675 used += ssl_tls12_session_save(session, p, remaining_len);
3676 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003677#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3678
Jerry Yu251a12e2022-07-13 15:15:48 +08003679#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003680 case MBEDTLS_SSL_VERSION_TLS1_3:
3681 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3682 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3683 return ret;
3684 }
3685 used += out_len;
3686 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003687#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3688
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 default:
3690 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003691 }
3692
3693 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 if (used > buf_len) {
3695 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3696 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003697
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003699}
3700
3701/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003702 * Public wrapper for ssl_session_save()
3703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003704int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3705 unsigned char *buf,
3706 size_t buf_len,
3707 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003708{
Gilles Peskine449bd832023-01-11 14:50:10 +01003709 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003710}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003711
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003712/*
3713 * Deserialize session, see mbedtls_ssl_session_save() for format.
3714 *
3715 * This internal version is wrapped by a public function that cleans up in
3716 * case of error, and has an extra option omit_header.
3717 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003719static int ssl_session_load(mbedtls_ssl_session *session,
3720 unsigned char omit_header,
3721 const unsigned char *buf,
3722 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003723{
3724 const unsigned char *p = buf;
3725 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00003726 size_t remaining_len;
3727
3728
Gilles Peskine449bd832023-01-11 14:50:10 +01003729 if (session == NULL) {
3730 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3731 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003732
Gilles Peskine449bd832023-01-11 14:50:10 +01003733 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003734 /*
3735 * Check Mbed TLS version identifier
3736 */
3737
Gilles Peskine449bd832023-01-11 14:50:10 +01003738 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
3739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003741
3742 if (memcmp(p, ssl_serialized_session_header,
3743 sizeof(ssl_serialized_session_header)) != 0) {
3744 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
3745 }
3746 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003747 }
3748
3749 /*
3750 * TLS version identifier
3751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 if (1 > (size_t) (end - p)) {
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3754 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003755 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003756
3757 /* Dispatch according to TLS version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 remaining_len = (end - p);
3759 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003760#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003761 case MBEDTLS_SSL_VERSION_TLS1_2:
3762 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003763#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3764
Jerry Yu438ddd82022-07-07 06:55:50 +00003765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 case MBEDTLS_SSL_VERSION_TLS1_3:
3767 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00003768#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3769
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 default:
3771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003772 }
3773}
3774
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003775/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02003776 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003777 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003778int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3779 const unsigned char *buf,
3780 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003781{
Gilles Peskine449bd832023-01-11 14:50:10 +01003782 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003783
Gilles Peskine449bd832023-01-11 14:50:10 +01003784 if (ret != 0) {
3785 mbedtls_ssl_session_free(session);
3786 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003787
Gilles Peskine449bd832023-01-11 14:50:10 +01003788 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02003789}
3790
3791/*
Paul Bakker1961b702013-01-25 14:49:24 +01003792 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00003793 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003794MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003795static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01003796{
3797 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3798
Ronald Cron66dbf912022-02-02 15:33:46 +01003799 /*
3800 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01003801 * that were written into the output buffer by the previous handshake step,
3802 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01003803 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
3804 * We proceed to the next handshake step only when all data from the
3805 * previous one have been sent to the peer, thus we make sure that this is
3806 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
3807 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
3808 * we have to wait before to go ahead.
3809 * In the case of TLS 1.3, handshake step handlers do not send data to the
3810 * peer. Data are only sent here and through
3811 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003812 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01003813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003814 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3815 return ret;
3816 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003817
3818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3820 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
3821 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
3822 return ret;
3823 }
Hanno Becker41934dd2021-08-07 19:13:43 +01003824 }
3825#endif /* MBEDTLS_SSL_PROTO_DTLS */
3826
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01003828}
3829
Gilles Peskine449bd832023-01-11 14:50:10 +01003830int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003831{
Hanno Becker41934dd2021-08-07 19:13:43 +01003832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00003833
Gilles Peskine449bd832023-01-11 14:50:10 +01003834 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01003835 ssl->conf == NULL ||
3836 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
3838 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01003839 }
3840
Gilles Peskine449bd832023-01-11 14:50:10 +01003841 ret = ssl_prepare_handshake_step(ssl);
3842 if (ret != 0) {
3843 return ret;
3844 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003845
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 ret = mbedtls_ssl_handle_pending_alert(ssl);
3847 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08003848 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 }
Jerry Yue7047812021-09-13 19:26:39 +08003850
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01003851 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
3852 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
3853 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003856 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3857 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003858 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08003859
Gilles Peskine449bd832023-01-11 14:50:10 +01003860 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01003861 case MBEDTLS_SSL_HELLO_REQUEST:
3862 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01003863 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01003864 break;
Jerry Yub9930e72021-08-06 17:11:51 +08003865
Ronald Cron9f0fba32022-02-10 16:45:15 +01003866 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003867 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003868 break;
3869
3870 default:
3871#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003872 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3873 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
3874 } else {
3875 ret = mbedtls_ssl_handshake_client_step(ssl);
3876 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01003877#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003878 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003879#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01003881#endif
3882 }
Jerry Yub9930e72021-08-06 17:11:51 +08003883 }
Ronald Cron6291b232023-03-08 15:51:25 +01003884#endif /* MBEDTLS_SSL_CLI_C */
3885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003887 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01003888#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
3889 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01003891 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01003892 ret = mbedtls_ssl_handshake_server_step(ssl);
3893 }
Ronald Cron6291b232023-03-08 15:51:25 +01003894#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
3895 ret = mbedtls_ssl_handshake_server_step(ssl);
3896#else
3897 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003898#endif
Ronald Cron6291b232023-03-08 15:51:25 +01003899 }
3900#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003901
Gilles Peskine449bd832023-01-11 14:50:10 +01003902 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08003903 /* handshake_step return error. And it is same
3904 * with alert_reason.
3905 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003906 if (ssl->send_alert) {
3907 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08003908 goto cleanup;
3909 }
3910 }
3911
3912cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01003913 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01003914}
3915
3916/*
3917 * Perform the SSL handshake
3918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003919int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01003920{
3921 int ret = 0;
3922
Hanno Beckera817ea42020-10-20 15:20:23 +01003923 /* Sanity checks */
3924
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 if (ssl == NULL || ssl->conf == NULL) {
3926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3927 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02003928
Hanno Beckera817ea42020-10-20 15:20:23 +01003929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003930 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3931 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
3932 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
3933 "mbedtls_ssl_set_timer_cb() for DTLS"));
3934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01003935 }
3936#endif /* MBEDTLS_SSL_PROTO_DTLS */
3937
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01003939
Hanno Beckera817ea42020-10-20 15:20:23 +01003940 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
3942 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01003943
Gilles Peskine449bd832023-01-11 14:50:10 +01003944 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01003945 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 }
Paul Bakker1961b702013-01-25 14:49:24 +01003947 }
3948
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003950
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003952}
3953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003954#if defined(MBEDTLS_SSL_RENEGOTIATION)
3955#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003956/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003957 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00003958 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003960static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003961{
Janos Follath865b3eb2019-12-16 11:46:15 +00003962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003965
3966 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003967 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3968 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003969
Gilles Peskine449bd832023-01-11 14:50:10 +01003970 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
3971 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
3972 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003973 }
3974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003978}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003979#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003980
3981/*
3982 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003983 * - any side: calling mbedtls_ssl_renegotiate(),
3984 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
3985 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02003986 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003987 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003988 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01003989 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003990int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00003991{
Janos Follath865b3eb2019-12-16 11:46:15 +00003992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00003995
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if ((ret = ssl_handshake_init(ssl)) != 0) {
3997 return ret;
3998 }
Paul Bakker48916f92012-09-16 19:57:18 +00003999
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004000 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4001 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4004 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4005 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004006 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004007 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004008 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004010 }
4011#endif
4012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4014 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004015
Gilles Peskine449bd832023-01-11 14:50:10 +01004016 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4017 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4018 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004019 }
4020
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004024}
4025
4026/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004027 * Renegotiate current connection on client,
4028 * or request renegotiation on server
4029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004030int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004031{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004032 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl == NULL || ssl->conf == NULL) {
4035 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4036 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004039 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4041 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4042 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4043 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004045 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004046
4047 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ssl->out_left != 0) {
4049 return mbedtls_ssl_flush_output(ssl);
4050 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004051
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004053 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004054#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004056#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004057 /*
4058 * On client, either start the renegotiation process or,
4059 * if already in progress, continue the handshake
4060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4062 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004065
4066 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4067 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4068 return ret;
4069 }
4070 } else {
4071 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4073 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004074 }
4075 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004076#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004079}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004080#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004083{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004084 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004087 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004088 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004089
Valerio Setti6f0441d2023-07-03 12:11:36 +02004090#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004091#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (ssl->handshake->group_list_heap_allocated) {
4093 mbedtls_free((void *) handshake->group_list);
4094 }
Brett Warrene0edc842021-08-17 09:53:13 +01004095 handshake->group_list = NULL;
4096#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004097#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004098
Ronald Crone68ab4f2022-10-05 12:46:29 +02004099#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004100#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if (ssl->handshake->sig_algs_heap_allocated) {
4102 mbedtls_free((void *) handshake->sig_algs);
4103 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004104 handshake->sig_algs = NULL;
4105#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004106#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 if (ssl->handshake->certificate_request_context) {
4108 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004109 }
4110#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004111#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004112
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004113#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4115 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004116 handshake->async_in_progress = 0;
4117 }
4118#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4119
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004120#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004123#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004124 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004125#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004126#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004127#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004128#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004130#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004131 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004132#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004133#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004135#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004137#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004138#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004139 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004141#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004142
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004143#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004144#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004146 /*
4147 * Opaque keys are not stored in the handshake's data and it's the user
4148 * responsibility to destroy them. Clear ones, instead, are created by
4149 * the TLS library and should be destroyed at the same level
4150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4152 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004153 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004154 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4155#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004157#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004158#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004160 handshake->ecjpake_cache = NULL;
4161 handshake->ecjpake_cache_len = 0;
4162#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004163#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004164
Valerio Setti7aeec542023-07-05 18:57:21 +02004165#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004166 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004167 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004168 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004170#endif
4171
Ronald Cron73fe8df2022-10-05 14:31:43 +02004172#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004173#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004175 /* The maintenance of the external PSK key slot is the
4176 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (ssl->handshake->psk_opaque_is_internal) {
4178 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004179 ssl->handshake->psk_opaque_is_internal = 0;
4180 }
4181 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4182 }
Neil Armstronge952a302022-05-03 10:22:14 +02004183#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004185 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004186 }
Neil Armstronge952a302022-05-03 10:22:14 +02004187#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004188#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004190#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4191 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004192 /*
4193 * Free only the linked list wrapper, not the keys themselves
4194 * since the belong to the SNI callback
4195 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004197#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004198
Gilles Peskineeccd8882020-03-10 12:19:08 +01004199#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4201 if (handshake->ecrs_peer_cert != NULL) {
4202 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4203 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004204 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004205#endif
4206
Hanno Becker75173122019-02-06 16:18:31 +00004207#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4208 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004209 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004210#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4211
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004212#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4214 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004215#endif /* MBEDTLS_SSL_CLI_C &&
4216 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004217
4218#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 mbedtls_ssl_flight_free(handshake->flight);
4220 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004221#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004222
Valerio Settiea59c432023-07-25 11:14:03 +02004223#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004224 if (handshake->xxdh_psa_privkey_is_external == 0) {
4225 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 }
Valerio Settiea59c432023-07-25 11:14:03 +02004227#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004228
Ronald Cron6f135e12021-12-08 16:57:54 +01004229#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 mbedtls_ssl_transform_free(handshake->transform_handshake);
4231 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004232#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4234 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004235#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004236#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004237
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004238
4239#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4240 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4241 * processes datagrams and the fact that a datagram is allowed to have
4242 * several records in it, it is possible that the I/O buffers are not
4243 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4245 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004246#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004247
Jerry Yuba9c7272021-10-30 11:54:10 +08004248 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 mbedtls_platform_zeroize(handshake,
4250 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004251}
4252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004254{
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004256 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004261#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004262
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004263#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004264#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4265 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004267#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004269#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker48916f92012-09-16 19:57:18 +00004272}
4273
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004274#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004275
4276#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4277#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4278#else
4279#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4280#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4281
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004282#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004283
4284#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4285#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4286#else
4287#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4288#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4289
4290#if defined(MBEDTLS_SSL_ALPN)
4291#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4292#else
4293#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4294#endif /* MBEDTLS_SSL_ALPN */
4295
4296#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4297#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4298#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4299#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4300
4301#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 ((uint32_t) ( \
4303 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4304 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4305 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4306 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4307 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4308 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4309 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4310 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004311
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004312static unsigned char ssl_serialized_context_header[] = {
4313 MBEDTLS_VERSION_MAJOR,
4314 MBEDTLS_VERSION_MINOR,
4315 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4317 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4318 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4319 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4320 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004321};
4322
Paul Bakker5121ce52009-01-03 21:22:43 +00004323/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004324 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004325 *
4326 * The format of the serialized data is:
4327 * (in the presentation language of TLS, RFC 8446 section 3)
4328 *
4329 * // header
4330 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004331 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004332 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004333 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004334 * Note: When updating the format, remember to keep these
4335 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004336 *
4337 * // session sub-structure
4338 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4339 * // transform sub-structure
4340 * uint8 random[64]; // ServerHello.random+ClientHello.random
4341 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4342 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4343 * // fields from ssl_context
4344 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4345 * uint64 in_window_top; // DTLS: last validated record seq_num
4346 * uint64 in_window; // DTLS: bitmask for replay protection
4347 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4348 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4349 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4350 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4351 *
4352 * Note that many fields of the ssl_context or sub-structures are not
4353 * serialized, as they fall in one of the following categories:
4354 *
4355 * 1. forced value (eg in_left must be 0)
4356 * 2. pointer to dynamically-allocated memory (eg session, transform)
4357 * 3. value can be re-derived from other data (eg session keys from MS)
4358 * 4. value was temporary (eg content of input buffer)
4359 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004361int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4362 unsigned char *buf,
4363 size_t buf_len,
4364 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004365{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004366 unsigned char *p = buf;
4367 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004368 size_t session_len;
4369 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004370
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004371 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004372 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4373 * this function's documentation.
4374 *
4375 * These are due to assumptions/limitations in the implementation. Some of
4376 * them are likely to stay (no handshake in progress) some might go away
4377 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004378 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004379 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4381 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004383 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if (ssl->handshake != NULL) {
4385 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4386 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004387 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004388 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (ssl->transform == NULL || ssl->session == NULL) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004392 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004393 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (mbedtls_ssl_check_pending(ssl) != 0) {
4395 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (ssl->out_left != 0) {
4399 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004401 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004402 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4404 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004406 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004407 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4409 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004411 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004412 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4414 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004416 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004417 /* Renegotiation must not be enabled */
4418#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4420 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4421 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004422 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004423#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004424
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004425 /*
4426 * Version and format identifier
4427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 if (used <= buf_len) {
4431 memcpy(p, ssl_serialized_context_header,
4432 sizeof(ssl_serialized_context_header));
4433 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004434 }
4435
4436 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004437 * Session (length + data)
4438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4440 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4441 return ret;
4442 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004443
4444 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (used <= buf_len) {
4446 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004447 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004448
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 ret = ssl_session_save(ssl->session, 1,
4450 p, session_len, &session_len);
4451 if (ret != 0) {
4452 return ret;
4453 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004454
4455 p += session_len;
4456 }
4457
4458 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004459 * Transform
4460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 used += sizeof(ssl->transform->randbytes);
4462 if (used <= buf_len) {
4463 memcpy(p, ssl->transform->randbytes,
4464 sizeof(ssl->transform->randbytes));
4465 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004466 }
4467
4468#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4469 used += 2 + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004471 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004473 p += ssl->transform->in_cid_len;
4474
4475 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004477 p += ssl->transform->out_cid_len;
4478 }
4479#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4480
4481 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004482 * Saved fields from top-level ssl_context structure
4483 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004484 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (used <= buf_len) {
4486 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004487 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004488 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004489
4490#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4491 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 if (used <= buf_len) {
4493 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004494 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004497 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004498 }
4499#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4500
4501#if defined(MBEDTLS_SSL_PROTO_DTLS)
4502 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004504 *p++ = ssl->disable_datagram_packing;
4505 }
4506#endif /* MBEDTLS_SSL_PROTO_DTLS */
4507
Jerry Yuae0b2e22021-10-08 15:21:19 +08004508 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (used <= buf_len) {
4510 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004511 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004512 }
4513
4514#if defined(MBEDTLS_SSL_PROTO_DTLS)
4515 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 if (used <= buf_len) {
4517 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004518 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004519 }
4520#endif /* MBEDTLS_SSL_PROTO_DTLS */
4521
4522#if defined(MBEDTLS_SSL_ALPN)
4523 {
4524 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004526 : 0;
4527
4528 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004530 *p++ = alpn_len;
4531
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (ssl->alpn_chosen != NULL) {
4533 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004534 p += alpn_len;
4535 }
4536 }
4537 }
4538#endif /* MBEDTLS_SSL_ALPN */
4539
4540 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004541 * Done
4542 */
4543 *olen = used;
4544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (used > buf_len) {
4546 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4547 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004552}
4553
4554/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004555 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004556 *
4557 * This internal version is wrapped by a public function that cleans up in
4558 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004559 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004560MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004561static int ssl_context_load(mbedtls_ssl_context *ssl,
4562 const unsigned char *buf,
4563 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004564{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004565 const unsigned char *p = buf;
4566 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004567 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004568 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004569#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004570 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004571#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004572
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004573 /*
4574 * The context should have been freshly setup or reset.
4575 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004576 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004577 * renegotiating, or if the user mistakenly loaded a session first.)
4578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4580 ssl->session != NULL) {
4581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004582 }
4583
4584 /*
4585 * We can't check that the config matches the initial one, but we can at
4586 * least check it matches the requirements for serializing.
4587 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004588 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004589#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004590 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004591#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004592 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4593 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4594 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4595 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004597 }
4598
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004600
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004601 /*
4602 * Check version identifier
4603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004606 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004607
4608 if (memcmp(p, ssl_serialized_context_header,
4609 sizeof(ssl_serialized_context_header)) != 0) {
4610 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4611 }
4612 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004613
4614 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004615 * Session
4616 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 if ((size_t) (end - p) < 4) {
4618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4619 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004620
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004621 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004622 p += 4;
4623
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004624 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004625 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004626 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004627 ssl->session_in = ssl->session;
4628 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004629 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if ((size_t) (end - p) < session_len) {
4632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4633 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 ret = ssl_session_load(ssl->session, 1, p, session_len);
4636 if (ret != 0) {
4637 mbedtls_ssl_session_free(ssl->session);
4638 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004639 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004640
4641 p += session_len;
4642
4643 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004644 * Transform
4645 */
4646
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004647 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004648 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004649#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004650 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004651 ssl->transform_in = ssl->transform;
4652 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004653 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004654#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004655
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004656#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4658 if (prf_func == NULL) {
4659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4660 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004661
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004662 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4665 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 ret = ssl_tls12_populate_transform(ssl->transform,
4668 ssl->session->ciphersuite,
4669 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004670#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004672#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 prf_func,
4674 p, /* currently pointing to randbytes */
4675 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4676 ssl->conf->endpoint,
4677 ssl);
4678 if (ret != 0) {
4679 return ret;
4680 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004681#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004683
4684#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4685 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if ((size_t) (end - p) < 1) {
4687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4688 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004689
4690 ssl->transform->in_cid_len = *p++;
4691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4694 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004697 p += ssl->transform->in_cid_len;
4698
4699 ssl->transform->out_cid_len = *p++;
4700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4702 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4703 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004704
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004706 p += ssl->transform->out_cid_len;
4707#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4708
4709 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004710 * Saved fields from top-level ssl_context structure
4711 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if ((size_t) (end - p) < 4) {
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4714 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004715
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004716 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004717 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004718
4719#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if ((size_t) (end - p) < 16) {
4721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4722 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004723
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004724 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004725 p += 8;
4726
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004727 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004728 p += 8;
4729#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4730
4731#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if ((size_t) (end - p) < 1) {
4733 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4734 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004735
4736 ssl->disable_datagram_packing = *p++;
4737#endif /* MBEDTLS_SSL_PROTO_DTLS */
4738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4741 }
4742 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4743 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004744
4745#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if ((size_t) (end - p) < 2) {
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4748 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 ssl->mtu = (p[0] << 8) | p[1];
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004751 p += 2;
4752#endif /* MBEDTLS_SSL_PROTO_DTLS */
4753
4754#if defined(MBEDTLS_SSL_ALPN)
4755 {
4756 uint8_t alpn_len;
4757 const char **cur;
4758
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if ((size_t) (end - p) < 1) {
4760 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4761 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004762
4763 alpn_len = *p++;
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004766 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
4768 if (strlen(*cur) == alpn_len &&
4769 memcmp(p, cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004770 ssl->alpn_chosen = *cur;
4771 break;
4772 }
4773 }
4774 }
4775
4776 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
4778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4779 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004780
4781 p += alpn_len;
4782 }
4783#endif /* MBEDTLS_SSL_ALPN */
4784
4785 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004786 * Forced fields from top-level ssl_context structure
4787 *
4788 * Most of them already set to the correct value by mbedtls_ssl_init() and
4789 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
4790 */
4791 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04004792 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004793
Hanno Becker361b10d2019-08-30 10:42:49 +01004794 /* Adjust pointers for header fields of outgoing records to
4795 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01004797
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004798#if defined(MBEDTLS_SSL_PROTO_DTLS)
4799 ssl->in_epoch = 1;
4800#endif
4801
4802 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
4803 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004804 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
4805 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (ssl->handshake != NULL) {
4807 mbedtls_ssl_handshake_free(ssl);
4808 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02004809 ssl->handshake = NULL;
4810 }
4811
4812 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004813 * Done - should have consumed entire buffer
4814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (p != end) {
4816 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4817 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004818
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004820}
4821
4822/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004823 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004825int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
4826 const unsigned char *buf,
4827 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004828{
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (ret != 0) {
4832 mbedtls_ssl_free(context);
4833 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004834
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004836}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004837#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004838
4839/*
Paul Bakker5121ce52009-01-03 21:22:43 +00004840 * Free an SSL context
4841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004843{
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004845 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004851#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4852 size_t out_buf_len = ssl->out_buf_len;
4853#else
4854 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
4855#endif
4856
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004857 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004858 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004859 }
4860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02004862#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4863 size_t in_buf_len = ssl->in_buf_len;
4864#else
4865 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4866#endif
4867
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004868 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004869 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004870 }
4871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (ssl->transform) {
4873 mbedtls_ssl_transform_free(ssl->transform);
4874 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00004875 }
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (ssl->handshake) {
4878 mbedtls_ssl_handshake_free(ssl);
4879 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08004880
4881#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 mbedtls_ssl_transform_free(ssl->transform_negotiate);
4883 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08004884#endif
4885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 mbedtls_ssl_session_free(ssl->session_negotiate);
4887 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00004888 }
4889
Ronald Cron6f135e12021-12-08 16:57:54 +01004890#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 mbedtls_ssl_transform_free(ssl->transform_application);
4892 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01004893#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01004894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl->session) {
4896 mbedtls_ssl_session_free(ssl->session);
4897 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01004898 }
4899
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02004900#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004902 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00004903 }
Paul Bakker0be444a2013-08-27 21:55:01 +02004904#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00004905
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02004906#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02004908#endif
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00004911
Paul Bakker86f04f42013-02-14 11:20:09 +01004912 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00004914}
4915
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004916/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004917 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004919void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004920{
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004922}
4923
Gilles Peskineae270bf2021-06-02 00:05:29 +02004924/* The selection should be the same as mbedtls_x509_crt_profile_default in
4925 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02004926 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02004927 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02004928 * about this list.
4929 */
Brett Warrene0edc842021-08-17 09:53:13 +01004930static uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02004931#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01004932 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004933#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004934#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004935 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004936#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004937#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004938 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004939#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004940#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01004941 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004942#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004943#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004944 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004945#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004946#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004947 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02004948#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004949#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004950 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004951#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02004952#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01004953 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02004954#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02004955#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01004956 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
4957 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
4958 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
4959 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
4960 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
4961#endif
Brett Warrene0edc842021-08-17 09:53:13 +01004962 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02004963};
Gilles Peskineae270bf2021-06-02 00:05:29 +02004964
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03004965static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004966 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
4967 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
4968 0
4969};
4970
Ronald Crone68ab4f2022-10-05 12:46:29 +02004971#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004972
Jerry Yu909df7b2022-01-22 11:56:27 +08004973/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08004974 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08004975 * rules SHOULD be upheld.
4976 * - No duplicate entries.
4977 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08004978 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08004979 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08004980 */
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01004981static uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08004982
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004983#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004984 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004985 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08004986 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004987 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
4988#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004989
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004990#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004991 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004992 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08004993 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004994 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
4995#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08004996
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02004997#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004998 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02004999 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005000 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005001 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5002#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005005 defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005006 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Gilles Peskine449bd832023-01-11 14:50:10 +01005007#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005008 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005011 defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005012 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Gilles Peskine449bd832023-01-11 14:50:10 +01005013#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005014 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005017 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005018 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005019#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005020 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005021
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005022#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005023 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005024#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005025
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005026#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005027 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005028#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005029
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005030#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005031 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005032#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005033
Gabor Mezei15b95a62022-05-09 16:37:58 +02005034 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005035};
5036
5037/* NOTICE: see above */
5038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5039static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005040#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005041#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005043#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005044#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5045 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
5046#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005047#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005049#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005050#endif /* MBEDTLS_MD_CAN_SHA512*/
5051#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005052#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005054#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005055#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5056 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
5057#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005058#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005060#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005061#endif /* MBEDTLS_MD_CAN_SHA384*/
5062#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005063#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005065#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005066#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5067 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
5068#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Gabor Mezeic1051b62022-05-10 13:13:58 +02005069#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005071#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005072#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005073 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005074};
5075#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5076/* NOTICE: see above */
5077static uint16_t ssl_preset_suiteb_sig_algs[] = {
5078
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005079#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005080 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005081 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005082 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005083 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5084#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005085
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005086#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005087 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005088 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005089 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005090 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5091#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005094 defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005095 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Gilles Peskine449bd832023-01-11 14:50:10 +01005096#endif \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005097 /* MBEDTLS_X509_RSASSA_PSS_SUPPORT && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu1a8b4812022-01-20 17:56:50 +08005098
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005099#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu53037892022-01-25 11:02:06 +08005100 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005101#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256*/
Jerry Yu53037892022-01-25 11:02:06 +08005102
Gabor Mezei15b95a62022-05-09 16:37:58 +02005103 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005104};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005105
Jerry Yu909df7b2022-01-22 11:56:27 +08005106/* NOTICE: see above */
5107#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5108static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005109#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005110#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005112#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005113#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005115#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005116#endif /* MBEDTLS_MD_CAN_SHA256*/
5117#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005120#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005121#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005123#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005124#endif /* MBEDTLS_MD_CAN_SHA256*/
Gabor Mezei15b95a62022-05-09 16:37:58 +02005125 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005126};
Jerry Yu909df7b2022-01-22 11:56:27 +08005127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5128
Ronald Crone68ab4f2022-10-05 12:46:29 +02005129#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005130
Brett Warrene0edc842021-08-17 09:53:13 +01005131static uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005132#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005133 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005134#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005135#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005136 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005137#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005138 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005139};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005140
Ronald Crone68ab4f2022-10-05 12:46:29 +02005141#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005142/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005143 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005145static int ssl_check_no_sig_alg_duplication(uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005146{
5147 size_t i, j;
5148 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5151 for (j = 0; j < i; j++) {
5152 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005153 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 }
5155 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5156 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5157 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005158 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005159 }
5160 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005162}
5163
Ronald Crone68ab4f2022-10-05 12:46:29 +02005164#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005165
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005166/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005167 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005169int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5170 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005171{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005172#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005174#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005175
Ronald Crone68ab4f2022-10-05 12:46:29 +02005176#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5178 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5179 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005180 }
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5183 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5184 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005185 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005186
5187#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5189 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5190 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005191 }
5192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5194 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5195 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005196 }
5197#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005198#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005199
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005200 /* Use the functions here so that they are covered in tests,
5201 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 mbedtls_ssl_conf_endpoint(conf, endpoint);
5203 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005204
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005205 /*
5206 * Things that are common to all presets
5207 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005208#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005210 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5211#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5212 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5213#endif
5214 }
5215#endif
5216
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005217#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5218 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5219#endif
5220
5221#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5222 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5223#endif
5224
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005225#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005226 conf->f_cookie_write = ssl_cookie_write_dummy;
5227 conf->f_cookie_check = ssl_cookie_check_dummy;
5228#endif
5229
5230#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5231 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5232#endif
5233
Janos Follath088ce432017-04-10 12:42:31 +01005234#if defined(MBEDTLS_SSL_SRV_C)
5235 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005236 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005237#endif
5238
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005239#if defined(MBEDTLS_SSL_PROTO_DTLS)
5240 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5241 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5242#endif
5243
5244#if defined(MBEDTLS_SSL_RENEGOTIATION)
5245 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 memset(conf->renego_period, 0x00, 2);
5247 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005248#endif
5249
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005250#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005252 const unsigned char dhm_p[] =
5253 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5254 const unsigned char dhm_g[] =
5255 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5258 dhm_p, sizeof(dhm_p),
5259 dhm_g, sizeof(dhm_g))) != 0) {
5260 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005261 }
5262 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005263#endif
5264
Ronald Cron6f135e12021-12-08 16:57:54 +01005265#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005266
5267#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005268 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005269#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005270 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005271#endif
5272#endif /* MBEDTLS_SSL_EARLY_DATA */
5273
Jerry Yud0766ec2022-09-22 10:46:57 +08005274#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005275 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005277#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005278 /*
5279 * Allow all TLS 1.3 key exchange modes by default.
5280 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005281 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005282#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005283
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005285#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005286 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005287 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005288#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005290#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005292#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005293 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5294 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005295#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5296 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5297 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5298#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5299 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5300 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5301#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005303#endif
5304 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005305
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005306 /*
5307 * Preset-specific defaults
5308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005310 /*
5311 * NSA Suite B
5312 */
5313 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005314
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005315 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005316
5317#if defined(MBEDTLS_X509_CRT_PARSE_C)
5318 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005319#endif
5320
Ronald Crone68ab4f2022-10-05 12:46:29 +02005321#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005322#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005324 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005328#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005329
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005330#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005331 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005332#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005333 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005334 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005335
5336 /*
5337 * Default
5338 */
5339 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005340
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005341 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005342
5343#if defined(MBEDTLS_X509_CRT_PARSE_C)
5344 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5345#endif
5346
Ronald Crone68ab4f2022-10-05 12:46:29 +02005347#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005348#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005350 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005354#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005355
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005356#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005357 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005358#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005359 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005360
5361#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5362 conf->dhm_min_bitlen = 1024;
5363#endif
5364 }
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005367}
5368
5369/*
5370 * Free mbedtls_ssl_config
5371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005373{
5374#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 mbedtls_mpi_free(&conf->dhm_P);
5376 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005377#endif
5378
Ronald Cron73fe8df2022-10-05 14:31:43 +02005379#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02005380#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005382 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5383 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02005384#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005386 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005387 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005388 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005389 }
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005392 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005393 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005394 conf->psk_identity_len = 0;
5395 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005396#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005397
5398#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005400#endif
5401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005403}
5404
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005405#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005406 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005407/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005408 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005409 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005410unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005411{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005412#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5414 return MBEDTLS_SSL_SIG_RSA;
5415 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005416#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005417#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5419 return MBEDTLS_SSL_SIG_ECDSA;
5420 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005423}
5424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005426{
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005428 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005430 case MBEDTLS_PK_ECDSA:
5431 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005433 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005435 }
5436}
5437
Gilles Peskine449bd832023-01-11 14:50:10 +01005438mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005439{
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441#if defined(MBEDTLS_RSA_C)
5442 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005444#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005445#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005448#endif
5449 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005451 }
5452}
Valerio Settie9646ec2023-08-02 20:02:28 +02005453#endif /* MBEDTLS_PK_C &&
5454 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005455
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005456/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005457 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005459mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005460{
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005462#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005465#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005466#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005469#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005470#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005473#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005474#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005477#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005478#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005481#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005482#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005485#endif
5486 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005488 }
5489}
5490
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005491/*
5492 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005495{
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005497#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005498 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005500#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005501#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005502 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005504#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005505#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005506 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005508#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005509#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005510 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005512#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005513#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005514 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005516#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005517#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005518 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005520#endif
5521 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005523 }
5524}
5525
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005526/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005527 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005528 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005530int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005531{
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (group_list == NULL) {
5535 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005536 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 for (; *group_list != 0; group_list++) {
5539 if (*group_list == tls_id) {
5540 return 0;
5541 }
5542 }
5543
5544 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005545}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005546
Valerio Setti49e69072023-06-27 17:27:51 +02005547#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005548/*
5549 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005552{
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005556 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005558
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005560}
Valerio Setti49e69072023-06-27 17:27:51 +02005561#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01005562
Valerio Setti18c9fed2022-12-30 17:44:24 +01005563static const struct {
5564 uint16_t tls_id;
5565 mbedtls_ecp_group_id ecp_group_id;
5566 psa_ecc_family_t psa_family;
5567 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005568} tls_id_match_table[] =
5569{
Valerio Settidb6b4db2023-09-01 09:20:51 +02005570#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005571 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005572#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005573#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005574 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005575#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005576#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005577 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005578#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005579#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005580 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005581#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005582#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005583 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005584#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005585#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005586 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005587#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005588#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005589 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005590#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005591#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005592 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005593#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005594#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005595 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005596#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005597#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005598 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005599#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005600#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02005601 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005602#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005603#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02005604 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005605#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005606#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005607 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005608#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005609 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005610};
5611
Gilles Peskine449bd832023-01-11 14:50:10 +01005612int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005613 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 size_t *bits)
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) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005618 if (type != NULL) {
5619 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
5621 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005622 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005624 return PSA_SUCCESS;
5625 }
5626 }
5627
5628 return PSA_ERROR_NOT_SUPPORTED;
5629}
5630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005632{
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5634 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005635 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005636 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005637 }
5638
5639 return MBEDTLS_ECP_DP_NONE;
5640}
5641
Gilles Peskine449bd832023-01-11 14:50:10 +01005642uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005643{
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5645 i++) {
5646 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005647 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005649 }
5650
5651 return 0;
5652}
5653
Valerio Setti67419f02023-01-04 16:12:42 +01005654#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005655static const struct {
5656 uint16_t tls_id;
5657 const char *name;
5658} tls_id_curve_name_table[] =
5659{
Valerio Setti54e23792023-07-07 10:49:27 +02005660 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5661 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5662 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5663 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5664 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5665 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5666 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5667 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5668 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5669 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5670 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5671 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5672 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005673 { 0, NULL },
5674};
5675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005677{
Valerio Settiacd32c02023-06-29 18:06:29 +02005678 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5679 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5680 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005682 }
5683
5684 return NULL;
5685}
Valerio Setti67419f02023-01-04 16:12:42 +01005686#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005689int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
5690 const mbedtls_ssl_ciphersuite_t *ciphersuite,
5691 int cert_endpoint,
5692 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005693{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005694 int ret = 0;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005695 int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005696 const char *ext_oid;
5697 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005700 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 case MBEDTLS_KEY_EXCHANGE_RSA:
5703 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005704 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005705 break;
5706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005707 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
5708 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
5709 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
5710 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005711 break;
5712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
5714 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005715 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005716 break;
5717
5718 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719 case MBEDTLS_KEY_EXCHANGE_NONE:
5720 case MBEDTLS_KEY_EXCHANGE_PSK:
5721 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
5722 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02005723 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005724 usage = 0;
5725 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
5728 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005729 }
5730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005732 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005733 ret = -1;
5734 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005735
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
5739 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01005745 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01005746 ret = -1;
5747 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02005748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02005750}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02005752
Jerry Yu148165c2021-09-24 23:20:59 +08005753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5755 const mbedtls_md_type_t md,
5756 unsigned char *dst,
5757 size_t dst_len,
5758 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005759{
Ronald Cronf6893e12022-01-07 22:09:01 +01005760 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5761 psa_hash_operation_t *hash_operation_to_clone;
5762 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5763
Jerry Yu148165c2021-09-24 23:20:59 +08005764 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005765
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005767#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 case MBEDTLS_MD_SHA384:
5769 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5770 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005771#endif
5772
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005773#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 case MBEDTLS_MD_SHA256:
5775 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5776 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005777#endif
5778
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 default:
5780 goto exit;
5781 }
5782
5783 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5784 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005785 goto exit;
5786 }
5787
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5789 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005790 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005792
5793exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005794#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5795 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005796 (void) ssl;
5797#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005798 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005799}
5800#else /* MBEDTLS_USE_PSA_CRYPTO */
5801
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005802#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005804static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
5805 unsigned char *dst,
5806 size_t dst_len,
5807 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005808{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005809 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005810 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (dst_len < 48) {
5813 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5814 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005815
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005816 mbedtls_md_init(&sha384);
5817 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005818 if (ret != 0) {
5819 goto exit;
5820 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005821 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005822 if (ret != 0) {
5823 goto exit;
5824 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005825
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005826 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005827 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005828 goto exit;
5829 }
5830
5831 *olen = 48;
5832
5833exit:
5834
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01005835 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005837}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005838#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005839
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005840#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005841MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005842static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
5843 unsigned char *dst,
5844 size_t dst_len,
5845 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005846{
Jerry Yu24c0ec32021-09-09 14:21:07 +08005847 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005848 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 if (dst_len < 32) {
5851 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
5852 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08005853
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005854 mbedtls_md_init(&sha256);
5855 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
5856 if (ret != 0) {
5857 goto exit;
5858 }
5859 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
5860 if (ret != 0) {
5861 goto exit;
5862 }
Jerry Yuc5aef882021-12-23 20:15:02 +08005863
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005864 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
5865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08005866 goto exit;
5867 }
5868
5869 *olen = 32;
5870
5871exit:
5872
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01005873 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005875}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005876#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5879 const mbedtls_md_type_t md,
5880 unsigned char *dst,
5881 size_t dst_len,
5882 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08005883{
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005885
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005886#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 case MBEDTLS_MD_SHA384:
5888 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005889#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005890
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005891#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 case MBEDTLS_MD_SHA256:
5893 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005894#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005897#if !defined(MBEDTLS_MD_CAN_SHA384) && \
5898 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 (void) ssl;
5900 (void) dst;
5901 (void) dst_len;
5902 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04005903#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08005905 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08005907}
XiaokangQian647719a2021-12-07 09:16:29 +00005908
Jerry Yu148165c2021-09-24 23:20:59 +08005909#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08005910
Ronald Crone68ab4f2022-10-05 12:46:29 +02005911#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005912/* mbedtls_ssl_parse_sig_alg_ext()
5913 *
5914 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5915 * value (TLS 1.3 RFC8446):
5916 * enum {
5917 * ....
5918 * ecdsa_secp256r1_sha256( 0x0403 ),
5919 * ecdsa_secp384r1_sha384( 0x0503 ),
5920 * ecdsa_secp521r1_sha512( 0x0603 ),
5921 * ....
5922 * } SignatureScheme;
5923 *
5924 * struct {
5925 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5926 * } SignatureSchemeList;
5927 *
5928 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5929 * value (TLS 1.2 RFC5246):
5930 * enum {
5931 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5932 * sha512(6), (255)
5933 * } HashAlgorithm;
5934 *
5935 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5936 * SignatureAlgorithm;
5937 *
5938 * struct {
5939 * HashAlgorithm hash;
5940 * SignatureAlgorithm signature;
5941 * } SignatureAndHashAlgorithm;
5942 *
5943 * SignatureAndHashAlgorithm
5944 * supported_signature_algorithms<2..2^16-2>;
5945 *
5946 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5947 * generalization of the TLS 1.2 signature algorithm extension.
5948 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5949 * `SignatureScheme` field of TLS 1.3
5950 *
5951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005952int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5953 const unsigned char *buf,
5954 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005955{
5956 const unsigned char *p = buf;
5957 size_t supported_sig_algs_len = 0;
5958 const unsigned char *supported_sig_algs_end;
5959 uint16_t sig_alg;
5960 uint32_t common_idx = 0;
5961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5963 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005964 p += 2;
5965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966 memset(ssl->handshake->received_sig_algs, 0,
5967 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005970 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 while (p < supported_sig_algs_end) {
5972 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5973 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005974 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5976 sig_alg,
5977 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5980 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5981 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005982 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005983 }
5984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5987 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005988
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005990 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5991 common_idx += 1;
5992 }
5993 }
5994 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 if (p != end) {
5996 MBEDTLS_SSL_DEBUG_MSG(1,
5997 ("Signature algorithms extension length misaligned"));
5998 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
5999 MBEDTLS_ERR_SSL_DECODE_ERROR);
6000 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006001 }
6002
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (common_idx == 0) {
6004 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6005 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6006 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6007 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006008 }
6009
Gabor Mezei15b95a62022-05-09 16:37:58 +02006010 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006012}
6013
Ronald Crone68ab4f2022-10-05 12:46:29 +02006014#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006015
Jerry Yudc7bd172022-02-17 13:44:15 +08006016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6017
6018#if defined(MBEDTLS_USE_PSA_CRYPTO)
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6021 mbedtls_svc_key_id_t key,
6022 psa_algorithm_t alg,
6023 const unsigned char *raw_psk, size_t raw_psk_length,
6024 const unsigned char *seed, size_t seed_length,
6025 const unsigned char *label, size_t label_length,
6026 const unsigned char *other_secret,
6027 size_t other_secret_length,
6028 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006029{
6030 psa_status_t status;
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 status = psa_key_derivation_setup(derivation, alg);
6033 if (status != PSA_SUCCESS) {
6034 return status;
6035 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6038 status = psa_key_derivation_input_bytes(derivation,
6039 PSA_KEY_DERIVATION_INPUT_SEED,
6040 seed, seed_length);
6041 if (status != PSA_SUCCESS) {
6042 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006043 }
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (other_secret != NULL) {
6046 status = psa_key_derivation_input_bytes(derivation,
6047 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6048 other_secret, other_secret_length);
6049 if (status != PSA_SUCCESS) {
6050 return status;
6051 }
6052 }
6053
6054 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006055 status = psa_key_derivation_input_bytes(
6056 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 raw_psk, raw_psk_length);
6058 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006059 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006061 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (status != PSA_SUCCESS) {
6063 return status;
6064 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 status = psa_key_derivation_input_bytes(derivation,
6067 PSA_KEY_DERIVATION_INPUT_LABEL,
6068 label, label_length);
6069 if (status != PSA_SUCCESS) {
6070 return status;
6071 }
6072 } else {
6073 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006074 }
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 status = psa_key_derivation_set_capacity(derivation, capacity);
6077 if (status != PSA_SUCCESS) {
6078 return status;
6079 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006082}
6083
Andrzej Kurek57d10632022-10-24 10:32:01 -04006084#if defined(PSA_WANT_ALG_SHA_384) || \
6085 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006087static int tls_prf_generic(mbedtls_md_type_t md_type,
6088 const unsigned char *secret, size_t slen,
6089 const char *label,
6090 const unsigned char *random, size_t rlen,
6091 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006092{
6093 psa_status_t status;
6094 psa_algorithm_t alg;
6095 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6096 psa_key_derivation_operation_t derivation =
6097 PSA_KEY_DERIVATION_OPERATION_INIT;
6098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006100 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006102 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006104
6105 /* Normally a "secret" should be long enough to be impossible to
6106 * find by brute force, and in particular should not be empty. But
6107 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6108 * and for this use case it makes sense to have a 0-length "secret".
6109 * Since the key API doesn't allow importing a key of length 0,
6110 * keep master_key=0, which setup_psa_key_derivation() understands
6111 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6115 psa_set_key_algorithm(&key_attributes, alg);
6116 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006117
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6119 if (status != PSA_SUCCESS) {
6120 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6121 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006122 }
6123
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 status = setup_psa_key_derivation(&derivation,
6125 master_key, alg,
6126 NULL, 0,
6127 random, rlen,
6128 (unsigned char const *) label,
6129 (size_t) strlen(label),
6130 NULL, 0,
6131 dlen);
6132 if (status != PSA_SUCCESS) {
6133 psa_key_derivation_abort(&derivation);
6134 psa_destroy_key(master_key);
6135 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006136 }
6137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6139 if (status != PSA_SUCCESS) {
6140 psa_key_derivation_abort(&derivation);
6141 psa_destroy_key(master_key);
6142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006143 }
6144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 status = psa_key_derivation_abort(&derivation);
6146 if (status != PSA_SUCCESS) {
6147 psa_destroy_key(master_key);
6148 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006149 }
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 if (!mbedtls_svc_key_id_is_null(master_key)) {
6152 status = psa_destroy_key(master_key);
6153 }
6154 if (status != PSA_SUCCESS) {
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6156 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006159}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006160#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006161#else /* MBEDTLS_USE_PSA_CRYPTO */
6162
Andrzej Kurek57d10632022-10-24 10:32:01 -04006163#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006164 (defined(MBEDTLS_MD_CAN_SHA256) || \
6165 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006166MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006167static int tls_prf_generic(mbedtls_md_type_t md_type,
6168 const unsigned char *secret, size_t slen,
6169 const char *label,
6170 const unsigned char *random, size_t rlen,
6171 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006172{
6173 size_t nb;
6174 size_t i, j, k, md_len;
6175 unsigned char *tmp;
6176 size_t tmp_len = 0;
6177 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6178 const mbedtls_md_info_t *md_info;
6179 mbedtls_md_context_t md_ctx;
6180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6185 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6186 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 tmp_len = md_len + strlen(label) + rlen;
6191 tmp = mbedtls_calloc(1, tmp_len);
6192 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006193 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6194 goto exit;
6195 }
6196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 nb = strlen(label);
6198 memcpy(tmp + md_len, label, nb);
6199 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006200 nb += rlen;
6201
6202 /*
6203 * Compute P_<hash>(secret, label + random)[0..dlen]
6204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6210 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006211 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 }
6213 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6214 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
6217 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6218 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 for (i = 0; i < dlen; i += md_len) {
6223 ret = mbedtls_md_hmac_reset(&md_ctx);
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_update(&md_ctx, tmp, md_len + nb);
6228 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
6231 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6232 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006233 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 ret = mbedtls_md_hmac_reset(&md_ctx);
6237 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 }
6240 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6241 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 }
6244 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6245 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006252 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 }
6255
6256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006258
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if (tmp != NULL) {
6260 mbedtls_platform_zeroize(tmp, tmp_len);
6261 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006268}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006269#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006270#endif /* MBEDTLS_USE_PSA_CRYPTO */
6271
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006272#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006273MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006274static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6275 const char *label,
6276 const unsigned char *random, size_t rlen,
6277 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006278{
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6280 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006281}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006282#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006283
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006284#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006286static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6287 const char *label,
6288 const unsigned char *random, size_t rlen,
6289 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006290{
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6292 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006293}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006294#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006295
Jerry Yuf009d862022-02-17 14:01:37 +08006296/*
6297 * Set appropriate PRF function and other SSL / TLS1.2 functions
6298 *
6299 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006300 * - hash associated with the ciphersuite (only used by TLS 1.2)
6301 *
6302 * Outputs:
6303 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6304 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006306static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6307 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006308{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006309#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006311 handshake->tls_prf = tls_prf_sha384;
6312 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6313 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006315#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006316#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006317 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006318 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006319 handshake->tls_prf = tls_prf_sha256;
6320 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6321 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6322 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006323#else
Jerry Yuf009d862022-02-17 14:01:37 +08006324 {
Jerry Yuf009d862022-02-17 14:01:37 +08006325 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006326 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006328 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006329#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006330
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006332}
Jerry Yud6ab2352022-02-17 14:03:43 +08006333
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006334/*
6335 * Compute master secret if needed
6336 *
6337 * Parameters:
6338 * [in/out] handshake
6339 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6340 * (PSA-PSK) ciphersuite_info, psk_opaque
6341 * [out] premaster (cleared)
6342 * [out] master
6343 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6344 * debug: conf->f_dbg, conf->p_dbg
6345 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006346 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006348MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006349static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6350 unsigned char *master,
6351 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006352{
6353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6354
6355 /* cf. RFC 5246, Section 8.1:
6356 * "The master secret is always exactly 48 bytes in length." */
6357 size_t const master_secret_len = 48;
6358
6359#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6360 unsigned char session_hash[48];
6361#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6362
6363 /* The label for the KDF used for key expansion.
6364 * This is either "master secret" or "extended master secret"
6365 * depending on whether the Extended Master Secret extension
6366 * is used. */
6367 char const *lbl = "master secret";
6368
Przemek Stekielae4ed302022-04-05 17:15:55 +02006369 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006370 * - If the Extended Master Secret extension is not used,
6371 * this is ClientHello.Random + ServerHello.Random
6372 * (see Sect. 8.1 in RFC 5246).
6373 * - If the Extended Master Secret extension is used,
6374 * this is the transcript of the handshake so far.
6375 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006376 unsigned char const *seed = handshake->randbytes;
6377 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006378
6379#if !defined(MBEDTLS_DEBUG_C) && \
6380 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6381 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006383 ssl = NULL; /* make sure we don't use it except for those cases */
6384 (void) ssl;
6385#endif
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (handshake->resume != 0) {
6388 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6389 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 }
6391
6392#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006394 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006395 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006396 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6397 if (ret != 0) {
6398 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6399 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6402 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006404#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405
Przemek Stekiel99114f32022-04-22 11:20:09 +02006406#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006407 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 /* Perform PSK-to-MS expansion in a single step. */
6410 psa_status_t status;
6411 psa_algorithm_t alg;
6412 mbedtls_svc_key_id_t psk;
6413 psa_key_derivation_operation_t derivation =
6414 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006415 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006427 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006431 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006432 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006433 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006434 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006435 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006436 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006437 other_secret_len = 48;
6438 other_secret = handshake->premaster + 2;
6439 break;
6440 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006441 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006442 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6443 other_secret = handshake->premaster + 2;
6444 break;
6445 default:
6446 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006447 }
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 status = setup_psa_key_derivation(&derivation, psk, alg,
6450 ssl->conf->psk, ssl->conf->psk_len,
6451 seed, seed_len,
6452 (unsigned char const *) lbl,
6453 (size_t) strlen(lbl),
6454 other_secret, other_secret_len,
6455 master_secret_len);
6456 if (status != PSA_SUCCESS) {
6457 psa_key_derivation_abort(&derivation);
6458 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459 }
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 status = psa_key_derivation_output_bytes(&derivation,
6462 master,
6463 master_secret_len);
6464 if (status != PSA_SUCCESS) {
6465 psa_key_derivation_abort(&derivation);
6466 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006467 }
6468
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 status = psa_key_derivation_abort(&derivation);
6470 if (status != PSA_SUCCESS) {
6471 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6472 }
6473 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474#endif
6475 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006476#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
6478 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006479 psa_status_t status;
6480 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6481 psa_key_derivation_operation_t derivation =
6482 PSA_KEY_DERIVATION_OPERATION_INIT;
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485
6486 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 status = psa_key_derivation_setup(&derivation, alg);
6489 if (status != PSA_SUCCESS) {
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_key_derivation_set_capacity(&derivation,
6494 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6495 if (status != PSA_SUCCESS) {
6496 psa_key_derivation_abort(&derivation);
6497 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6501 &derivation);
6502 if (status != PSA_SUCCESS) {
6503 psa_key_derivation_abort(&derivation);
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 status = psa_key_derivation_output_bytes(&derivation,
6508 handshake->premaster,
6509 handshake->pmslen);
6510 if (status != PSA_SUCCESS) {
6511 psa_key_derivation_abort(&derivation);
6512 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6513 }
6514
6515 status = psa_key_derivation_abort(&derivation);
6516 if (status != PSA_SUCCESS) {
6517 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006518 }
6519 }
6520#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6522 lbl, seed, seed_len,
6523 master,
6524 master_secret_len);
6525 if (ret != 0) {
6526 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6527 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006528 }
6529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6531 handshake->premaster,
6532 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 mbedtls_platform_zeroize(handshake->premaster,
6535 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006536 }
6537
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539}
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006542{
6543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6544 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6545 ssl->handshake->ciphersuite_info;
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006548
6549 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006551 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 if (ret != 0) {
6553 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6554 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006555 }
6556
6557 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 ret = ssl_compute_master(ssl->handshake,
6559 ssl->session_negotiate->master,
6560 ssl);
6561 if (ret != 0) {
6562 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6563 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006564 }
6565
6566 /* Swap the client and server random values:
6567 * - MS derivation wanted client+server (RFC 5246 8.1)
6568 * - key derivation wants server+client (RFC 5246 6.3) */
6569 {
6570 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 memcpy(tmp, ssl->handshake->randbytes, 64);
6572 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6573 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6574 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006575 }
6576
6577 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6579 ssl->session_negotiate->ciphersuite,
6580 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006581#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006583#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 ssl->handshake->tls_prf,
6585 ssl->handshake->randbytes,
6586 ssl->tls_version,
6587 ssl->conf->endpoint,
6588 ssl);
6589 if (ret != 0) {
6590 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6591 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006592 }
6593
6594 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6596 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006599
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006601}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006604{
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006606#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006607 case MBEDTLS_SSL_HASH_SHA384:
6608 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6609 break;
6610#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006611#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006612 case MBEDTLS_SSL_HASH_SHA256:
6613 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6614 break;
6615#endif
6616 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006619#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6620 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006621 (void) ssl;
6622#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006624}
6625
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006626#if defined(MBEDTLS_USE_PSA_CRYPTO)
6627static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6628 const psa_hash_operation_t *hs_op,
6629 size_t buffer_size,
6630 unsigned char *hash,
6631 size_t *hlen)
6632{
6633 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006634 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006635
6636#if !defined(MBEDTLS_DEBUG_C)
6637 (void) ssl;
6638#endif
6639 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006640 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006641 if (status != PSA_SUCCESS) {
6642 goto exit;
6643 }
6644
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006645 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006646 if (status != PSA_SUCCESS) {
6647 goto exit;
6648 }
6649
6650 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6651 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6652
6653exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006654 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006655 return mbedtls_md_error_from_psa(status);
6656}
6657#else
6658static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
6659 const mbedtls_md_context_t *hs_ctx,
6660 unsigned char *hash,
6661 size_t *hlen)
6662{
6663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006664 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006665
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006666 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006667
6668#if !defined(MBEDTLS_DEBUG_C)
6669 (void) ssl;
6670#endif
6671 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
6672
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006673 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006674 if (ret != 0) {
6675 goto exit;
6676 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006677 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678 if (ret != 0) {
6679 goto exit;
6680 }
6681
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006682 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006683 if (ret != 0) {
6684 goto exit;
6685 }
6686
6687 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
6688
6689 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
6690 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
6691
6692exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006693 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006694 return ret;
6695}
6696#endif /* MBEDTLS_USE_PSA_CRYPTO */
6697
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006698#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006699int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6700 unsigned char *hash,
6701 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006702{
6703#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006704 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6705 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006706#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006707 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
6708 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006709#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006710}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006711#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006712
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006713#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006714int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6715 unsigned char *hash,
6716 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006717{
6718#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006719 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6720 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006721#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006722 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
6723 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006724#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006725}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006726#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006727
Neil Armstrong80f6f322022-05-03 17:56:38 +02006728#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
6729 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006730int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08006731{
6732 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08006734 const unsigned char *psk = NULL;
6735 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006737
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006739 /*
6740 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006741 * checked before calling this function.
6742 *
6743 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02006744 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08006745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
6747 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6748 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02006749 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006750 }
6751
6752 /*
6753 * PMS = struct {
6754 * opaque other_secret<0..2^16-1>;
6755 * opaque psk<0..2^16-1>;
6756 * };
6757 * with "other_secret" depending on the particular key exchange
6758 */
6759#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
6761 if (end - p < 2) {
6762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6763 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006764
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006766 p += 2;
6767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (end < p || (size_t) (end - p) < psk_len) {
6769 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6770 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006773 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006775#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
6776#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006778 /*
6779 * other_secret already set by the ClientKeyExchange message,
6780 * and is 48 bytes long
6781 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (end - p < 2) {
6783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6784 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006785
6786 *p++ = 0;
6787 *p++ = 48;
6788 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006790#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
6791#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006793 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6794 size_t len;
6795
6796 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
6798 p + 2, end - (p + 2), &len,
6799 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6800 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
6801 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006804 p += 2 + len;
6805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
6807 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08006808#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02006809#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08006811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6812 size_t zlen;
6813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
6815 p + 2, end - (p + 2),
6816 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
6817 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
6818 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006822 p += 2 + zlen;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
6825 MBEDTLS_DEBUG_ECDH_Z);
6826 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02006827#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08006828 {
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08006831 }
6832
6833 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 if (end - p < 2) {
6835 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6836 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08006839 p += 2;
6840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (end < p || (size_t) (end - p) < psk_len) {
6842 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6843 }
Jerry Yuce3dca42022-02-17 14:16:37 +08006844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08006846 p += psk_len;
6847
6848 ssl->handshake->pmslen = p - ssl->handshake->premaster;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08006851}
Neil Armstrong80f6f322022-05-03 17:56:38 +02006852#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08006853
6854#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006856static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006857
6858#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006859int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006860{
6861 /* If renegotiation is not enforced, retransmit until we would reach max
6862 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006864 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6865 unsigned char doublings = 1;
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006868 ++doublings;
6869 ratio >>= 1;
6870 }
6871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 if (++ssl->renego_records_seen > doublings) {
6873 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6874 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006875 }
6876 }
6877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006879}
6880#endif
6881#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006882
Jerry Yud9526692022-02-17 14:23:47 +08006883/*
6884 * Handshake functions
6885 */
6886#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6887/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006888int mbedtls_ssl_write_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, ("=> write 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 write 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
Gilles Peskine449bd832023-01-11 14:50:10 +01006905int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006906{
6907 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6908 ssl->handshake->ciphersuite_info;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006911
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6913 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006914 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6919 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006920}
6921
6922#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6923/* Some certificate support -> implement write and parse */
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006926{
6927 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6928 size_t i, n;
6929 const mbedtls_x509_crt *crt;
6930 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6931 ssl->handshake->ciphersuite_info;
6932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6936 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006937 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006939 }
6940
6941#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6943 if (ssl->handshake->client_auth == 0) {
6944 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006945 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006947 }
6948 }
6949#endif /* MBEDTLS_SSL_CLI_C */
6950#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6952 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006953 /* Should never happen because we shouldn't have picked the
6954 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006956 }
6957 }
6958#endif
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006961
6962 /*
6963 * 0 . 0 handshake type
6964 * 1 . 3 handshake length
6965 * 4 . 6 length of all certs
6966 * 7 . 9 length of cert. 1
6967 * 10 . n-1 peer certificate
6968 * n . n+2 length of cert. 2
6969 * n+3 . ... upper level cert, etc.
6970 */
6971 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006973
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006975 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6977 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6978 " > %" MBEDTLS_PRINTF_SIZET,
6979 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6980 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006981 }
6982
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6984 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6985 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006986
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006988 i += n; crt = crt->next;
6989 }
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6992 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6993 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006994
6995 ssl->out_msglen = i;
6996 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6997 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6998
6999 ssl->state++;
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7002 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7003 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007004 }
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007007
Gilles Peskine449bd832023-01-11 14:50:10 +01007008 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007009}
7010
7011#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7012
7013#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007014MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007015static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7016 unsigned char *crt_buf,
7017 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007018{
7019 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7020
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 if (peer_crt == NULL) {
7022 return -1;
7023 }
Jerry Yud9526692022-02-17 14:23:47 +08007024
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 if (peer_crt->raw.len != crt_buf_len) {
7026 return -1;
7027 }
Jerry Yud9526692022-02-17 14:23:47 +08007028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007030}
7031#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007033static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7034 unsigned char *crt_buf,
7035 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007036{
7037 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7038 unsigned char const * const peer_cert_digest =
7039 ssl->session->peer_cert_digest;
7040 mbedtls_md_type_t const peer_cert_digest_type =
7041 ssl->session->peer_cert_digest_type;
7042 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007044 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7045 size_t digest_len;
7046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (peer_cert_digest == NULL || digest_info == NULL) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 digest_len = mbedtls_md_get_size(digest_info);
7052 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7053 return -1;
7054 }
Jerry Yud9526692022-02-17 14:23:47 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7057 if (ret != 0) {
7058 return -1;
7059 }
Jerry Yud9526692022-02-17 14:23:47 +08007060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007062}
7063#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7064#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7065
7066/*
7067 * Once the certificate message is read, parse it into a cert chain and
7068 * perform basic checks, but leave actual verification to the caller
7069 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007070MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007071static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7072 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007073{
7074 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7075#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007076 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007077#endif
7078 size_t i, n;
7079 uint8_t alert;
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7082 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7083 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7084 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7085 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007086 }
7087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7089 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7090 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7091 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7095 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7096 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7097 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7098 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007099 }
7100
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007102
7103 /*
7104 * Same message structure as in mbedtls_ssl_write_certificate()
7105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 n = (ssl->in_msg[i+1] << 8) | ssl->in_msg[i+2];
Jerry Yud9526692022-02-17 14:23:47 +08007107
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 if (ssl->in_msg[i] != 0 ||
7109 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7110 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7111 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7112 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7113 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007114 }
7115
7116 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7117 i += 3;
7118
7119 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007121 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 if (i + 3 > ssl->in_hslen) {
7123 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7124 mbedtls_ssl_send_alert_message(ssl,
7125 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7126 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7127 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007128 }
7129 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7130 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (ssl->in_msg[i] != 0) {
7132 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7133 mbedtls_ssl_send_alert_message(ssl,
7134 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7135 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7136 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007137 }
7138
7139 /* Read length of the next CRT in the chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 n = ((unsigned int) ssl->in_msg[i + 1] << 8)
Jerry Yud9526692022-02-17 14:23:47 +08007141 | (unsigned int) ssl->in_msg[i + 2];
7142 i += 3;
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 if (n < 128 || i + n > ssl->in_hslen) {
7145 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7146 mbedtls_ssl_send_alert_message(ssl,
7147 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7148 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7149 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007150 }
7151
7152 /* Check if we're handling the first CRT in the chain. */
7153#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007155 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007157 /* During client-side renegotiation, check that the server's
7158 * end-CRTs hasn't changed compared to the initial handshake,
7159 * mitigating the triple handshake attack. On success, reuse
7160 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7162 if (ssl_check_peer_crt_unchanged(ssl,
7163 &ssl->in_msg[i],
7164 n) != 0) {
7165 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7166 mbedtls_ssl_send_alert_message(ssl,
7167 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7168 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7169 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007170 }
7171
7172 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007174 }
7175#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7176
7177 /* Parse the next certificate in the chain. */
7178#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007180#else
7181 /* If we don't need to store the CRT chain permanently, parse
7182 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007184#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007186 case 0: /*ok*/
7187 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7188 /* Ignore certificate with an unknown algorithm: maybe a
7189 prior certificate was already trusted. */
7190 break;
7191
7192 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7193 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7194 goto crt_parse_der_failed;
7195
7196 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7197 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7198 goto crt_parse_der_failed;
7199
7200 default:
7201 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007202crt_parse_der_failed:
7203 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7204 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7205 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007206 }
7207
7208 i += n;
7209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7212 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007213}
7214
7215#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007217static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007218{
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7220 return -1;
7221 }
Jerry Yud9526692022-02-17 14:23:47 +08007222
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007224 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7225 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7227 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7228 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007229 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007231}
7232#endif /* MBEDTLS_SSL_SRV_C */
7233
7234/* Check if a certificate message is expected.
7235 * Return either
7236 * - SSL_CERTIFICATE_EXPECTED, or
7237 * - SSL_CERTIFICATE_SKIP
7238 * indicating whether a Certificate message is expected or not.
7239 */
7240#define SSL_CERTIFICATE_EXPECTED 0
7241#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007243static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7244 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007245{
7246 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7247 ssl->handshake->ciphersuite_info;
7248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7250 return SSL_CERTIFICATE_SKIP;
7251 }
Jerry Yud9526692022-02-17 14:23:47 +08007252
7253#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7255 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7256 return SSL_CERTIFICATE_SKIP;
7257 }
Jerry Yud9526692022-02-17 14:23:47 +08007258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007260 ssl->session_negotiate->verify_result =
7261 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007263 }
7264 }
7265#else
7266 ((void) authmode);
7267#endif /* MBEDTLS_SSL_SRV_C */
7268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007270}
7271
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007272MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007273static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7274 int authmode,
7275 mbedtls_x509_crt *chain,
7276 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007277{
7278 int ret = 0;
7279 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7280 ssl->handshake->ciphersuite_info;
7281 int have_ca_chain = 0;
7282
7283 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7284 void *p_vrfy;
7285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7287 return 0;
7288 }
Jerry Yud9526692022-02-17 14:23:47 +08007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (ssl->f_vrfy != NULL) {
7291 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007292 f_vrfy = ssl->f_vrfy;
7293 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 } else {
7295 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007296 f_vrfy = ssl->conf->f_vrfy;
7297 p_vrfy = ssl->conf->p_vrfy;
7298 }
7299
7300 /*
7301 * Main check: verify certificate
7302 */
7303#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007305 ((void) rs_ctx);
7306 have_ca_chain = 1;
7307
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007309 ret = mbedtls_x509_crt_verify_with_ca_cb(
7310 chain,
7311 ssl->conf->f_ca_cb,
7312 ssl->conf->p_ca_cb,
7313 ssl->conf->cert_profile,
7314 ssl->hostname,
7315 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 f_vrfy, p_vrfy);
7317 } else
Jerry Yud9526692022-02-17 14:23:47 +08007318#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7319 {
7320 mbedtls_x509_crt *ca_chain;
7321 mbedtls_x509_crl *ca_crl;
7322
7323#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007325 ca_chain = ssl->handshake->sni_ca_chain;
7326 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 } else
Jerry Yud9526692022-02-17 14:23:47 +08007328#endif
7329 {
7330 ca_chain = ssl->conf->ca_chain;
7331 ca_crl = ssl->conf->ca_crl;
7332 }
7333
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007335 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 }
Jerry Yud9526692022-02-17 14:23:47 +08007337
7338 ret = mbedtls_x509_crt_verify_restartable(
7339 chain,
7340 ca_chain, ca_crl,
7341 ssl->conf->cert_profile,
7342 ssl->hostname,
7343 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08007345 }
7346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (ret != 0) {
7348 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007349 }
7350
7351#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
7353 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
7354 }
Jerry Yud9526692022-02-17 14:23:47 +08007355#endif
7356
7357 /*
7358 * Secondary checks: always done, but change 'ret' only if it was 0
7359 */
7360
Valerio Settiacd32c02023-06-29 18:06:29 +02007361#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Jerry Yud9526692022-02-17 14:23:47 +08007362 {
7363 const mbedtls_pk_context *pk = &chain->pk;
7364
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02007365 /* If certificate uses an EC key, make sure the curve is OK.
7366 * This is a public key, so it can't be opaque, so can_do() is a good
7367 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007369 /* and in the unlikely case the above assumption no longer holds
7370 * we are making sure that pk_ec() here does not return a NULL
7371 */
Valerio Settid0405092023-05-24 13:16:40 +02007372 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_group_id(pk);
7373 if (grp_id == MBEDTLS_ECP_DP_NONE) {
7374 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007376 }
Valerio Setti97207782023-05-18 18:59:06 +02007377 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007378 ssl->session_negotiate->verify_result |=
7379 MBEDTLS_X509_BADCERT_BAD_KEY;
7380
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
7382 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007383 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07007385 }
Jerry Yud9526692022-02-17 14:23:47 +08007386 }
7387 }
Valerio Settiacd32c02023-06-29 18:06:29 +02007388#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Jerry Yud9526692022-02-17 14:23:47 +08007389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 if (mbedtls_ssl_check_cert_usage(chain,
7391 ciphersuite_info,
7392 !ssl->conf->endpoint,
7393 &ssl->session_negotiate->verify_result) != 0) {
7394 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
7395 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007396 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 }
Jerry Yud9526692022-02-17 14:23:47 +08007398 }
7399
7400 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
7401 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
7402 * with details encoded in the verification flags. All other kinds
7403 * of error codes, including those from the user provided f_vrfy
7404 * functions, are treated as fatal and lead to a failure of
7405 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
7407 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
7408 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08007409 ret = 0;
7410 }
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
7413 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08007414 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
7415 }
7416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007418 uint8_t alert;
7419
7420 /* The certificate may have been rejected for several reasons.
7421 Pick one and send the corresponding alert. Which alert to send
7422 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08007424 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08007426 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007428 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08007430 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08007432 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08007434 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08007436 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08007438 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08007440 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08007442 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 } else {
Jerry Yud9526692022-02-17 14:23:47 +08007444 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 }
7446 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7447 alert);
Jerry Yud9526692022-02-17 14:23:47 +08007448 }
7449
7450#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (ssl->session_negotiate->verify_result != 0) {
7452 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
7453 (unsigned int) ssl->session_negotiate->verify_result));
7454 } else {
7455 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08007456 }
7457#endif /* MBEDTLS_DEBUG_C */
7458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007460}
7461
7462#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007464static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7465 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007466{
7467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7468 /* Remember digest of the peer's end-CRT. */
7469 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7471 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7472 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7473 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7474 mbedtls_ssl_send_alert_message(ssl,
7475 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7476 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007479 }
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 ret = mbedtls_md(mbedtls_md_info_from_type(
7482 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7483 start, len,
7484 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007485
7486 ssl->session_negotiate->peer_cert_digest_type =
7487 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7488 ssl->session_negotiate->peer_cert_digest_len =
7489 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007492}
7493
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007495static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7496 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007497{
7498 unsigned char *end = start + len;
7499 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7500
7501 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7503 ret = mbedtls_pk_parse_subpubkey(&start, end,
7504 &ssl->handshake->peer_pubkey);
7505 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007506 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007508 }
7509
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007511}
7512#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007515{
7516 int ret = 0;
7517 int crt_expected;
7518#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7519 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7520 ? ssl->handshake->sni_authmode
7521 : ssl->conf->authmode;
7522#else
7523 const int authmode = ssl->conf->authmode;
7524#endif
7525 void *rs_ctx = NULL;
7526 mbedtls_x509_crt *chain = NULL;
7527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007529
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7531 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7532 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007533 goto exit;
7534 }
7535
7536#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 if (ssl->handshake->ecrs_enabled &&
7538 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007539 chain = ssl->handshake->ecrs_peer_cert;
7540 ssl->handshake->ecrs_peer_cert = NULL;
7541 goto crt_verify;
7542 }
7543#endif
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007546 /* mbedtls_ssl_read_record may have sent an alert already. We
7547 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007549 goto exit;
7550 }
7551
7552#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007554 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7555
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007557 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 }
Jerry Yud9526692022-02-17 14:23:47 +08007559
7560 goto exit;
7561 }
7562#endif /* MBEDTLS_SSL_SRV_C */
7563
7564 /* Clear existing peer CRT structure in case we tried to
7565 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7569 if (chain == NULL) {
7570 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7571 sizeof(mbedtls_x509_crt)));
7572 mbedtls_ssl_send_alert_message(ssl,
7573 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7574 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007575
7576 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7577 goto exit;
7578 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007580
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 ret = ssl_parse_certificate_chain(ssl, chain);
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_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007588 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 }
Jerry Yud9526692022-02-17 14:23:47 +08007590
7591crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007593 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 }
Jerry Yud9526692022-02-17 14:23:47 +08007595#endif
7596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 ret = ssl_parse_certificate_verify(ssl, authmode,
7598 chain, rs_ctx);
7599 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 }
Jerry Yud9526692022-02-17 14:23:47 +08007602
7603#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7604 {
7605 unsigned char *crt_start, *pk_start;
7606 size_t crt_len, pk_len;
7607
7608 /* We parse the CRT chain without copying, so
7609 * these pointers point into the input buffer,
7610 * and are hence still valid after freeing the
7611 * CRT chain. */
7612
7613 crt_start = chain->raw.p;
7614 crt_len = chain->raw.len;
7615
7616 pk_start = chain->pk_raw.p;
7617 pk_len = chain->pk_raw.len;
7618
7619 /* Free the CRT structures before computing
7620 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 mbedtls_x509_crt_free(chain);
7622 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007623 chain = NULL;
7624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7626 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yud9526692022-02-17 14:23:47 +08007629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7631 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007632 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 }
Jerry Yud9526692022-02-17 14:23:47 +08007634 }
7635#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7636 /* Pass ownership to session structure. */
7637 ssl->session_negotiate->peer_cert = chain;
7638 chain = NULL;
7639#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007642
7643exit:
7644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007646 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648
7649#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007651 ssl->handshake->ecrs_peer_cert = chain;
7652 chain = NULL;
7653 }
7654#endif
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (chain != NULL) {
7657 mbedtls_x509_crt_free(chain);
7658 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007659 }
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007662}
7663#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7664
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007665static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7666 unsigned char *padbuf, size_t hlen,
7667 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007668{
7669 int len = 12;
7670 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007671#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007672 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007673 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007674 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007675 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007676#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007678 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007679 mbedtls_md_context_t cloned_ctx;
7680 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007681#endif
7682
7683 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007685 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007687
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007689 ? "client finished"
7690 : "server finished";
7691
7692#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007693 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007694
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007695 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007697 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007698 }
7699
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007700 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007702 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007703 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007704 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007705#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007706 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007707
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007708 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007709 if (ret != 0) {
7710 goto exit;
7711 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007712 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01007713 if (ret != 0) {
7714 goto exit;
7715 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007716
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007717 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007718 if (ret != 0) {
7719 goto exit;
7720 }
7721#endif /* MBEDTLS_USE_PSA_CRYPTO */
7722
7723 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7724
Jerry Yu615bd6f2022-02-17 14:25:15 +08007725 /*
7726 * TLSv1.2:
7727 * hash = PRF( master, finished_label,
7728 * Hash( handshake ) )[0.11]
7729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007731 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007734
Paul Elliottecb95be2023-08-11 16:41:04 +01007735 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007736
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007738
7739exit:
7740#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007741 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007742 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007743#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007744 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007745 return ret;
7746#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08007747}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007748
7749#if defined(MBEDTLS_MD_CAN_SHA256)
7750static int ssl_calc_finished_tls_sha256(
7751 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7752{
7753 unsigned char padbuf[32];
7754 return ssl_calc_finished_tls_generic(ssl,
7755#if defined(MBEDTLS_USE_PSA_CRYPTO)
7756 &ssl->handshake->fin_sha256_psa,
7757#else
7758 &ssl->handshake->fin_sha256,
7759#endif
7760 padbuf, sizeof(padbuf),
7761 buf, from);
7762}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007763#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007764
Jerry Yub7ba49e2022-02-17 14:25:53 +08007765
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007766#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007767static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007769{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007770 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007771 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007772#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007773 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007774#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007775 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08007776#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007777 padbuf, sizeof(padbuf),
7778 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007779}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007780#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007781
Gilles Peskine449bd832023-01-11 14:50:10 +01007782void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007783{
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007785
7786 /*
7787 * Free our handshake params
7788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 mbedtls_ssl_handshake_free(ssl);
7790 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007791 ssl->handshake = NULL;
7792
7793 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007794 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007795 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 if (ssl->transform) {
7797 mbedtls_ssl_transform_free(ssl->transform);
7798 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007799 }
7800 ssl->transform = ssl->transform_negotiate;
7801 ssl->transform_negotiate = NULL;
7802
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007804}
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007807{
7808 int resume = ssl->handshake->resume;
7809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007811
7812#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007814 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7815 ssl->renego_records_seen = 0;
7816 }
7817#endif
7818
7819 /*
7820 * Free the previous session and switch in the current one
7821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007823#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7824 /* RFC 7366 3.1: keep the EtM state */
7825 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007827#endif
7828
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 mbedtls_ssl_session_free(ssl->session);
7830 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007831 }
7832 ssl->session = ssl->session_negotiate;
7833 ssl->session_negotiate = NULL;
7834
7835 /*
7836 * Add cache entry
7837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007839 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 resume == 0) {
7841 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7842 ssl->session->id,
7843 ssl->session->id_len,
7844 ssl->session) != 0) {
7845 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7846 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007847 }
7848
7849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7851 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007852 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007854
7855 /* Keep last flight around in case we need to resend it:
7856 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7858 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007859#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007861
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007862 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007863
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007865}
7866
Gilles Peskine449bd832023-01-11 14:50:10 +01007867int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007868{
7869 int ret, hash_len;
7870
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007872
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007874
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007875 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7876 if (ret != 0) {
7877 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7878 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007879
7880 /*
7881 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7882 * may define some other value. Currently (early 2016), no defined
7883 * ciphersuite does this (and this is unlikely to change as activity has
7884 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7885 */
7886 hash_len = 12;
7887
7888#if defined(MBEDTLS_SSL_RENEGOTIATION)
7889 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007891#endif
7892
7893 ssl->out_msglen = 4 + hash_len;
7894 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7895 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7896
7897 /*
7898 * In case of session resuming, invert the client and server
7899 * ChangeCipherSpec messages order.
7900 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007902#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007904 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007906#endif
7907#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007909 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007911#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007913 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007915
7916 /*
7917 * Switch to our negotiated transform and session parameters for outbound
7918 * data.
7919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007921
7922#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007924 unsigned char i;
7925
7926 /* Remember current epoch settings for resending */
7927 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7929 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007930
7931 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007933
7934
7935 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 for (i = 2; i > 0; i--) {
7937 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007938 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 }
7940 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007941
7942 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (i == 0) {
7944 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7945 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007946 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007948#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007950
7951 ssl->transform_out = ssl->transform_negotiate;
7952 ssl->session_out = ssl->session_negotiate;
7953
7954#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7956 mbedtls_ssl_send_flight_completed(ssl);
7957 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007958#endif
7959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7961 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7962 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007963 }
7964
7965#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7967 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7968 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7969 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007970 }
7971#endif
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007976}
7977
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007978#define SSL_MAX_HASH_LEN 12
7979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007981{
7982 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7983 unsigned int hash_len = 12;
7984 unsigned char buf[SSL_MAX_HASH_LEN];
7985
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007987
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007988 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7989 if (ret != 0) {
7990 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7991 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7994 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007995 goto exit;
7996 }
7997
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7999 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8000 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8001 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008002 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8003 goto exit;
8004 }
8005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8007 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8008 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008009 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8010 goto exit;
8011 }
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8014 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8015 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8016 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008017 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8018 goto exit;
8019 }
8020
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8022 buf, hash_len) != 0) {
8023 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8024 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8025 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008026 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8027 goto exit;
8028 }
8029
8030#if defined(MBEDTLS_SSL_RENEGOTIATION)
8031 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008033#endif
8034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008036#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008038 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008040#endif
8041#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008043 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008045#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008047 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008049
8050#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8052 mbedtls_ssl_recv_flight_completed(ssl);
8053 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008054#endif
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008057
8058exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 mbedtls_platform_zeroize(buf, hash_len);
8060 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008061}
8062
Jerry Yu392112c2022-02-17 14:34:10 +08008063#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8064/*
8065 * Helper to get TLS 1.2 PRF from ciphersuite
8066 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008068static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008069{
Jerry Yu392112c2022-02-17 14:34:10 +08008070 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008072#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8074 return tls_prf_sha384;
8075 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008076#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008077#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008078 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8080 return tls_prf_sha256;
8081 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008082 }
8083#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008084#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8085 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008086 (void) ciphersuite_info;
8087#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008090}
8091#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008094{
8095 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008096#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if (tls_prf == tls_prf_sha384) {
8098 return MBEDTLS_SSL_TLS_PRF_SHA384;
8099 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008100#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008101#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 if (tls_prf == tls_prf_sha256) {
8103 return MBEDTLS_SSL_TLS_PRF_SHA256;
8104 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008105#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008107}
8108
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008109/*
8110 * Populate a transform structure with session keys and all the other
8111 * necessary information.
8112 *
8113 * Parameters:
8114 * - [in/out]: transform: structure to populate
8115 * [in] must be just initialised with mbedtls_ssl_transform_init()
8116 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8117 * - [in] ciphersuite
8118 * - [in] master
8119 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008120 * - [in] tls_prf: pointer to PRF to use for key derivation
8121 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008122 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008123 * - [in] endpoint: client or server
8124 * - [in] ssl: used for:
8125 * - ssl->conf->{f,p}_export_keys
8126 * [in] optionally used for:
8127 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8128 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008130static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8131 int ciphersuite,
8132 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008133#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008135#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 ssl_tls_prf_t tls_prf,
8137 const unsigned char randbytes[64],
8138 mbedtls_ssl_protocol_version tls_version,
8139 unsigned endpoint,
8140 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008141{
8142 int ret = 0;
8143 unsigned char keyblk[256];
8144 unsigned char *key1;
8145 unsigned char *key2;
8146 unsigned char *mac_enc;
8147 unsigned char *mac_dec;
8148 size_t mac_key_len = 0;
8149 size_t iv_copy_len;
8150 size_t keylen;
8151 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008152 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008153#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008154 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008155 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008156#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008157
8158#if defined(MBEDTLS_USE_PSA_CRYPTO)
8159 psa_key_type_t key_type;
8160 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8161 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008162 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008163 size_t key_bits;
8164 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8165#endif
8166
8167#if !defined(MBEDTLS_DEBUG_C) && \
8168 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 if (ssl->f_export_keys == NULL) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008170 ssl = NULL; /* make sure we don't use it except for these cases */
8171 (void) ssl;
8172 }
8173#endif
8174
8175 /*
8176 * Some data just needs copying into the structure
8177 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008178#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008179 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008180#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008181 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008182
8183#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008185#endif
8186
8187#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008189 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8190 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008192 }
8193#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8194
8195 /*
8196 * Get various info structures
8197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8199 if (ciphersuite_info == NULL) {
8200 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8201 ciphersuite));
8202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008203 }
8204
Neil Armstrongab555e02022-04-04 11:07:59 +02008205 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008206#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008208#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008210
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008212 transform->taglen =
8213 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008215
8216#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008217 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 transform->taglen,
8219 &alg,
8220 &key_type,
8221 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008224 goto end;
8225 }
8226#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008227 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 if (cipher_info == NULL) {
8229 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8230 ciphersuite_info->cipher));
8231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008232 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008233#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008234
Neil Armstronge4512952022-03-08 09:08:22 +01008235#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008236 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008238 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 (unsigned) ciphersuite_info->mac));
8240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008241 }
8242#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008243 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 if (md_info == NULL) {
8245 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8246 (unsigned) ciphersuite_info->mac));
8247 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008248 }
Neil Armstronge4512952022-03-08 09:08:22 +01008249#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008250
8251#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8252 /* Copy own and peer's CID if the use of the CID
8253 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8255 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008256
8257 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8259 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8260 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008261
8262 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8264 ssl->handshake->peer_cid_len);
8265 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8266 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008267 }
8268#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8269
8270 /*
8271 * Compute key block using the PRF
8272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8274 if (ret != 0) {
8275 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8276 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008277 }
8278
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8280 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8281 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8282 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8283 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008284
8285 /*
8286 * Determine the appropriate key, IV and MAC length.
8287 */
8288
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008289#if defined(MBEDTLS_USE_PSA_CRYPTO)
8290 keylen = PSA_BITS_TO_BYTES(key_bits);
8291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008293#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008294
Valerio Settie5707042023-10-11 11:54:42 +02008295#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008297 size_t explicit_ivlen;
8298
8299 transform->maclen = 0;
8300 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008301
8302 /* All modes haves 96-bit IVs, but the length of the static parts vary
8303 * with mode and version:
8304 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8305 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8306 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8307 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8308 * sequence number).
8309 */
8310 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008311
8312 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008313#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008315#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8317 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008318#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008319
Gilles Peskine449bd832023-01-11 14:50:10 +01008320 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008321 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008323 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008325
8326 /* Minimum length of encrypted record */
8327 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8328 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 } else
Valerio Settie5707042023-10-11 11:54:42 +02008330#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008331#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008333 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008335#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008337#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008338 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008339#endif /* MBEDTLS_USE_PSA_CRYPTO */
8340
8341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008342 /* Get MAC length */
8343 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8344#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008345 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8347 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8348 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008349 goto end;
8350 }
8351
8352 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008354#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008355 transform->maclen = mac_key_len;
8356
8357 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008358#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008360#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008361 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008362#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008363
8364 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008366 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008368 /*
8369 * GenericBlockCipher:
8370 * 1. if EtM is in use: one block plus MAC
8371 * otherwise: * first multiple of blocklen greater than maclen
8372 * 2. IV
8373 */
8374#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008376 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 + block_size;
8378 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008379#endif
8380 {
8381 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 + block_size
8383 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008384 }
8385
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008387 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 } else {
8389 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008390 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8391 goto end;
8392 }
8393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008395#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8396 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008397 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8398 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008399 }
8400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8402 (unsigned) keylen,
8403 (unsigned) transform->minlen,
8404 (unsigned) transform->ivlen,
8405 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008406
8407 /*
8408 * Finally setup the cipher contexts, IVs and MAC secrets.
8409 */
8410#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008411 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008412 key1 = keyblk + mac_key_len * 2;
8413 key2 = keyblk + mac_key_len * 2 + keylen;
8414
8415 mac_enc = keyblk;
8416 mac_dec = keyblk + mac_key_len;
8417
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 iv_copy_len = (transform->fixed_ivlen) ?
8419 transform->fixed_ivlen : transform->ivlen;
8420 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8421 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8422 iv_copy_len);
8423 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008424#endif /* MBEDTLS_SSL_CLI_C */
8425#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008427 key1 = keyblk + mac_key_len * 2 + keylen;
8428 key2 = keyblk + mac_key_len * 2;
8429
8430 mac_enc = keyblk + mac_key_len;
8431 mac_dec = keyblk;
8432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 iv_copy_len = (transform->fixed_ivlen) ?
8434 transform->fixed_ivlen : transform->ivlen;
8435 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8436 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8437 iv_copy_len);
8438 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008439#endif /* MBEDTLS_SSL_SRV_C */
8440 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008442 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8443 goto end;
8444 }
8445
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 if (ssl != NULL && ssl->f_export_keys != NULL) {
8447 ssl->f_export_keys(ssl->p_export_keys,
8448 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8449 master, 48,
8450 randbytes + 32,
8451 randbytes,
8452 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008453 }
8454
8455#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008456 transform->psa_alg = alg;
8457
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8459 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8460 psa_set_key_algorithm(&attributes, alg);
8461 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008462
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 if ((status = psa_import_key(&attributes,
8464 key1,
8465 PSA_BITS_TO_BYTES(key_bits),
8466 &transform->psa_key_enc)) != PSA_SUCCESS) {
8467 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008468 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008470 goto end;
8471 }
8472
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 if ((status = psa_import_key(&attributes,
8476 key2,
8477 PSA_BITS_TO_BYTES(key_bits),
8478 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008479 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008481 goto end;
8482 }
8483 }
8484#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8486 cipher_info)) != 0) {
8487 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008488 goto end;
8489 }
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8492 cipher_info)) != 0) {
8493 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008494 goto end;
8495 }
8496
Gilles Peskine449bd832023-01-11 14:50:10 +01008497 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8498 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8499 MBEDTLS_ENCRYPT)) != 0) {
8500 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008501 goto end;
8502 }
8503
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8505 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8506 MBEDTLS_DECRYPT)) != 0) {
8507 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008508 goto end;
8509 }
8510
8511#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8513 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8514 MBEDTLS_PADDING_NONE)) != 0) {
8515 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008516 goto end;
8517 }
8518
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8520 MBEDTLS_PADDING_NONE)) != 0) {
8521 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008522 goto end;
8523 }
8524 }
8525#endif /* MBEDTLS_CIPHER_MODE_CBC */
8526#endif /* MBEDTLS_USE_PSA_CRYPTO */
8527
Neil Armstrong29c0c042022-03-17 17:47:28 +01008528#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8529 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8530 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008532#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008534
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8536 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8537 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if ((status = psa_import_key(&attributes,
8540 mac_enc, mac_key_len,
8541 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008542 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008544 goto end;
8545 }
8546
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8548 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008549#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008551#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008553 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8555 PSA_KEY_USAGE_VERIFY_HASH);
8556 } else {
8557 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8558 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if ((status = psa_import_key(&attributes,
8561 mac_dec, mac_key_len,
8562 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008563 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008564 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008565 goto end;
8566 }
8567#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8569 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008570 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 }
8572 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8573 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008574 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008576#endif /* MBEDTLS_USE_PSA_CRYPTO */
8577 }
8578#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8579
8580 ((void) mac_dec);
8581 ((void) mac_enc);
8582
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008583end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8585 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008586}
8587
Valerio Settia08b1a42022-11-17 15:10:02 +01008588#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8589 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008590int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 psa_pake_operation_t *pake_ctx,
8592 const unsigned char *buf,
8593 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008594{
8595 psa_status_t status;
8596 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008597 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008598 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8599 * At round two perform a single cycle
8600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 for (; remaining_steps > 0; remaining_steps--) {
8604 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008605 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008607 /* Length is stored at the first byte */
8608 size_t length = buf[input_offset];
8609 input_offset += 1;
8610
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008612 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8613 }
8614
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 status = psa_pake_input(pake_ctx, step,
8616 buf + input_offset, length);
8617 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008618 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008619 }
8620
8621 input_offset += length;
8622 }
8623 }
8624
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008626 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008628
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008630}
8631
Valerio Setti6b3dab02022-11-17 17:14:54 +01008632int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 psa_pake_operation_t *pake_ctx,
8634 unsigned char *buf,
8635 size_t len, size_t *olen,
8636 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008637{
8638 psa_status_t status;
8639 size_t output_offset = 0;
8640 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008641 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008642 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8643 * At round two perform a single cycle
8644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008646
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 for (; remaining_steps > 0; remaining_steps--) {
8648 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8649 step <= PSA_PAKE_STEP_ZK_PROOF;
8650 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008651 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008652 * For each step, prepend 1 byte with the length of the data as
8653 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 status = psa_pake_output(pake_ctx, step,
8656 buf + output_offset + 1,
8657 len - output_offset - 1,
8658 &output_len);
8659 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008660 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008661 }
8662
Valerio Setti99d88c12022-11-22 16:03:43 +01008663 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008664
8665 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008666 }
8667 }
8668
8669 *olen = output_offset;
8670
Gilles Peskine449bd832023-01-11 14:50:10 +01008671 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008672}
Valerio Settia08b1a42022-11-17 15:10:02 +01008673#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
8674
Jerry Yuee40f9d2022-02-17 14:55:16 +08008675#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008676int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8677 unsigned char *hash, size_t *hashlen,
8678 unsigned char *data, size_t data_len,
8679 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008680{
8681 psa_status_t status;
8682 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008683 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008686
Gilles Peskine449bd832023-01-11 14:50:10 +01008687 if ((status = psa_hash_setup(&hash_operation,
8688 hash_alg)) != PSA_SUCCESS) {
8689 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008690 goto exit;
8691 }
8692
Gilles Peskine449bd832023-01-11 14:50:10 +01008693 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8694 64)) != PSA_SUCCESS) {
8695 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008696 goto exit;
8697 }
8698
Gilles Peskine449bd832023-01-11 14:50:10 +01008699 if ((status = psa_hash_update(&hash_operation,
8700 data, data_len)) != PSA_SUCCESS) {
8701 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008702 goto exit;
8703 }
8704
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8706 hashlen)) != PSA_SUCCESS) {
8707 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8708 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008709 }
8710
8711exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 if (status != PSA_SUCCESS) {
8713 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8714 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8715 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008716 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008718 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8719 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008721 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008723 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008725 }
8726 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008727 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008728}
8729
8730#else
8731
Gilles Peskine449bd832023-01-11 14:50:10 +01008732int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8733 unsigned char *hash, size_t *hashlen,
8734 unsigned char *data, size_t data_len,
8735 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008736{
8737 int ret = 0;
8738 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
8740 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008741
Gilles Peskine449bd832023-01-11 14:50:10 +01008742 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008743
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008745
8746 /*
8747 * digitally-signed struct {
8748 * opaque client_random[32];
8749 * opaque server_random[32];
8750 * ServerDHParams params;
8751 * };
8752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
8754 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008755 goto exit;
8756 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008757 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
8758 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008759 goto exit;
8760 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008761 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
8762 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008763 goto exit;
8764 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
8766 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008767 goto exit;
8768 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
8770 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008771 goto exit;
8772 }
8773
8774exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008776
Gilles Peskine449bd832023-01-11 14:50:10 +01008777 if (ret != 0) {
8778 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8779 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8780 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08008781
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008783}
8784#endif /* MBEDTLS_USE_PSA_CRYPTO */
8785
Jerry Yud9d91da2022-02-17 14:57:06 +08008786#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8787
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008788/* Find the preferred hash for a given signature algorithm. */
8789unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 mbedtls_ssl_context *ssl,
8791 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008792{
Gabor Mezei078e8032022-04-27 21:17:56 +02008793 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008794 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008795
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8797 return MBEDTLS_SSL_HASH_NONE;
8798 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008799
Gilles Peskine449bd832023-01-11 14:50:10 +01008800 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008801 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008802 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8803 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008804 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8806 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008807
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008808 mbedtls_md_type_t md_alg =
8809 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8810 if (md_alg == MBEDTLS_MD_NONE) {
8811 continue;
8812 }
8813
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008815#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008816 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008817 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008818 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008819
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8821 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8822 PSA_ALG_ECDSA(psa_hash_alg),
8823 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008824 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008825 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008826
Gilles Peskine449bd832023-01-11 14:50:10 +01008827 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8828 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8829 PSA_ALG_RSA_PKCS1V15_SIGN(
8830 psa_hash_alg),
8831 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008832 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008834 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008835#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02008836
Gilles Peskine449bd832023-01-11 14:50:10 +01008837 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008838 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008839 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008840
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008842}
8843
8844#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8845
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008846/* Serialization of TLS 1.2 sessions:
8847 *
8848 * struct {
8849 * uint64 start_time;
8850 * uint8 ciphersuite[2]; // defined by the standard
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008851 * uint8 session_id_len; // at most 32
8852 * opaque session_id[32];
8853 * opaque master[48]; // fixed length in the standard
8854 * uint32 verify_result;
8855 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
8856 * opaque ticket<0..2^24-1>; // length 0 means no ticket
8857 * uint32 ticket_lifetime;
8858 * uint8 mfl_code; // up to 255 according to standard
8859 * uint8 encrypt_then_mac; // 0 or 1
8860 * } serialized_session_tls12;
8861 *
8862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008863static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
8864 unsigned char *buf,
8865 size_t buf_len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008866{
8867 unsigned char *p = buf;
8868 size_t used = 0;
8869
8870#if defined(MBEDTLS_HAVE_TIME)
8871 uint64_t start;
8872#endif
8873#if defined(MBEDTLS_X509_CRT_PARSE_C)
8874#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8875 size_t cert_len;
8876#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8877#endif /* MBEDTLS_X509_CRT_PARSE_C */
8878
8879 /*
8880 * Time
8881 */
8882#if defined(MBEDTLS_HAVE_TIME)
8883 used += 8;
8884
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008886 start = (uint64_t) session->start;
8887
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 MBEDTLS_PUT_UINT64_BE(start, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008889 p += 8;
8890 }
8891#endif /* MBEDTLS_HAVE_TIME */
8892
8893 /*
8894 * Basic mandatory fields
8895 */
8896 used += 2 /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01008897 + 1 /* id_len */
8898 + sizeof(session->id)
8899 + sizeof(session->master)
8900 + 4; /* verify_result */
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008901
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 if (used <= buf_len) {
8903 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008904 p += 2;
8905
Gilles Peskine449bd832023-01-11 14:50:10 +01008906 *p++ = MBEDTLS_BYTE_0(session->id_len);
8907 memcpy(p, session->id, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008908 p += 32;
8909
Gilles Peskine449bd832023-01-11 14:50:10 +01008910 memcpy(p, session->master, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008911 p += 48;
8912
Gilles Peskine449bd832023-01-11 14:50:10 +01008913 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008914 p += 4;
8915 }
8916
8917 /*
8918 * Peer's end-entity certificate
8919 */
8920#if defined(MBEDTLS_X509_CRT_PARSE_C)
8921#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 if (session->peer_cert == NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008923 cert_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008925 cert_len = session->peer_cert->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008927
8928 used += 3 + cert_len;
8929
Gilles Peskine449bd832023-01-11 14:50:10 +01008930 if (used <= buf_len) {
8931 *p++ = MBEDTLS_BYTE_2(cert_len);
8932 *p++ = MBEDTLS_BYTE_1(cert_len);
8933 *p++ = MBEDTLS_BYTE_0(cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008934
Gilles Peskine449bd832023-01-11 14:50:10 +01008935 if (session->peer_cert != NULL) {
8936 memcpy(p, session->peer_cert->raw.p, cert_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008937 p += cert_len;
8938 }
8939 }
8940#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01008941 if (session->peer_cert_digest != NULL) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008942 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008944 *p++ = (unsigned char) session->peer_cert_digest_type;
8945 *p++ = (unsigned char) session->peer_cert_digest_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008946 memcpy(p, session->peer_cert_digest,
8947 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008948 p += session->peer_cert_digest_len;
8949 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008950 } else {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008951 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008953 *p++ = (unsigned char) MBEDTLS_MD_NONE;
8954 *p++ = 0;
8955 }
8956 }
8957#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8958#endif /* MBEDTLS_X509_CRT_PARSE_C */
8959
8960 /*
8961 * Session ticket if any, plus associated data
8962 */
8963#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
8964 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
8965
Gilles Peskine449bd832023-01-11 14:50:10 +01008966 if (used <= buf_len) {
8967 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
8968 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
8969 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008970
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 if (session->ticket != NULL) {
8972 memcpy(p, session->ticket, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008973 p += session->ticket_len;
8974 }
8975
Gilles Peskine449bd832023-01-11 14:50:10 +01008976 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008977 p += 4;
8978 }
8979#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
8980
8981 /*
8982 * Misc extension-related info
8983 */
8984#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
8985 used += 1;
8986
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 if (used <= buf_len) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008988 *p++ = session->mfl_code;
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008990#endif
8991
8992#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8993 used += 1;
8994
Gilles Peskine449bd832023-01-11 14:50:10 +01008995 if (used <= buf_len) {
8996 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
8997 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08008998#endif
8999
Gilles Peskine449bd832023-01-11 14:50:10 +01009000 return used;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009001}
9002
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02009003MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009004static int ssl_tls12_session_load(mbedtls_ssl_session *session,
9005 const unsigned char *buf,
9006 size_t len)
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009007{
9008#if defined(MBEDTLS_HAVE_TIME)
9009 uint64_t start;
9010#endif
9011#if defined(MBEDTLS_X509_CRT_PARSE_C)
9012#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9013 size_t cert_len;
9014#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9015#endif /* MBEDTLS_X509_CRT_PARSE_C */
9016
9017 const unsigned char *p = buf;
9018 const unsigned char * const end = buf + len;
9019
9020 /*
9021 * Time
9022 */
9023#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 if (8 > (size_t) (end - p)) {
9025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9026 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009027
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009028 start = MBEDTLS_GET_UINT64_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009029 p += 8;
9030
9031 session->start = (time_t) start;
9032#endif /* MBEDTLS_HAVE_TIME */
9033
9034 /*
9035 * Basic mandatory fields
9036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009037 if (2 + 1 + 32 + 48 + 4 > (size_t) (end - p)) {
9038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9039 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009040
Gilles Peskine449bd832023-01-11 14:50:10 +01009041 session->ciphersuite = (p[0] << 8) | p[1];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009042 p += 2;
9043
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009044 session->id_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 memcpy(session->id, p, 32);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009046 p += 32;
9047
Gilles Peskine449bd832023-01-11 14:50:10 +01009048 memcpy(session->master, p, 48);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009049 p += 48;
9050
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009051 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009052 p += 4;
9053
9054 /* Immediately clear invalid pointer values that have been read, in case
9055 * we exit early before we replaced them with valid ones. */
9056#if defined(MBEDTLS_X509_CRT_PARSE_C)
9057#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9058 session->peer_cert = NULL;
9059#else
9060 session->peer_cert_digest = NULL;
9061#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9062#endif /* MBEDTLS_X509_CRT_PARSE_C */
9063#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
9064 session->ticket = NULL;
9065#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9066
9067 /*
9068 * Peer certificate
9069 */
9070#if defined(MBEDTLS_X509_CRT_PARSE_C)
9071#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
9072 /* Deserialize CRT from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 if (3 > (size_t) (end - p)) {
9074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9075 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 cert_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009078 p += 3;
9079
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 if (cert_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 if (cert_len > (size_t) (end - p)) {
9084 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9085 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009086
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009088
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 if (session->peer_cert == NULL) {
9090 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9091 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009092
Gilles Peskine449bd832023-01-11 14:50:10 +01009093 mbedtls_x509_crt_init(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009094
Gilles Peskine449bd832023-01-11 14:50:10 +01009095 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
9096 p, cert_len)) != 0) {
9097 mbedtls_x509_crt_free(session->peer_cert);
9098 mbedtls_free(session->peer_cert);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009099 session->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 return ret;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009101 }
9102
9103 p += cert_len;
9104 }
9105#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9106 /* Deserialize CRT digest from the end of the ticket. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 if (2 > (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_type = (mbedtls_md_type_t) *p++;
9112 session->peer_cert_digest_len = (size_t) *p++;
9113
Gilles Peskine449bd832023-01-11 14:50:10 +01009114 if (session->peer_cert_digest_len != 0) {
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009115 const mbedtls_md_info_t *md_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 mbedtls_md_info_from_type(session->peer_cert_digest_type);
9117 if (md_info == NULL) {
9118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9119 }
9120 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
9121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9122 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009123
Gilles Peskine449bd832023-01-11 14:50:10 +01009124 if (session->peer_cert_digest_len > (size_t) (end - p)) {
9125 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9126 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009127
9128 session->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 mbedtls_calloc(1, session->peer_cert_digest_len);
9130 if (session->peer_cert_digest == NULL) {
9131 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9132 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009133
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 memcpy(session->peer_cert_digest, p,
9135 session->peer_cert_digest_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009136 p += session->peer_cert_digest_len;
9137 }
9138#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
9139#endif /* MBEDTLS_X509_CRT_PARSE_C */
9140
9141 /*
9142 * Session ticket and associated data
9143 */
9144#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 if (3 > (size_t) (end - p)) {
9146 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9147 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 session->ticket_len = (p[0] << 16) | (p[1] << 8) | p[2];
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009150 p += 3;
9151
Gilles Peskine449bd832023-01-11 14:50:10 +01009152 if (session->ticket_len != 0) {
9153 if (session->ticket_len > (size_t) (end - p)) {
9154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9155 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009156
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 session->ticket = mbedtls_calloc(1, session->ticket_len);
9158 if (session->ticket == NULL) {
9159 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9160 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 memcpy(session->ticket, p, session->ticket_len);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009163 p += session->ticket_len;
9164 }
9165
Gilles Peskine449bd832023-01-11 14:50:10 +01009166 if (4 > (size_t) (end - p)) {
9167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9168 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009169
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01009170 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009171 p += 4;
9172#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
9173
9174 /*
9175 * Misc extension-related info
9176 */
9177#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 if (1 > (size_t) (end - p)) {
9179 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9180 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009181
9182 session->mfl_code = *p++;
9183#endif
9184
9185#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (1 > (size_t) (end - p)) {
9187 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9188 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009189
9190 session->encrypt_then_mac = *p++;
9191#endif
9192
9193 /* Done, should have consumed entire buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 if (p != end) {
9195 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9196 }
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009197
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 return 0;
Jerry Yu4f9e3ef2022-02-17 14:58:27 +08009199}
Jerry Yudc7bd172022-02-17 13:44:15 +08009200#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9201
XiaokangQian75d40ef2022-04-20 11:05:24 +00009202int mbedtls_ssl_validate_ciphersuite(
9203 const mbedtls_ssl_context *ssl,
9204 const mbedtls_ssl_ciphersuite_t *suite_info,
9205 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009206 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009207{
9208 (void) ssl;
9209
Gilles Peskine449bd832023-01-11 14:50:10 +01009210 if (suite_info == NULL) {
9211 return -1;
9212 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009213
Gilles Peskine449bd832023-01-11 14:50:10 +01009214 if ((suite_info->min_tls_version > max_tls_version) ||
9215 (suite_info->max_tls_version < min_tls_version)) {
9216 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009217 }
9218
XiaokangQian060d8672022-04-21 09:24:56 +00009219#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009220#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009221#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009222 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9223 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009224#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9226 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009227#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009228 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009230 }
9231#endif
9232
9233 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9234#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9236 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9237 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009238 }
9239#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9240#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9241
Gilles Peskine449bd832023-01-11 14:50:10 +01009242 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009243}
9244
Ronald Crone68ab4f2022-10-05 12:46:29 +02009245#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009246/*
9247 * Function for writing a signature algorithm extension.
9248 *
9249 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9250 * value (TLS 1.3 RFC8446):
9251 * enum {
9252 * ....
9253 * ecdsa_secp256r1_sha256( 0x0403 ),
9254 * ecdsa_secp384r1_sha384( 0x0503 ),
9255 * ecdsa_secp521r1_sha512( 0x0603 ),
9256 * ....
9257 * } SignatureScheme;
9258 *
9259 * struct {
9260 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9261 * } SignatureSchemeList;
9262 *
9263 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9264 * value (TLS 1.2 RFC5246):
9265 * enum {
9266 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9267 * sha512(6), (255)
9268 * } HashAlgorithm;
9269 *
9270 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9271 * SignatureAlgorithm;
9272 *
9273 * struct {
9274 * HashAlgorithm hash;
9275 * SignatureAlgorithm signature;
9276 * } SignatureAndHashAlgorithm;
9277 *
9278 * SignatureAndHashAlgorithm
9279 * supported_signature_algorithms<2..2^16-2>;
9280 *
9281 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9282 * generalization of the TLS 1.2 signature algorithm extension.
9283 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9284 * `SignatureScheme` field of TLS 1.3
9285 *
9286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009287int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9288 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009289{
9290 unsigned char *p = buf;
9291 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9292 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9293
9294 *out_len = 0;
9295
Gilles Peskine449bd832023-01-11 14:50:10 +01009296 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009297
9298 /* Check if we have space for header and length field:
9299 * - extension_type (2 bytes)
9300 * - extension_data_length (2 bytes)
9301 * - supported_signature_algorithms_length (2 bytes)
9302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009303 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009304 p += 6;
9305
9306 /*
9307 * Write supported_signature_algorithms
9308 */
9309 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9311 if (sig_alg == NULL) {
9312 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9313 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009314
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9316 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9317 *sig_alg,
9318 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9319 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009320 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 }
9322 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9323 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009324 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009325 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9326 *sig_alg,
9327 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009328 }
9329
9330 /* Length of supported_signature_algorithms */
9331 supported_sig_alg_len = p - supported_sig_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01009332 if (supported_sig_alg_len == 0) {
9333 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009335 }
9336
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9338 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9339 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009340
XiaokangQianeaf36512022-04-24 09:07:44 +00009341 *out_len = p - buf;
9342
9343#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009345#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009346
Gilles Peskine449bd832023-01-11 14:50:10 +01009347 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009348}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009349#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009350
XiaokangQian40a35232022-05-07 09:02:40 +00009351#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009352/*
9353 * mbedtls_ssl_parse_server_name_ext
9354 *
9355 * Structure of server_name extension:
9356 *
9357 * enum {
9358 * host_name(0), (255)
9359 * } NameType;
9360 * opaque HostName<1..2^16-1>;
9361 *
9362 * struct {
9363 * NameType name_type;
9364 * select (name_type) {
9365 * case host_name: HostName;
9366 * } name;
9367 * } ServerName;
9368 * struct {
9369 * ServerName server_name_list<1..2^16-1>
9370 * } ServerNameList;
9371 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009372MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009373int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9374 const unsigned char *buf,
9375 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009376{
9377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9378 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009379 size_t server_name_list_len, hostname_len;
9380 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009381
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009383
Gilles Peskine449bd832023-01-11 14:50:10 +01009384 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9385 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009386 p += 2;
9387
Gilles Peskine449bd832023-01-11 14:50:10 +01009388 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009389 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009390 while (p < server_name_list_end) {
9391 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9392 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9393 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9394 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009395
Gilles Peskine449bd832023-01-11 14:50:10 +01009396 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009397 /* sni_name is intended to be used only during the parsing of the
9398 * ClientHello message (it is reset to NULL before the end of
9399 * the message parsing). Thus it is ok to just point to the
9400 * reception buffer and not make a copy of it.
9401 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009402 ssl->handshake->sni_name = p + 3;
9403 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 if (ssl->conf->f_sni == NULL) {
9405 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009406 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9408 ssl, p + 3, hostname_len);
9409 if (ret != 0) {
9410 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9411 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9412 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9413 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9414 }
9415 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009416 }
9417
9418 p += hostname_len + 3;
9419 }
9420
Gilles Peskine449bd832023-01-11 14:50:10 +01009421 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009422}
9423#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9424
XiaokangQianacb39922022-06-17 10:18:48 +00009425#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009427int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9428 const unsigned char *buf,
9429 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009430{
9431 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009432 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009433 const unsigned char *protocol_name_list;
9434 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009435 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009436
9437 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 if (ssl->conf->alpn_list == NULL) {
9439 return 0;
9440 }
XiaokangQianacb39922022-06-17 10:18:48 +00009441
9442 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009443 * RFC7301, section 3.1
9444 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009445 *
XiaokangQianc7403452022-06-23 03:24:12 +00009446 * struct {
9447 * ProtocolName protocol_name_list<2..2^16-1>
9448 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009449 */
9450
XiaokangQianc7403452022-06-23 03:24:12 +00009451 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009452 * protocol_name_list_len 2 bytes
9453 * protocol_name_len 1 bytes
9454 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009457
Gilles Peskine449bd832023-01-11 14:50:10 +01009458 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009459 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009460 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009461 protocol_name_list = p;
9462 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009463
9464 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009466 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9468 protocol_name_len);
9469 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009470 MBEDTLS_SSL_PEND_FATAL_ALERT(
9471 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9473 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009474 }
9475
9476 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009477 }
9478
9479 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009480 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9481 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009482 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009483 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009484 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 if (protocol_name_len == alpn_len &&
9486 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009487 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009488 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009489 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009490
9491 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009492 }
9493 }
9494
XiaokangQian95d5f542022-06-24 02:29:26 +00009495 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009496 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009497 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9498 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9499 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009500}
9501
Gilles Peskine449bd832023-01-11 14:50:10 +01009502int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9503 unsigned char *buf,
9504 unsigned char *end,
9505 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009506{
9507 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009508 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009509 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009510
Gilles Peskine449bd832023-01-11 14:50:10 +01009511 if (ssl->alpn_chosen == NULL) {
9512 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009513 }
9514
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 protocol_name_len = strlen(ssl->alpn_chosen);
9516 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009517
Gilles Peskine449bd832023-01-11 14:50:10 +01009518 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009519 /*
9520 * 0 . 1 ext identifier
9521 * 2 . 3 ext length
9522 * 4 . 5 protocol list length
9523 * 6 . 6 protocol name length
9524 * 7 . 7+n protocol name
9525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009526 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009527
XiaokangQian95d5f542022-06-24 02:29:26 +00009528 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009529
Gilles Peskine449bd832023-01-11 14:50:10 +01009530 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9531 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009532 /* Note: the length of the chosen protocol has been checked to be less
9533 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009535 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009536
Gilles Peskine449bd832023-01-11 14:50:10 +01009537 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009538
9539#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009541#endif
9542
Gilles Peskine449bd832023-01-11 14:50:10 +01009543 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009544}
9545#endif /* MBEDTLS_SSL_ALPN */
9546
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009547#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009548 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009549 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009550 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009551int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9552 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009553{
9554 /* Initialize to suppress unnecessary compiler warning */
9555 size_t hostname_len = 0;
9556
9557 /* Check if new hostname is valid before
9558 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009559 if (hostname != NULL) {
9560 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009561
Gilles Peskine449bd832023-01-11 14:50:10 +01009562 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9563 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9564 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009565 }
9566
9567 /* Now it's clear that we will overwrite the old hostname,
9568 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009570 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009571 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009572 }
9573
9574 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009575 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009576 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 } else {
9578 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9579 if (session->hostname == NULL) {
9580 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9581 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009582
Gilles Peskine449bd832023-01-11 14:50:10 +01009583 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009584 }
9585
Gilles Peskine449bd832023-01-11 14:50:10 +01009586 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009587}
Xiaokang Qian03409292022-10-12 02:49:52 +00009588#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9589 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009590 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009591 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009593#endif /* MBEDTLS_SSL_TLS_C */