blob: 993c69e2266c02ec8b8ea343f4be8a9d9348ffb3 [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
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#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)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
Sam Berry9722fd12024-06-11 14:34:17 +0100135 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000241#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
242 defined(MBEDTLS_SSL_EARLY_DATA)
243 dst->ticket_alpn = NULL;
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
253 if (dst->peer_cert == NULL) {
254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
255 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
260 src->peer_cert->raw.len)) != 0) {
261 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 }
265 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000266#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_calloc(1, src->peer_cert_digest_len);
270 if (dst->peer_cert_digest == NULL) {
271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
272 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
275 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000276 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000277 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 }
279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200282
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
284 defined(MBEDTLS_SSL_EARLY_DATA)
285 {
286 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
287 if (ret != 0) {
288 return ret;
289 }
290 }
291#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
292
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (src->ticket != NULL) {
295 dst->ticket = mbedtls_calloc(1, src->ticket_len);
296 if (dst->ticket == NULL) {
297 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
298 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302
303#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
308 if (ret != 0) {
309 return ret;
310 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000311 }
312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
313 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200314#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200317}
318
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100321static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322{
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
324 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800325 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500327
328 /* We want to copy len_new bytes when downsizing the buffer, and
329 * len_old bytes when upsizing, so we choose the smaller of two sizes,
330 * to fit one buffer into another. Size checks, ensuring that no data is
331 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 memcpy(resized_buffer, *buffer,
333 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100334 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335
336 *buffer = resized_buffer;
337 *len_old = len_new;
338
339 return 0;
340}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
343 size_t in_buf_new_len,
344 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345{
346 int modified = 0;
347 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
348 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 ssl->in_buf_len < in_buf_new_len) {
356 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
357 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
358 } else {
359 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
360 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 modified = 1;
362 }
363 }
364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 written_out = ssl->out_msg - ssl->out_buf;
368 iv_offset_out = ssl->out_iv - ssl->out_buf;
369 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 ssl->out_buf_len < out_buf_new_len) {
373 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
374 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
375 } else {
376 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
377 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 modified = 1;
379 }
380 }
381 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100428#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100437#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100439#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100448#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100458#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100460#endif /* MBEDTLS_MD_CAN_SHA256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100462#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100464#endif /* MBEDTLS_MD_CAN_SHA384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100476#if defined(MBEDTLS_MD_CAN_SHA384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100480#endif /* MBEDTLS_MD_CAN_SHA384*/
481#if defined(MBEDTLS_MD_CAN_SHA256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100485#endif /* MBEDTLS_MD_CAN_SHA256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100787#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100792#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100833#if defined(MBEDTLS_MD_CAN_SHA256) || \
834 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100843#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100868#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100898#if defined(MBEDTLS_MD_CAN_SHA256) || \
899 defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100910#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100923#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100939#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100952#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100969#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100976#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001112#if defined(MBEDTLS_SSL_EARLY_DATA)
1113#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001114 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001115#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001116#if defined(MBEDTLS_SSL_SRV_C)
1117 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1118#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001119 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001120#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001121
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001122 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 mbedtls_ssl_session_init(ssl->session_negotiate);
1124 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001125
Jerry Yu2e199812022-12-01 18:57:19 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001128#endif
1129
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001130 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001131 ret = mbedtls_ssl_reset_checksum(ssl);
1132 if (ret != 0) {
1133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1134 return ret;
1135 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001136
Jerry Yud0766ec2022-09-22 10:46:57 +08001137#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1138 defined(MBEDTLS_SSL_SRV_C) && \
1139 defined(MBEDTLS_SSL_SESSION_TICKETS)
1140 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001142#endif
1143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001149 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001151 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001155 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001156#endif
1157
Brett Warrene0edc842021-08-17 09:53:13 +01001158/*
1159 * curve_list is translated to IANA TLS group identifiers here because
1160 * mbedtls_ssl_conf_curves returns void and so can't return
1161 * any error codes.
1162 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001163#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001164#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1165 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001167 size_t length;
1168 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1169
Thomas Daubney850a0792023-05-22 12:05:03 +01001170 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 }
Brett Warrene0edc842021-08-17 09:53:13 +01001172
1173 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1175 if (group_list == NULL) {
1176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1177 }
Brett Warrene0edc842021-08-17 09:53:13 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001180 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 curve_list[i]);
1182 if (tls_id == 0) {
1183 mbedtls_free(group_list);
1184 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001185 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001186 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001187 }
1188
1189 group_list[length] = 0;
1190
1191 ssl->handshake->group_list = group_list;
1192 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001194 ssl->handshake->group_list = ssl->conf->group_list;
1195 ssl->handshake->group_list_heap_allocated = 0;
1196 }
1197#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001198#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001199
Ronald Crone68ab4f2022-10-05 12:46:29 +02001200#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001201#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001203 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1204 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1206 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 const int *md;
1208 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001209 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001210 uint16_t *p;
1211
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001212 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1213 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1214 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1217 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001220#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001222#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001223
Jerry Yub476a442022-01-21 18:14:45 +08001224#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1228 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1233 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1234 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1237 sizeof(uint16_t));
1238 if (ssl->handshake->sig_algs == NULL) {
1239 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1240 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 p = (uint16_t *) ssl->handshake->sig_algs;
1243 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1244 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1245 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001248#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001251#endif
1252#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001254 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001255#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001257 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001258 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001261 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001262 ssl->handshake->sig_algs_heap_allocated = 0;
1263 }
Jerry Yucc539102022-06-27 16:27:35 +08001264#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001265#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001267}
1268
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001269#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001270/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001272static int ssl_cookie_write_dummy(void *ctx,
1273 unsigned char **p, unsigned char *end,
1274 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275{
1276 ((void) ctx);
1277 ((void) p);
1278 ((void) end);
1279 ((void) cli_id);
1280 ((void) cli_id_len);
1281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283}
1284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001286static int ssl_cookie_check_dummy(void *ctx,
1287 const unsigned char *cookie, size_t cookie_len,
1288 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289{
1290 ((void) ctx);
1291 ((void) cookie);
1292 ((void) cookie_len);
1293 ((void) cli_id);
1294 ((void) cli_id_len);
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001297}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001298#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001299
Paul Bakker5121ce52009-01-03 21:22:43 +00001300/*
1301 * Initialize an SSL context
1302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001303void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001304{
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001306}
1307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001309static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001310{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001311 const mbedtls_ssl_config *conf = ssl->conf;
1312
Ronald Cron6f135e12021-12-08 16:57:54 +01001313#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1315 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1316 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001318 }
1319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1321 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001322 }
1323#endif
1324
1325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Ronald Cron6f135e12021-12-08 16:57:54 +01001332#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1334 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1335 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1336 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001337 }
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1340 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001341 }
1342#endif
1343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1345 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001346}
1347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001348MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001349static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1350{
1351 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 ret = ssl_conf_version_check(ssl);
1353 if (ret != 0) {
1354 return ret;
1355 }
Jerry Yu60835a82021-08-04 10:13:52 +08001356
Yanray Wangb422cab2023-12-01 16:18:10 +08001357 if (ssl->conf->f_rng == NULL) {
1358 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1359 return MBEDTLS_ERR_SSL_NO_RNG;
1360 }
1361
Jerry Yu60835a82021-08-04 10:13:52 +08001362 /* Space for further checks */
1363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001365}
1366
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001367/*
1368 * Setup an SSL context
1369 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1372 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001373{
Janos Follath865b3eb2019-12-16 11:46:15 +00001374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001375 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1376 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001378 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if ((ret = ssl_conf_check(ssl)) != 0) {
1381 return ret;
1382 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001383 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001384
Paul Bakker62f2dee2012-09-28 07:31:51 +00001385 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001386 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001387 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001388
1389 /* Set to NULL in case of an error condition */
1390 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001391
Darryl Greenb33cc762019-11-28 14:29:44 +00001392#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1393 ssl->in_buf_len = in_buf_len;
1394#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1396 if (ssl->in_buf == NULL) {
1397 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001398 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001399 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001400 }
1401
Darryl Greenb33cc762019-11-28 14:29:44 +00001402#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1403 ssl->out_buf_len = out_buf_len;
1404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1406 if (ssl->out_buf == NULL) {
1407 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001408 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001409 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001410 }
1411
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001413
Johan Pascalb62bb512015-12-03 21:56:45 +01001414#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001416#endif
1417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001419 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001423
1424error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 mbedtls_free(ssl->in_buf);
1426 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001427
1428 ssl->conf = NULL;
1429
Darryl Greenb33cc762019-11-28 14:29:44 +00001430#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1431 ssl->in_buf_len = 0;
1432 ssl->out_buf_len = 0;
1433#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001434 ssl->in_buf = NULL;
1435 ssl->out_buf = NULL;
1436
1437 ssl->in_hdr = NULL;
1438 ssl->in_ctr = NULL;
1439 ssl->in_len = NULL;
1440 ssl->in_iv = NULL;
1441 ssl->in_msg = NULL;
1442
1443 ssl->out_hdr = NULL;
1444 ssl->out_ctr = NULL;
1445 ssl->out_len = NULL;
1446 ssl->out_iv = NULL;
1447 ssl->out_msg = NULL;
1448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001450}
1451
1452/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001453 * Reset an initialized and used SSL context for re-use while retaining
1454 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001455 *
1456 * If partial is non-zero, keep data in the input buffer and client ID.
1457 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001459void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1460 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001461{
Darryl Greenb33cc762019-11-28 14:29:44 +00001462#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1463 size_t in_buf_len = ssl->in_buf_len;
1464 size_t out_buf_len = ssl->out_buf_len;
1465#else
1466 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1467 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1468#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001469
Hanno Beckerb0302c42021-08-03 09:39:42 +01001470#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1471 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001472#endif
1473
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001474 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001475 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001478
1479 /* Reset incoming message parsing */
1480 ssl->in_offt = NULL;
1481 ssl->nb_zero = 0;
1482 ssl->in_msgtype = 0;
1483 ssl->in_msglen = 0;
1484 ssl->in_hslen = 0;
1485 ssl->keep_current_message = 0;
1486 ssl->transform_in = NULL;
1487
1488#if defined(MBEDTLS_SSL_PROTO_DTLS)
1489 ssl->next_record_offset = 0;
1490 ssl->in_epoch = 0;
1491#endif
1492
1493 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001495 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001497 }
1498
Ronald Cronad8c17b2022-06-10 17:18:09 +02001499 ssl->send_alert = 0;
1500
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501 /* Reset outgoing message writing */
1502 ssl->out_msgtype = 0;
1503 ssl->out_msglen = 0;
1504 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 memset(ssl->out_buf, 0, out_buf_len);
1506 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->transform_out = NULL;
1508
1509#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001511#endif
1512
XiaokangQian2b01dc32022-01-21 02:53:13 +00001513#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (ssl->transform) {
1515 mbedtls_ssl_transform_free(ssl->transform);
1516 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001517 ssl->transform = NULL;
1518 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001519#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1520
XiaokangQian2b01dc32022-01-21 02:53:13 +00001521#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_transform_free(ssl->transform_application);
1523 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001524 ssl->transform_application = NULL;
1525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001527#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1529 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001530 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001531#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1534 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001535 ssl->handshake->transform_handshake = NULL;
1536 }
1537
XiaokangQian2b01dc32022-01-21 02:53:13 +00001538#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001539}
1540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001542{
1543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1544
1545 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001546 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001547
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001549
1550 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_RENEGOTIATION)
1552 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001554
1555 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1557 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001559 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001560
Hanno Beckerb0302c42021-08-03 09:39:42 +01001561 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001562 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (ssl->session) {
1564 mbedtls_ssl_session_free(ssl->session);
1565 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001566 ssl->session = NULL;
1567 }
1568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001570 ssl->alpn_chosen = NULL;
1571#endif
1572
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001573#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001574 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001575#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001577#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 if (free_cli_id) {
1579 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001580 ssl->cli_id = NULL;
1581 ssl->cli_id_len = 0;
1582 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001583#endif
1584
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if ((ret = ssl_handshake_init(ssl)) != 0) {
1586 return ret;
1587 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001590}
1591
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001592/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001593 * Reset an initialized and used SSL context for re-use while retaining
1594 * all application-set variables, function pointers and data.
1595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001596int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001597{
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001599}
1600
1601/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 * SSL set accessors
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001606 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001607}
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001611 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001612}
1613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001615void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001616{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001617 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001618}
1619#endif
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001624}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1629 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001630{
1631 ssl->disable_datagram_packing = !allow_packing;
1632}
1633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1635 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001636{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001637 conf->hs_timeout_min = min;
1638 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001639}
1640#endif
1641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001644 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001645}
1646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001648void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1649 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1650 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001651{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001652 conf->f_vrfy = f_vrfy;
1653 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001654}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1658 int (*f_rng)(void *, unsigned char *, size_t),
1659 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001660{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001661 conf->f_rng = f_rng;
1662 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001663}
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1666 void (*f_dbg)(void *, int, const char *, int, const char *),
1667 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001668{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001669 conf->f_dbg = f_dbg;
1670 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001671}
1672
Gilles Peskine449bd832023-01-11 14:50:10 +01001673void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1674 void *p_bio,
1675 mbedtls_ssl_send_t *f_send,
1676 mbedtls_ssl_recv_t *f_recv,
1677 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001678{
1679 ssl->p_bio = p_bio;
1680 ssl->f_send = f_send;
1681 ssl->f_recv = f_recv;
1682 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001683}
1684
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001685#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001686void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001687{
1688 ssl->mtu = mtu;
1689}
1690#endif
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001693{
1694 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001695}
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1698 void *p_timer,
1699 mbedtls_ssl_set_timer_t *f_set_timer,
1700 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001701{
1702 ssl->p_timer = p_timer;
1703 ssl->f_set_timer = f_set_timer;
1704 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001705
1706 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001708}
1709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001711void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1712 void *p_cache,
1713 mbedtls_ssl_cache_get_t *f_get_cache,
1714 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001715{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001716 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001717 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001718 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001719}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001724{
Janos Follath865b3eb2019-12-16 11:46:15 +00001725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001728 session == NULL ||
1729 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001732 }
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 if (ssl->handshake->resume == 1) {
1735 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1736 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001737
Jerry Yu21092062022-10-10 21:21:31 +08001738#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron8d630842024-04-04 14:05:21 +02001740#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001745 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1747 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1748 session->ciphersuite));
1749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001750 }
Ronald Cron8d630842024-04-04 14:05:21 +02001751#else
1752 /*
1753 * If session tickets are not enabled, it is not possible to resume a
1754 * TLS 1.3 session, thus do not make any change to the SSL context in
1755 * the first place.
1756 */
1757 return 0;
1758#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001759 }
Jerry Yu21092062022-10-10 21:21:31 +08001760#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1763 session)) != 0) {
1764 return ret;
1765 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001766
Paul Bakker0a597072012-09-25 21:55:46 +00001767 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001770}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001772
Gilles Peskine449bd832023-01-11 14:50:10 +01001773void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1774 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001775{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001776 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001777}
1778
Ronald Cron6f135e12021-12-08 16:57:54 +01001779#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001780void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1781 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001782{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001783 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001784}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001785
1786#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001787void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1788 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001789{
1790 conf->early_data_enabled = early_data_enabled;
1791}
Jerry Yucc4e0072022-11-22 17:22:22 +08001792
1793#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001794void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001796{
Jerry Yu39da9852022-12-06 16:58:36 +08001797 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001798}
1799#endif /* MBEDTLS_SSL_SRV_C */
1800
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001801#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001805void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1806 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001807{
1808 conf->cert_profile = profile;
1809}
1810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001812{
1813 mbedtls_ssl_key_cert *cur = key_cert, *next;
1814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001816 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001818 cur = next;
1819 }
1820}
1821
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001822/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001823MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001824static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1825 mbedtls_x509_crt *cert,
1826 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001827{
niisato8ee24222018-06-25 19:05:48 +09001828 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001831 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001833 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001835 }
1836
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1838 if (new_cert == NULL) {
1839 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1840 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
niisato8ee24222018-06-25 19:05:48 +09001842 new_cert->cert = cert;
1843 new_cert->key = key;
1844 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001845
Glenn Strauss36872db2022-01-22 05:06:31 -05001846 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001848 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001850 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001852 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
niisato8ee24222018-06-25 19:05:48 +09001854 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001855 }
1856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001858}
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001861 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001863{
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001868 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001870{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001871 conf->ca_chain = ca_chain;
1872 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001873
1874#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1875 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1876 * cannot be used together. */
1877 conf->f_ca_cb = NULL;
1878 conf->p_ca_cb = NULL;
1879#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001880}
Hanno Becker5adaad92019-03-27 16:54:37 +00001881
1882#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001883void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1884 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1885 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001886{
1887 conf->f_ca_cb = f_ca_cb;
1888 conf->p_ca_cb = p_ca_cb;
1889
1890 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1891 * cannot be used together. */
1892 conf->ca_chain = NULL;
1893 conf->ca_crl = NULL;
1894}
1895#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001897
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001898#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001899const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1900 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001901{
1902 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001904}
1905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1907 mbedtls_x509_crt *own_cert,
1908 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001909{
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1911 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001912}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1915 mbedtls_x509_crt *ca_chain,
1916 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001917{
1918 ssl->handshake->sni_ca_chain = ca_chain;
1919 ssl->handshake->sni_ca_crl = ca_crl;
1920}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001921
Glenn Strauss999ef702022-03-11 01:37:23 -05001922#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001923void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1924 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001925{
1926 ssl->handshake->dn_hints = crt;
1927}
1928#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1931 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001932{
1933 ssl->handshake->sni_authmode = authmode;
1934}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1936
Hanno Becker8927c832019-04-03 12:52:50 +01001937#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001938void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1939 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1940 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001941{
1942 ssl->f_vrfy = f_vrfy;
1943 ssl->p_vrfy = p_vrfy;
1944}
1945#endif
1946
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001947#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001948
Valerio Setti016f6822022-12-09 14:17:50 +01001949#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001950static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1951static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1952
Valerio Setti016f6822022-12-09 14:17:50 +01001953static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 mbedtls_ssl_context *ssl,
1955 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001956{
1957 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001958 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001959 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001960 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001961 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001962 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1964 psa_pake_cs_set_primitive(&cipher_suite,
1965 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1966 PSA_ECC_FAMILY_SECP_R1,
1967 256));
1968 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1971 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001972 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001976 user = jpake_server_id;
1977 user_len = sizeof(jpake_server_id);
1978 peer = jpake_client_id;
1979 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001981 user = jpake_client_id;
1982 user_len = sizeof(jpake_client_id);
1983 peer = jpake_server_id;
1984 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001986
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001987 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1988 if (status != PSA_SUCCESS) {
1989 return status;
1990 }
1991
1992 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001994 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 }
Valerio Setti016f6822022-12-09 14:17:50 +01001996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1998 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001999 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 }
Valerio Setti016f6822022-12-09 14:17:50 +01002001
2002 ssl->handshake->psa_pake_ctx_is_ok = 1;
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002005}
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2008 const unsigned char *pw,
2009 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002010{
2011 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2012 psa_status_t status;
2013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (ssl->handshake == NULL || ssl->conf == NULL) {
2015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002016 }
2017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 /* Empty password is not valid */
2019 if ((pw == NULL) || (pw_len == 0)) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022
2023 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2024 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2025 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2026
2027 status = psa_import_key(&attributes, pw, pw_len,
2028 &ssl->handshake->psa_pake_password);
2029 if (status != PSA_SUCCESS) {
2030 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2031 }
2032
2033 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2034 ssl->handshake->psa_pake_password);
2035 if (status != PSA_SUCCESS) {
2036 psa_destroy_key(ssl->handshake->psa_pake_password);
2037 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2038 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2039 }
2040
2041 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002042}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2045 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002047 psa_status_t status;
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (ssl->handshake == NULL || ssl->conf == NULL) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002051 }
2052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (mbedtls_svc_key_id_is_null(pwd)) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
2056
2057 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2058 if (status != PSA_SUCCESS) {
2059 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2060 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2061 }
2062
2063 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002064}
2065#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002066int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2067 const unsigned char *pw,
2068 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002069{
2070 mbedtls_ecjpake_role role;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2074 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002075
Valerio Settic689ed82022-12-07 14:40:38 +01002076 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if ((pw == NULL) || (pw_len == 0)) {
2078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2079 }
Valerio Settic689ed82022-12-07 14:40:38 +01002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002082 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002084 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2088 role,
2089 MBEDTLS_MD_SHA256,
2090 MBEDTLS_ECP_DP_SECP256R1,
2091 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092}
Valerio Setti02c25b52022-11-15 14:08:42 +01002093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002094#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002095
Ronald Cron73fe8df2022-10-05 14:31:43 +02002096#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002098{
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (conf->psk_identity == NULL ||
2100 conf->psk_identity_len == 0) {
2101 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002102 }
2103
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002104#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2106 return 1;
2107 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (conf->psk != NULL && conf->psk_len != 0) {
2111 return 1;
2112 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002115}
2116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118{
2119 /* Remove reference to existing PSK, if any. */
2120#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122 /* The maintenance of the PSK key slot is the
2123 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002124 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002128 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002129 conf->psk = NULL;
2130 conf->psk_len = 0;
2131 }
2132
2133 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 if (conf->psk_identity != NULL) {
2135 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002136 conf->psk_identity = NULL;
2137 conf->psk_identity_len = 0;
2138 }
2139}
2140
Hanno Becker7390c712018-11-15 13:33:04 +00002141/* This function assumes that PSK identity in the SSL config is unset.
2142 * It checks that the provided identity is well-formed and attempts
2143 * to make a copy of it in the SSL config.
2144 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002146static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2147 unsigned char const *psk_identity,
2148 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002149{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002150 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002152 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 (psk_identity_len >> 16) != 0 ||
2154 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2155 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002156 }
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2159 if (conf->psk_identity == NULL) {
2160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2161 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002162
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002163 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002167}
2168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2170 const unsigned char *psk, size_t psk_len,
2171 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002172{
Janos Follath865b3eb2019-12-16 11:46:15 +00002173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002174
2175 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2177 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2178 }
Hanno Becker7390c712018-11-15 13:33:04 +00002179
2180 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (psk == NULL) {
2182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2183 }
2184 if (psk_len == 0) {
2185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2186 }
2187 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2189 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2192 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2193 }
Hanno Becker7390c712018-11-15 13:33:04 +00002194 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002196
2197 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2199 if (ret != 0) {
2200 ssl_conf_remove_psk(conf);
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002204}
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002207{
2208#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002210 /* The maintenance of the external PSK key slot is the
2211 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (ssl->handshake->psk_opaque_is_internal) {
2213 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002214 ssl->handshake->psk_opaque_is_internal = 0;
2215 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002216 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002217 }
Neil Armstronge952a302022-05-03 10:22:14 +02002218#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002220 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002222 ssl->handshake->psk_len = 0;
lhuang046d4d94f2024-06-11 12:37:02 -07002223 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002224 }
Neil Armstronge952a302022-05-03 10:22:14 +02002225#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002226}
2227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2229 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230{
Neil Armstrong501c9322022-05-03 09:35:09 +02002231#if defined(MBEDTLS_USE_PSA_CRYPTO)
2232 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002234 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002235 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002236#endif /* MBEDTLS_USE_PSA_CRYPTO */
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 if (psk == NULL || ssl->handshake == NULL) {
2239 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2240 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002241
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2243 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2244 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002247
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002249#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2251 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2252 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2253 } else {
2254 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2255 }
2256 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002257 }
2258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002259
Jerry Yu568ec252022-07-22 21:27:34 +08002260#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2262 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2263 psa_set_key_usage_flags(&key_attributes,
2264 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002265 }
2266#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 psa_set_key_algorithm(&key_attributes, alg);
2269 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2272 if (status != PSA_SUCCESS) {
2273 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2274 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002275
2276 /* Allow calling psa_destroy_key() on psk remove */
2277 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002279#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2281 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2282 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002283
2284 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002286
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002288#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002289}
2290
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002291#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002292int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2293 mbedtls_svc_key_id_t psk,
2294 const unsigned char *psk_identity,
2295 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002296{
Janos Follath865b3eb2019-12-16 11:46:15 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002298
2299 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2301 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2302 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303
Hanno Becker7390c712018-11-15 13:33:04 +00002304 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 if (mbedtls_svc_key_id_is_null(psk)) {
2306 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2307 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002308 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002309
2310 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2312 psk_identity_len);
2313 if (ret != 0) {
2314 ssl_conf_remove_psk(conf);
2315 }
Hanno Becker7390c712018-11-15 13:33:04 +00002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002318}
2319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2321 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002322{
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if ((mbedtls_svc_key_id_is_null(psk)) ||
2324 (ssl->handshake == NULL)) {
2325 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2326 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002329 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002331}
2332#endif /* MBEDTLS_USE_PSA_CRYPTO */
2333
Jerry Yu8897c072022-08-12 13:56:53 +08002334#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002335void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2336 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2337 size_t),
2338 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339{
2340 conf->f_psk = f_psk;
2341 conf->p_psk = p_psk;
2342}
Jerry Yu8897c072022-08-12 13:56:53 +08002343#endif /* MBEDTLS_SSL_SRV_C */
2344
Ronald Cron73fe8df2022-10-05 14:31:43 +02002345#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002346
2347#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002348static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002351#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (alg == PSA_ALG_CBC_NO_PADDING) {
2353 return MBEDTLS_SSL_MODE_CBC;
2354 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 if (PSA_ALG_IS_AEAD(alg)) {
2357 return MBEDTLS_SSL_MODE_AEAD;
2358 }
2359 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002360}
2361
2362#else /* MBEDTLS_USE_PSA_CRYPTO */
2363
2364static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002366{
2367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (mode == MBEDTLS_MODE_CBC) {
2369 return MBEDTLS_SSL_MODE_CBC;
2370 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002371#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2372
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373#if defined(MBEDTLS_GCM_C) || \
2374 defined(MBEDTLS_CCM_C) || \
2375 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002377 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 mode == MBEDTLS_MODE_CHACHAPOLY) {
2379 return MBEDTLS_SSL_MODE_AEAD;
2380 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002382
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002384}
Gilles Peskine301711e2022-04-26 16:57:05 +02002385#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002386
Gilles Peskinee108d982022-04-26 16:50:40 +02002387static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2388 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002390{
2391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2393 base_mode == MBEDTLS_SSL_MODE_CBC) {
2394 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002395 }
2396#else
2397 (void) encrypt_then_mac;
2398#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002400}
2401
Neil Armstrongab555e02022-04-04 11:07:59 +02002402mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002404{
Gilles Peskinee108d982022-04-26 16:50:40 +02002405 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002408#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002410#endif
2411 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002412
Gilles Peskinee108d982022-04-26 16:50:40 +02002413 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002415 encrypt_then_mac = transform->encrypt_then_mac;
2416#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418}
2419
Neil Armstrongab555e02022-04-04 11:07:59 +02002420mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002421#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002423#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002425{
Gilles Peskinee108d982022-04-26 16:50:40 +02002426 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2427
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002428#if defined(MBEDTLS_USE_PSA_CRYPTO)
2429 psa_status_t status;
2430 psa_algorithm_t alg;
2431 psa_key_type_t type;
2432 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002433 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2434 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 if (status == PSA_SUCCESS) {
2436 base_mode = mbedtls_ssl_get_base_mode(alg);
2437 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002438#else
2439 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002440 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002442 base_mode =
2443 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002445 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002446#endif /* MBEDTLS_USE_PSA_CRYPTO */
2447
Gilles Peskinee108d982022-04-26 16:50:40 +02002448#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2449 int encrypt_then_mac = 0;
2450#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002452}
2453
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002454#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2457 size_t taglen,
2458 psa_algorithm_t *alg,
2459 psa_key_type_t *key_type,
2460 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002461{
Yanray Wang19e4dc82023-11-16 18:02:05 +08002462#if !defined(MBEDTLS_SSL_HAVE_CCM)
2463 (void) taglen;
2464#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 switch (mbedtls_cipher_type) {
Yanray Wang1a369d62023-11-16 15:17:31 +08002466#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002467 case MBEDTLS_CIPHER_AES_128_CBC:
2468 *alg = PSA_ALG_CBC_NO_PADDING;
2469 *key_type = PSA_KEY_TYPE_AES;
2470 *key_size = 128;
2471 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002472#endif
2473#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002474 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002476 *key_type = PSA_KEY_TYPE_AES;
2477 *key_size = 128;
2478 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002479#endif
2480#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002481 case MBEDTLS_CIPHER_AES_128_GCM:
2482 *alg = PSA_ALG_GCM;
2483 *key_type = PSA_KEY_TYPE_AES;
2484 *key_size = 128;
2485 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002486#endif
2487#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002488 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 *key_type = PSA_KEY_TYPE_AES;
2491 *key_size = 192;
2492 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002493#endif
2494#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002495 case MBEDTLS_CIPHER_AES_192_GCM:
2496 *alg = PSA_ALG_GCM;
2497 *key_type = PSA_KEY_TYPE_AES;
2498 *key_size = 192;
2499 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002500#endif
2501#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002502 case MBEDTLS_CIPHER_AES_256_CBC:
2503 *alg = PSA_ALG_CBC_NO_PADDING;
2504 *key_type = PSA_KEY_TYPE_AES;
2505 *key_size = 256;
2506 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002507#endif
2508#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002509 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 *key_type = PSA_KEY_TYPE_AES;
2512 *key_size = 256;
2513 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002514#endif
2515#if defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002516 case MBEDTLS_CIPHER_AES_256_GCM:
2517 *alg = PSA_ALG_GCM;
2518 *key_type = PSA_KEY_TYPE_AES;
2519 *key_size = 256;
2520 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002521#endif
2522#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002523 case MBEDTLS_CIPHER_ARIA_128_CBC:
2524 *alg = PSA_ALG_CBC_NO_PADDING;
2525 *key_type = PSA_KEY_TYPE_ARIA;
2526 *key_size = 128;
2527 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002528#endif
2529#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002530 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 *key_type = PSA_KEY_TYPE_ARIA;
2533 *key_size = 128;
2534 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002535#endif
2536#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002537 case MBEDTLS_CIPHER_ARIA_128_GCM:
2538 *alg = PSA_ALG_GCM;
2539 *key_type = PSA_KEY_TYPE_ARIA;
2540 *key_size = 128;
2541 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002542#endif
2543#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002544 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 *key_type = PSA_KEY_TYPE_ARIA;
2547 *key_size = 192;
2548 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002549#endif
2550#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002551 case MBEDTLS_CIPHER_ARIA_192_GCM:
2552 *alg = PSA_ALG_GCM;
2553 *key_type = PSA_KEY_TYPE_ARIA;
2554 *key_size = 192;
2555 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002556#endif
2557#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002558 case MBEDTLS_CIPHER_ARIA_256_CBC:
2559 *alg = PSA_ALG_CBC_NO_PADDING;
2560 *key_type = PSA_KEY_TYPE_ARIA;
2561 *key_size = 256;
2562 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002563#endif
2564#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002565 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 *key_type = PSA_KEY_TYPE_ARIA;
2568 *key_size = 256;
2569 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002570#endif
2571#if defined(MBEDTLS_SSL_HAVE_ARIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002572 case MBEDTLS_CIPHER_ARIA_256_GCM:
2573 *alg = PSA_ALG_GCM;
2574 *key_type = PSA_KEY_TYPE_ARIA;
2575 *key_size = 256;
2576 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002577#endif
2578#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002579 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2580 *alg = PSA_ALG_CBC_NO_PADDING;
2581 *key_type = PSA_KEY_TYPE_CAMELLIA;
2582 *key_size = 128;
2583 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002584#endif
2585#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002586 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 *key_type = PSA_KEY_TYPE_CAMELLIA;
2589 *key_size = 128;
2590 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002591#endif
2592#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002593 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2594 *alg = PSA_ALG_GCM;
2595 *key_type = PSA_KEY_TYPE_CAMELLIA;
2596 *key_size = 128;
2597 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002598#endif
2599#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002600 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 *key_type = PSA_KEY_TYPE_CAMELLIA;
2603 *key_size = 192;
2604 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002605#endif
2606#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002607 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2608 *alg = PSA_ALG_GCM;
2609 *key_type = PSA_KEY_TYPE_CAMELLIA;
2610 *key_size = 192;
2611 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002612#endif
2613#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CBC)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002614 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2615 *alg = PSA_ALG_CBC_NO_PADDING;
2616 *key_type = PSA_KEY_TYPE_CAMELLIA;
2617 *key_size = 256;
2618 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002619#endif
2620#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002621 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 *key_type = PSA_KEY_TYPE_CAMELLIA;
2624 *key_size = 256;
2625 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002626#endif
2627#if defined(MBEDTLS_SSL_HAVE_CAMELLIA) && defined(MBEDTLS_SSL_HAVE_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002628 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2629 *alg = PSA_ALG_GCM;
2630 *key_type = PSA_KEY_TYPE_CAMELLIA;
2631 *key_size = 256;
2632 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002633#endif
2634#if defined(MBEDTLS_SSL_HAVE_CHACHAPOLY)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002635 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2636 *alg = PSA_ALG_CHACHA20_POLY1305;
2637 *key_type = PSA_KEY_TYPE_CHACHA20;
2638 *key_size = 256;
2639 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002640#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002641 case MBEDTLS_CIPHER_NULL:
2642 *alg = MBEDTLS_SSL_NULL_CIPHER;
2643 *key_type = 0;
2644 *key_size = 0;
2645 break;
2646 default:
2647 return PSA_ERROR_NOT_SUPPORTED;
2648 }
2649
2650 return PSA_SUCCESS;
2651}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002652#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002653
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002654#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2656 const unsigned char *dhm_P, size_t P_len,
2657 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002658{
Janos Follath865b3eb2019-12-16 11:46:15 +00002659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 mbedtls_mpi_free(&conf->dhm_P);
2662 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2665 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2666 mbedtls_mpi_free(&conf->dhm_P);
2667 mbedtls_mpi_free(&conf->dhm_G);
2668 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002669 }
2670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002672}
Paul Bakker5121ce52009-01-03 21:22:43 +00002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002675{
Janos Follath865b3eb2019-12-16 11:46:15 +00002676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 mbedtls_mpi_free(&conf->dhm_P);
2679 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2682 &conf->dhm_P)) != 0 ||
2683 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2684 &conf->dhm_G)) != 0) {
2685 mbedtls_mpi_free(&conf->dhm_P);
2686 mbedtls_mpi_free(&conf->dhm_G);
2687 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002688 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002691}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002692#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002693
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002694#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2695/*
2696 * Set the minimum length for Diffie-Hellman parameters
2697 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002698void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2699 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002700{
2701 conf->dhm_min_bitlen = bitlen;
2702}
2703#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2704
Ronald Crone68ab4f2022-10-05 12:46:29 +02002705#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002706#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002707/*
2708 * Set allowed/preferred hashes for handshake signatures
2709 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2711 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002712{
2713 conf->sig_hashes = hashes;
2714}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002715#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002716
Jerry Yuf017ee42022-01-12 15:49:48 +08002717/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2719 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002720{
Jerry Yuf017ee42022-01-12 15:49:48 +08002721#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2722 conf->sig_hashes = NULL;
2723#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2724 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002725}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002726#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002727
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002728#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002729#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002730/*
2731 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002732 *
2733 * mbedtls_ssl_setup() takes the provided list
2734 * and translates it to a list of IANA TLS group identifiers,
2735 * stored in ssl->handshake->group_list.
2736 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2739 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002741 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002742 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002743}
Brett Warrene0edc842021-08-17 09:53:13 +01002744#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002745#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002746
Brett Warrene0edc842021-08-17 09:53:13 +01002747/*
2748 * Set the allowed groups
2749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2751 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002752{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002753#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002754 conf->curve_list = NULL;
2755#endif
2756 conf->group_list = group_list;
2757}
2758
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002759#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskinee61852e2025-02-12 23:28:48 +01002760
Gilles Peskine6b885942025-02-12 23:53:25 +01002761/* A magic value for `ssl->hostname` indicating that
2762 * mbedtls_ssl_set_hostname() has been called with `NULL`.
2763 * If mbedtls_ssl_set_hostname() has never been called on `ssl`, then
2764 * `ssl->hostname == NULL`. */
2765static const char *const ssl_hostname_skip_cn_verification = "";
2766
Gilles Peskinee61852e2025-02-12 23:28:48 +01002767#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2768/** Whether mbedtls_ssl_set_hostname() has been called.
2769 *
2770 * \param[in] ssl SSL context
2771 *
2772 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2773 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2774 * otherwise \c 0.
2775 */
2776static int mbedtls_ssl_has_set_hostname_been_called(
2777 const mbedtls_ssl_context *ssl)
2778{
Gilles Peskinee61852e2025-02-12 23:28:48 +01002779 return ssl->hostname != NULL;
2780}
2781#endif
2782
2783/* Micro-optimization: don't export this function if it isn't needed outside
2784 * of this source file. */
2785#if !defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2786static
2787#endif
2788const char *mbedtls_ssl_get_hostname_pointer(const mbedtls_ssl_context *ssl)
2789{
Gilles Peskine6b885942025-02-12 23:53:25 +01002790 if (ssl->hostname == ssl_hostname_skip_cn_verification) {
2791 return NULL;
2792 }
Gilles Peskinee61852e2025-02-12 23:28:48 +01002793 return ssl->hostname;
2794}
2795
2796static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2797{
Gilles Peskine6b885942025-02-12 23:53:25 +01002798 if (ssl->hostname != NULL &&
2799 ssl->hostname != ssl_hostname_skip_cn_verification) {
Gilles Peskinee61852e2025-02-12 23:28:48 +01002800 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2801 }
2802 ssl->hostname = NULL;
2803}
2804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002806{
Hanno Becker947194e2017-04-07 13:25:49 +01002807 /* Initialize to suppress unnecessary compiler warning */
2808 size_t hostname_len = 0;
2809
2810 /* Check if new hostname is valid before
2811 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (hostname != NULL) {
2813 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2816 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2817 }
Hanno Becker947194e2017-04-07 13:25:49 +01002818 }
2819
2820 /* Now it's clear that we will overwrite the old hostname,
2821 * so we can free it safely */
Gilles Peskinee61852e2025-02-12 23:28:48 +01002822 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (hostname == NULL) {
Gilles Peskine6b885942025-02-12 23:53:25 +01002825 /* Passing NULL as hostname clears the old one, but leaves a
2826 * special marker to indicate that mbedtls_ssl_set_hostname()
2827 * has been called. */
2828 /* ssl->hostname should be const, but isn't. We won't actually
2829 * write to the buffer, so it's ok to cast away the const. */
2830 ssl->hostname = (char *) ssl_hostname_skip_cn_verification;
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 } else {
2832 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2833 if (ssl->hostname == NULL) {
Gilles Peskine6b885942025-02-12 23:53:25 +01002834 /* mbedtls_ssl_set_hostname() has been called, but unsuccessfully.
2835 * Leave ssl->hostname in the same state as if the function had
2836 * not been called, i.e. a null pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2838 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002841
Hanno Becker947194e2017-04-07 13:25:49 +01002842 ssl->hostname[hostname_len] = '\0';
2843 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002846}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002847#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002848
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002849#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002850void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2851 int (*f_sni)(void *, mbedtls_ssl_context *,
2852 const unsigned char *, size_t),
2853 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002854{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002855 conf->f_sni = f_sni;
2856 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002857}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002861int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002862{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002863 size_t cur_len, tot_len;
2864 const char **p;
2865
2866 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002867 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2868 * MUST NOT be truncated."
2869 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002870 */
2871 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 for (p = protos; *p != NULL; p++) {
2873 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002874 tot_len += cur_len;
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if ((cur_len == 0) ||
2877 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2878 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2880 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002881 }
2882
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002883 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002886}
2887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002889{
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002891}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002893
Johan Pascalb62bb512015-12-03 21:56:45 +01002894#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002895void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2896 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002897{
2898 conf->dtls_srtp_mki_support = support_mki_value;
2899}
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2902 unsigned char *mki_value,
2903 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002904{
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2906 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002907 }
Ron Eldor591f1622018-01-22 12:30:04 +02002908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2910 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002911 }
Ron Eldor591f1622018-01-22 12:30:04 +02002912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002914 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002916}
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2919 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002920{
Johan Pascal253d0262020-09-22 13:04:45 +02002921 const mbedtls_ssl_srtp_profile *p;
2922 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002923
Johan Pascal253d0262020-09-22 13:04:45 +02002924 /* check the profiles list: all entry must be valid,
2925 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2927 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2928 p++) {
2929 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002930 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002932 /* unsupported value, stop parsing and set the size to an error value */
2933 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002934 }
2935 }
2936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2938 conf->dtls_srtp_profile_list = NULL;
2939 conf->dtls_srtp_profile_list_len = 0;
2940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002941 }
2942
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002943 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002944 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002947}
2948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2950 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002951{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002952 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2953 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002955 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002957 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2959 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002960 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002961}
Johan Pascalb62bb512015-12-03 21:56:45 +01002962#endif /* MBEDTLS_SSL_DTLS_SRTP */
2963
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302964#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002965void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002966{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002967 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002968}
2969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002971{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002972 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002973}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302974#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002975
Janos Follath088ce432017-04-10 12:42:31 +01002976#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002977void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2978 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002979{
2980 conf->cert_req_ca_list = cert_req_ca_list;
2981}
2982#endif
2983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002985void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002986{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002987 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002988}
2989#endif
2990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002992void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002993{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002994 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002995}
2996#endif
2997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002999int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003000{
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
3002 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
3003 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003004 }
3005
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003006 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003009}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00003013{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003014 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00003015}
3016
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01003018void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003019{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003020 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01003021}
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003024{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003025 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003026}
3027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3029 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003030{
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003032}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003036#if defined(MBEDTLS_SSL_CLI_C)
Ronald Crond67f8012024-08-28 07:45:57 +02003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003039{
Ronald Crond67f8012024-08-28 07:45:57 +02003040 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_MASK;
3041 conf->session_tickets |= (use_tickets != 0) <<
3042 MBEDTLS_SSL_SESSION_TICKETS_TLS1_2_BIT;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003043}
Ronald Crond67f8012024-08-28 07:45:57 +02003044
Ronald Cronbedddd72024-08-27 14:18:50 +02003045#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron9f44c882024-08-28 16:44:10 +02003046void mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
3047 mbedtls_ssl_config *conf, int signal_new_session_tickets)
Ronald Cronbedddd72024-08-27 14:18:50 +02003048{
Ronald Crond67f8012024-08-28 07:45:57 +02003049 conf->session_tickets &= ~MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_MASK;
Ronald Cron9f44c882024-08-28 16:44:10 +02003050 conf->session_tickets |= (signal_new_session_tickets != 0) <<
Ronald Crond67f8012024-08-28 07:45:57 +02003051 MBEDTLS_SSL_SESSION_TICKETS_TLS1_3_BIT;
3052}
Ronald Cronbedddd72024-08-27 14:18:50 +02003053#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3054#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker606b4ba2013-08-14 16:52:14 +02003055
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003056#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003057
Jerry Yud0766ec2022-09-22 10:46:57 +08003058#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003059void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3060 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003061{
Jerry Yud0766ec2022-09-22 10:46:57 +08003062 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003063}
3064#endif
3065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3067 mbedtls_ssl_ticket_write_t *f_ticket_write,
3068 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3069 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003070{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003071 conf->f_ticket_write = f_ticket_write;
3072 conf->f_ticket_parse = f_ticket_parse;
3073 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003074}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003075#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3079 mbedtls_ssl_export_keys_t *f_export_keys,
3080 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003081{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003082 ssl->f_export_keys = f_export_keys;
3083 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003084}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003085
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003086#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003087void mbedtls_ssl_conf_async_private_cb(
3088 mbedtls_ssl_config *conf,
3089 mbedtls_ssl_async_sign_t *f_async_sign,
3090 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3091 mbedtls_ssl_async_resume_t *f_async_resume,
3092 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003094{
3095 conf->f_async_sign_start = f_async_sign;
3096 conf->f_async_decrypt_start = f_async_decrypt;
3097 conf->f_async_resume = f_async_resume;
3098 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003099 conf->p_async_config_data = async_config_data;
3100}
3101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003103{
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003105}
3106
Gilles Peskine449bd832023-01-11 14:50:10 +01003107void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003108{
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 if (ssl->handshake == NULL) {
3110 return NULL;
3111 } else {
3112 return ssl->handshake->user_async_ctx;
3113 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003114}
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3117 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003118{
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003120 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003122}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003123#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003124
Paul Bakker5121ce52009-01-03 21:22:43 +00003125/*
3126 * SSL get accessors
3127 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003128uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003129{
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 if (ssl->session != NULL) {
3131 return ssl->session->verify_result;
3132 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 if (ssl->session_negotiate != NULL) {
3135 return ssl->session_negotiate->verify_result;
3136 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003139}
3140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003142{
Gilles Peskine449bd832023-01-11 14:50:10 +01003143 if (ssl == NULL || ssl->session == NULL) {
3144 return 0;
3145 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003146
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003148}
3149
Gilles Peskine449bd832023-01-11 14:50:10 +01003150const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003151{
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl == NULL || ssl->session == NULL) {
3153 return NULL;
3154 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003155
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003157}
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003160{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3163 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003164 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003166 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003168 }
3169 }
3170#endif
3171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003173 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003175 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003177 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003179 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003180}
3181
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003182#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3183
3184size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3185{
3186 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3187 size_t record_size_limit = max_len;
3188
3189 if (ssl->session != NULL &&
3190 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3191 ssl->session->record_size_limit < max_len) {
3192 record_size_limit = ssl->session->record_size_limit;
3193 }
3194
3195 // TODO: this is currently untested
3196 /* During a handshake, use the value being negotiated */
3197 if (ssl->session_negotiate != NULL &&
3198 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3199 ssl->session_negotiate->record_size_limit < max_len) {
3200 record_size_limit = ssl->session_negotiate->record_size_limit;
3201 }
3202
3203 return record_size_limit;
3204}
3205#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3206
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003207#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003208size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003209{
David Horstmann95d516f2021-05-04 18:36:56 +01003210 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003211 size_t read_mfl;
3212
Jerry Yuddda0502022-12-01 19:43:12 +08003213#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003214 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3216 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3217 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003218 }
Jerry Yuddda0502022-12-01 19:43:12 +08003219#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003220
3221 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 if (ssl->session_out != NULL) {
3223 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3224 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003225 max_len = read_mfl;
3226 }
3227 }
3228
Jerry Yuddda0502022-12-01 19:43:12 +08003229 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 if (ssl->session_negotiate != NULL) {
3231 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3232 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003233 max_len = read_mfl;
3234 }
3235 }
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003238}
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003241{
3242 size_t max_len;
3243
3244 /*
3245 * Assume mfl_code is correct since it was checked when set
3246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003248
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003249 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (ssl->session_out != NULL &&
3251 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3252 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003253 }
3254
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003255 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 if (ssl->session_negotiate != NULL &&
3257 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3258 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003259 }
3260
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003262}
3263#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3264
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003265#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003266size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003267{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003268 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3270 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3271 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3272 return 0;
3273 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3276 return ssl->mtu;
3277 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 if (ssl->mtu == 0) {
3280 return ssl->handshake->mtu;
3281 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003282
Gilles Peskine449bd832023-01-11 14:50:10 +01003283 return ssl->mtu < ssl->handshake->mtu ?
3284 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003285}
3286#endif /* MBEDTLS_SSL_PROTO_DTLS */
3287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289{
3290 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3291
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003292#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003293 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003294 !defined(MBEDTLS_SSL_PROTO_DTLS)
3295 (void) ssl;
3296#endif
3297
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003298#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003302 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003303 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003304#endif
3305
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003306#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3307 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3308
3309 if (max_len > record_size_limit) {
3310 max_len = record_size_limit;
3311 }
3312#endif
3313
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003314 if (ssl->transform_out != NULL &&
3315 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003316 /*
3317 * In TLS 1.3 case, when records are protected, `max_len` as computed
3318 * above is the maximum length of the TLSInnerPlaintext structure that
3319 * along the plaintext payload contains the inner content type (one byte)
3320 * and some zero padding. Given the algorithm used for padding
3321 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3322 * the plaintext payload. Round down to a multiple of
3323 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3324 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003325 */
3326 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3327 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3328 }
3329
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003330#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3332 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3333 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003334 const size_t overhead = (size_t) ret;
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (ret < 0) {
3337 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003338 }
3339
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 if (mtu <= overhead) {
3341 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3342 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3343 }
3344
3345 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003346 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003348 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003349#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003350
Hanno Becker0defedb2018-08-10 12:35:02 +01003351#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003352 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3353 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003354 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003355#endif
3356
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003358}
3359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003361{
3362 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3363
3364#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3365 (void) ssl;
3366#endif
3367
3368#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003370
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003372 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003373 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003374#endif
3375
Gilles Peskine449bd832023-01-11 14:50:10 +01003376 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003377}
3378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003380const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003381{
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 if (ssl == NULL || ssl->session == NULL) {
3383 return NULL;
3384 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003385
Hanno Beckere6824572019-02-07 13:18:46 +00003386#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003388#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003390#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003391}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003395int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3396 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003397{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003398 int ret;
3399
Gilles Peskine449bd832023-01-11 14:50:10 +01003400 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003401 dst == NULL ||
3402 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003405 }
3406
Hanno Beckere810bbc2021-05-14 16:01:05 +01003407 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3408 * idempotent: Each session can only be exported once.
3409 *
3410 * (This is in preparation for TLS 1.3 support where we will
3411 * need the ability to export multiple sessions (aka tickets),
3412 * which will be achieved by calling mbedtls_ssl_get_session()
3413 * multiple times until it fails.)
3414 *
3415 * Check whether we have already exported the current session,
3416 * and fail if so.
3417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (ssl->session->exported == 1) {
3419 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3420 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3423 if (ret != 0) {
3424 return ret;
3425 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003426
3427 /* Remember that we've exported the session. */
3428 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003430}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003432
David Horstmanncb01b362024-02-29 17:31:46 +00003433#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3434
3435/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003436 *
David Horstmanncb01b362024-02-29 17:31:46 +00003437 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003438 */
3439static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3440 unsigned char *buf,
3441 size_t buf_len)
3442{
3443 unsigned char *p = buf;
3444 size_t used = 0;
3445
3446#if defined(MBEDTLS_HAVE_TIME)
3447 uint64_t start;
3448#endif
3449#if defined(MBEDTLS_X509_CRT_PARSE_C)
3450#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3451 size_t cert_len;
3452#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3453#endif /* MBEDTLS_X509_CRT_PARSE_C */
3454
3455 /*
3456 * Time
3457 */
3458#if defined(MBEDTLS_HAVE_TIME)
3459 used += 8;
3460
3461 if (used <= buf_len) {
3462 start = (uint64_t) session->start;
3463
3464 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3465 p += 8;
3466 }
3467#endif /* MBEDTLS_HAVE_TIME */
3468
3469 /*
3470 * Basic mandatory fields
3471 */
3472 used += 1 /* id_len */
3473 + sizeof(session->id)
3474 + sizeof(session->master)
3475 + 4; /* verify_result */
3476
3477 if (used <= buf_len) {
3478 *p++ = MBEDTLS_BYTE_0(session->id_len);
3479 memcpy(p, session->id, 32);
3480 p += 32;
3481
3482 memcpy(p, session->master, 48);
3483 p += 48;
3484
3485 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3486 p += 4;
3487 }
3488
3489 /*
3490 * Peer's end-entity certificate
3491 */
3492#if defined(MBEDTLS_X509_CRT_PARSE_C)
3493#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3494 if (session->peer_cert == NULL) {
3495 cert_len = 0;
3496 } else {
3497 cert_len = session->peer_cert->raw.len;
3498 }
3499
3500 used += 3 + cert_len;
3501
3502 if (used <= buf_len) {
3503 *p++ = MBEDTLS_BYTE_2(cert_len);
3504 *p++ = MBEDTLS_BYTE_1(cert_len);
3505 *p++ = MBEDTLS_BYTE_0(cert_len);
3506
3507 if (session->peer_cert != NULL) {
3508 memcpy(p, session->peer_cert->raw.p, cert_len);
3509 p += cert_len;
3510 }
3511 }
3512#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3513 if (session->peer_cert_digest != NULL) {
3514 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3515 if (used <= buf_len) {
3516 *p++ = (unsigned char) session->peer_cert_digest_type;
3517 *p++ = (unsigned char) session->peer_cert_digest_len;
3518 memcpy(p, session->peer_cert_digest,
3519 session->peer_cert_digest_len);
3520 p += session->peer_cert_digest_len;
3521 }
3522 } else {
3523 used += 2;
3524 if (used <= buf_len) {
3525 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3526 *p++ = 0;
3527 }
3528 }
3529#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3530#endif /* MBEDTLS_X509_CRT_PARSE_C */
3531
3532 /*
3533 * Session ticket if any, plus associated data
3534 */
3535#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3536#if defined(MBEDTLS_SSL_CLI_C)
3537 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3538 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3539
3540 if (used <= buf_len) {
3541 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3542 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3543 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3544
3545 if (session->ticket != NULL) {
3546 memcpy(p, session->ticket, session->ticket_len);
3547 p += session->ticket_len;
3548 }
3549
3550 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3551 p += 4;
3552 }
3553 }
3554#endif /* MBEDTLS_SSL_CLI_C */
3555#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3556 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3557 used += 8;
3558
3559 if (used <= buf_len) {
3560 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3561 p += 8;
3562 }
3563 }
3564#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3565#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3566
3567 /*
3568 * Misc extension-related info
3569 */
3570#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3571 used += 1;
3572
3573 if (used <= buf_len) {
3574 *p++ = session->mfl_code;
3575 }
3576#endif
3577
3578#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3579 used += 1;
3580
3581 if (used <= buf_len) {
3582 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3583 }
3584#endif
3585
3586 return used;
3587}
3588
3589MBEDTLS_CHECK_RETURN_CRITICAL
3590static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3591 const unsigned char *buf,
3592 size_t len)
3593{
3594#if defined(MBEDTLS_HAVE_TIME)
3595 uint64_t start;
3596#endif
3597#if defined(MBEDTLS_X509_CRT_PARSE_C)
3598#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3599 size_t cert_len;
3600#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3601#endif /* MBEDTLS_X509_CRT_PARSE_C */
3602
3603 const unsigned char *p = buf;
3604 const unsigned char * const end = buf + len;
3605
3606 /*
3607 * Time
3608 */
3609#if defined(MBEDTLS_HAVE_TIME)
3610 if (8 > (size_t) (end - p)) {
3611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3612 }
3613
3614 start = MBEDTLS_GET_UINT64_BE(p, 0);
3615 p += 8;
3616
3617 session->start = (time_t) start;
3618#endif /* MBEDTLS_HAVE_TIME */
3619
3620 /*
3621 * Basic mandatory fields
3622 */
3623 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3624 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3625 }
3626
3627 session->id_len = *p++;
3628 memcpy(session->id, p, 32);
3629 p += 32;
3630
3631 memcpy(session->master, p, 48);
3632 p += 48;
3633
3634 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3635 p += 4;
3636
3637 /* Immediately clear invalid pointer values that have been read, in case
3638 * we exit early before we replaced them with valid ones. */
3639#if defined(MBEDTLS_X509_CRT_PARSE_C)
3640#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3641 session->peer_cert = NULL;
3642#else
3643 session->peer_cert_digest = NULL;
3644#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3645#endif /* MBEDTLS_X509_CRT_PARSE_C */
3646#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3647 session->ticket = NULL;
3648#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3649
3650 /*
3651 * Peer certificate
3652 */
3653#if defined(MBEDTLS_X509_CRT_PARSE_C)
3654#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3655 /* Deserialize CRT from the end of the ticket. */
3656 if (3 > (size_t) (end - p)) {
3657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3658 }
3659
3660 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3661 p += 3;
3662
3663 if (cert_len != 0) {
3664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3665
3666 if (cert_len > (size_t) (end - p)) {
3667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3668 }
3669
3670 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3671
3672 if (session->peer_cert == NULL) {
3673 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3674 }
3675
3676 mbedtls_x509_crt_init(session->peer_cert);
3677
3678 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3679 p, cert_len)) != 0) {
3680 mbedtls_x509_crt_free(session->peer_cert);
3681 mbedtls_free(session->peer_cert);
3682 session->peer_cert = NULL;
3683 return ret;
3684 }
3685
3686 p += cert_len;
3687 }
3688#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3689 /* Deserialize CRT digest from the end of the ticket. */
3690 if (2 > (size_t) (end - p)) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693
3694 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3695 session->peer_cert_digest_len = (size_t) *p++;
3696
3697 if (session->peer_cert_digest_len != 0) {
3698 const mbedtls_md_info_t *md_info =
3699 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3700 if (md_info == NULL) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3704 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3705 }
3706
3707 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710
3711 session->peer_cert_digest =
3712 mbedtls_calloc(1, session->peer_cert_digest_len);
3713 if (session->peer_cert_digest == NULL) {
3714 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3715 }
3716
3717 memcpy(session->peer_cert_digest, p,
3718 session->peer_cert_digest_len);
3719 p += session->peer_cert_digest_len;
3720 }
3721#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3722#endif /* MBEDTLS_X509_CRT_PARSE_C */
3723
3724 /*
3725 * Session ticket and associated data
3726 */
3727#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3728#if defined(MBEDTLS_SSL_CLI_C)
3729 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3730 if (3 > (size_t) (end - p)) {
3731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3732 }
3733
3734 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3735 p += 3;
3736
3737 if (session->ticket_len != 0) {
3738 if (session->ticket_len > (size_t) (end - p)) {
3739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3740 }
3741
3742 session->ticket = mbedtls_calloc(1, session->ticket_len);
3743 if (session->ticket == NULL) {
3744 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3745 }
3746
3747 memcpy(session->ticket, p, session->ticket_len);
3748 p += session->ticket_len;
3749 }
3750
3751 if (4 > (size_t) (end - p)) {
3752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3753 }
3754
3755 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3756 p += 4;
3757 }
3758#endif /* MBEDTLS_SSL_CLI_C */
3759#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3760 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3761 if (8 > (size_t) (end - p)) {
3762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3763 }
3764 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3765 p += 8;
3766 }
3767#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3768#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3769
3770 /*
3771 * Misc extension-related info
3772 */
3773#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3774 if (1 > (size_t) (end - p)) {
3775 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3776 }
3777
3778 session->mfl_code = *p++;
3779#endif
3780
3781#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3782 if (1 > (size_t) (end - p)) {
3783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3784 }
3785
3786 session->encrypt_then_mac = *p++;
3787#endif
3788
3789 /* Done, should have consumed entire buffer */
3790 if (p != end) {
3791 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3792 }
3793
3794 return 0;
3795}
3796
3797#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3798
3799#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3800/* Serialization of TLS 1.3 sessions:
3801 *
David Horstmanncb01b362024-02-29 17:31:46 +00003802 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003803 */
3804#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3805MBEDTLS_CHECK_RETURN_CRITICAL
3806static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3807 unsigned char *buf,
3808 size_t buf_len,
3809 size_t *olen)
3810{
3811 unsigned char *p = buf;
3812#if defined(MBEDTLS_SSL_CLI_C) && \
3813 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3814 size_t hostname_len = (session->hostname == NULL) ?
3815 0 : strlen(session->hostname) + 1;
3816#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003817
3818#if defined(MBEDTLS_SSL_SRV_C) && \
3819 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003820 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003821 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003822#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003823 size_t needed = 4 /* ticket_age_add */
3824 + 1 /* ticket_flags */
3825 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003826
David Horstmanne59f9702024-02-29 16:08:57 +00003827 *olen = 0;
3828
3829 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3831 }
3832 needed += session->resumption_key_len; /* resumption_key */
3833
3834#if defined(MBEDTLS_SSL_EARLY_DATA)
3835 needed += 4; /* max_early_data_size */
3836#endif
3837#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3838 needed += 2; /* record_size_limit */
3839#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3840
3841#if defined(MBEDTLS_HAVE_TIME)
3842 needed += 8; /* ticket_creation_time or ticket_reception_time */
3843#endif
3844
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003845#if defined(MBEDTLS_SSL_SRV_C)
3846 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3847#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003848 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003849 + alpn_len; /* alpn */
3850#endif
3851 }
3852#endif /* MBEDTLS_SSL_SRV_C */
3853
David Horstmanne59f9702024-02-29 16:08:57 +00003854#if defined(MBEDTLS_SSL_CLI_C)
3855 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3856#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3857 needed += 2 /* hostname_len */
3858 + hostname_len; /* hostname */
3859#endif
3860
3861 needed += 4 /* ticket_lifetime */
3862 + 2; /* ticket_len */
3863
3864 /* Check size_t overflow */
3865 if (session->ticket_len > SIZE_MAX - needed) {
3866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3867 }
3868
3869 needed += session->ticket_len; /* ticket */
3870 }
3871#endif /* MBEDTLS_SSL_CLI_C */
3872
3873 *olen = needed;
3874 if (needed > buf_len) {
3875 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3876 }
3877
3878 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3879 p[4] = session->ticket_flags;
3880
3881 /* save resumption_key */
3882 p[5] = session->resumption_key_len;
3883 p += 6;
3884 memcpy(p, session->resumption_key, session->resumption_key_len);
3885 p += session->resumption_key_len;
3886
3887#if defined(MBEDTLS_SSL_EARLY_DATA)
3888 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3889 p += 4;
3890#endif
3891#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3892 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3893 p += 2;
3894#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3895
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003896#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003897 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003898#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003899 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3900 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003901#endif /* MBEDTLS_HAVE_TIME */
3902
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003903#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003904 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3905 p += 2;
3906
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003907 if (alpn_len > 0) {
3908 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003909 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003910 p += alpn_len;
3911 }
3912#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3913 }
3914#endif /* MBEDTLS_SSL_SRV_C */
3915
David Horstmanne59f9702024-02-29 16:08:57 +00003916#if defined(MBEDTLS_SSL_CLI_C)
3917 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3918#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3919 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3920 p += 2;
3921 if (hostname_len > 0) {
3922 /* save host name */
3923 memcpy(p, session->hostname, hostname_len);
3924 p += hostname_len;
3925 }
3926#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3927
3928#if defined(MBEDTLS_HAVE_TIME)
3929 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3930 p += 8;
3931#endif
3932 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3933 p += 4;
3934
3935 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3936 p += 2;
3937
3938 if (session->ticket != NULL && session->ticket_len > 0) {
3939 memcpy(p, session->ticket, session->ticket_len);
3940 p += session->ticket_len;
3941 }
3942 }
3943#endif /* MBEDTLS_SSL_CLI_C */
3944 return 0;
3945}
3946
3947MBEDTLS_CHECK_RETURN_CRITICAL
3948static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3949 const unsigned char *buf,
3950 size_t len)
3951{
3952 const unsigned char *p = buf;
3953 const unsigned char *end = buf + len;
3954
3955 if (end - p < 6) {
3956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3957 }
3958 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3959 session->ticket_flags = p[4];
3960
3961 /* load resumption_key */
3962 session->resumption_key_len = p[5];
3963 p += 6;
3964
3965 if (end - p < session->resumption_key_len) {
3966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3967 }
3968
3969 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3970 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3971 }
3972 memcpy(session->resumption_key, p, session->resumption_key_len);
3973 p += session->resumption_key_len;
3974
3975#if defined(MBEDTLS_SSL_EARLY_DATA)
3976 if (end - p < 4) {
3977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3978 }
3979 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3980 p += 4;
3981#endif
3982#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3983 if (end - p < 2) {
3984 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3985 }
3986 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3987 p += 2;
3988#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3989
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003990#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003991 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003992#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003993 if (end - p < 8) {
3994 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3995 }
3996 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3997 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003998#endif /* MBEDTLS_HAVE_TIME */
3999
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004000#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004001 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004002
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004003 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4005 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004006
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004007 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
4008 p += 2;
4009
4010 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4012 }
4013
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004014 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004015 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
4016 if (ret != 0) {
4017 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004018 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004019 p += alpn_len;
4020 }
4021#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
4022 }
4023#endif /* MBEDTLS_SSL_SRV_C */
4024
David Horstmanne59f9702024-02-29 16:08:57 +00004025#if defined(MBEDTLS_SSL_CLI_C)
4026 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4027#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4028 size_t hostname_len;
4029 /* load host name */
4030 if (end - p < 2) {
4031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4032 }
4033 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
4034 p += 2;
4035
4036 if (end - p < (long int) hostname_len) {
4037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4038 }
4039 if (hostname_len > 0) {
4040 session->hostname = mbedtls_calloc(1, hostname_len);
4041 if (session->hostname == NULL) {
4042 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4043 }
4044 memcpy(session->hostname, p, hostname_len);
4045 p += hostname_len;
4046 }
4047#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4048
4049#if defined(MBEDTLS_HAVE_TIME)
4050 if (end - p < 8) {
4051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4052 }
4053 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4054 p += 8;
4055#endif
4056 if (end - p < 4) {
4057 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4058 }
4059 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4060 p += 4;
4061
4062 if (end - p < 2) {
4063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4064 }
4065 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4066 p += 2;
4067
4068 if (end - p < (long int) session->ticket_len) {
4069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4070 }
4071 if (session->ticket_len > 0) {
4072 session->ticket = mbedtls_calloc(1, session->ticket_len);
4073 if (session->ticket == NULL) {
4074 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4075 }
4076 memcpy(session->ticket, p, session->ticket_len);
4077 p += session->ticket_len;
4078 }
4079 }
4080#endif /* MBEDTLS_SSL_CLI_C */
4081
4082 return 0;
4083
4084}
4085#else /* MBEDTLS_SSL_SESSION_TICKETS */
4086MBEDTLS_CHECK_RETURN_CRITICAL
4087static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4088 unsigned char *buf,
4089 size_t buf_len,
4090 size_t *olen)
4091{
4092 ((void) session);
4093 ((void) buf);
4094 ((void) buf_len);
4095 *olen = 0;
4096 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4097}
4098
4099static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritius93b2c322023-01-24 17:48:29 +01004100 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004101 size_t buf_len)
4102{
4103 ((void) session);
4104 ((void) buf);
4105 ((void) buf_len);
4106 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4107}
4108#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4109#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4110
Paul Bakker5121ce52009-01-03 21:22:43 +00004111/*
Hanno Beckera835da52019-05-16 12:39:07 +01004112 * Define ticket header determining Mbed TLS version
4113 * and structure of the ticket.
4114 */
4115
Hanno Becker94ef3b32019-05-16 12:50:45 +01004116/*
Hanno Becker50b59662019-05-28 14:30:45 +01004117 * Define bitflag determining compile-time settings influencing
4118 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004119 */
4120
Hanno Becker50b59662019-05-28 14:30:45 +01004121#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004122#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004123#else
Hanno Becker3e088662019-05-29 11:10:18 +01004124#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004125#endif /* MBEDTLS_HAVE_TIME */
4126
4127#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004128#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004129#else
Hanno Becker3e088662019-05-29 11:10:18 +01004130#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004131#endif /* MBEDTLS_X509_CRT_PARSE_C */
4132
David Horstmann5c5a32f2024-02-13 17:53:35 +00004133#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004134#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004135#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004136#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004137#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4138
Hanno Becker94ef3b32019-05-16 12:50:45 +01004139#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004140#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004141#else
Hanno Becker3e088662019-05-29 11:10:18 +01004142#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004143#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4144
4145#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004146#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004147#else
Hanno Becker3e088662019-05-29 11:10:18 +01004148#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004149#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4150
Hanno Becker94ef3b32019-05-16 12:50:45 +01004151#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004152#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004153#else
Hanno Becker3e088662019-05-29 11:10:18 +01004154#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004155#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4156
Hanno Becker94ef3b32019-05-16 12:50:45 +01004157#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4158#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4159#else
4160#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4161#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4162
David Horstmann92b258b2024-02-13 17:23:34 +00004163#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4164#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4165#else
4166#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4167#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4168
4169#if defined(MBEDTLS_SSL_EARLY_DATA)
4170#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4171#else
4172#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4173#endif /* MBEDTLS_SSL_EARLY_DATA */
4174
4175#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4176#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4177#else
4178#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4179#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4180
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004181#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4182 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004183#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4184#else
4185#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4186#endif /* MBEDTLS_SSL_ALPN */
4187
Hanno Becker3e088662019-05-29 11:10:18 +01004188#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4189#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4190#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4191#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004192#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4193#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004194#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004195#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4196#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4197#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004198#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004199
Hanno Becker50b59662019-05-28 14:30:45 +01004200#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 ((uint16_t) ( \
4202 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4203 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4204 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4205 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4206 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4207 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004208 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004209 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4210 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004211 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4212 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4213 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4214 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004215 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004216 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004217 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004218
Chien Wong4e9683e2023-12-28 17:07:43 +08004219static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004220 MBEDTLS_VERSION_MAJOR,
4221 MBEDTLS_VERSION_MINOR,
4222 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4224 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004225};
Hanno Beckera835da52019-05-16 12:39:07 +01004226
4227/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004228 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004229 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004230 *
David Horstmanncb01b362024-02-29 17:31:46 +00004231 * TLS 1.2 session:
4232 *
4233 * struct {
4234 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4235 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4236 * uint32 ticket_lifetime;
4237 * #endif
4238 * } ClientOnlyData;
4239 *
4240 * struct {
4241 * #if defined(MBEDTLS_HAVE_TIME)
4242 * uint64 start_time;
4243 * #endif
4244 * uint8 session_id_len; // at most 32
4245 * opaque session_id[32];
4246 * opaque master[48]; // fixed length in the standard
4247 * uint32 verify_result;
4248 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4249 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4250 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004251 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004252 * opaque peer_cert_digest<0..2^8-1>
4253 * #endif
4254 * select (endpoint) {
4255 * case client: ClientOnlyData;
4256 * case server: uint64 ticket_creation_time;
4257 * };
4258 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4259 * uint8 mfl_code; // up to 255 according to standard
4260 * #endif
4261 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4262 * uint8 encrypt_then_mac; // 0 or 1
4263 * #endif
4264 * } serialized_session_tls12;
4265 *
4266 *
4267 * TLS 1.3 Session:
4268 *
4269 * struct {
4270 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4271 * opaque hostname<0..2^16-1>;
4272 * #endif
4273 * #if defined(MBEDTLS_HAVE_TIME)
4274 * uint64 ticket_reception_time;
4275 * #endif
4276 * uint32 ticket_lifetime;
4277 * opaque ticket<1..2^16-1>;
4278 * } ClientOnlyData;
4279 *
4280 * struct {
4281 * uint32 ticket_age_add;
4282 * uint8 ticket_flags;
4283 * opaque resumption_key<0..255>;
4284 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4285 * uint32 max_early_data_size;
4286 * #endif
4287 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4288 * uint16 record_size_limit;
4289 * #endif
4290 * select ( endpoint ) {
4291 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004292 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004293 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004294 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004295 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004296 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004297 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004298 * #endif
4299 * };
4300 * } serialized_session_tls13;
4301 *
4302 *
4303 * SSL session:
4304 *
4305 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004306 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004307 * opaque mbedtls_version[3]; // library version: major, minor, patch
4308 * opaque session_format[2]; // library-version specific 16-bit field
4309 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004310 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004311 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004312 * Note: When updating the format, remember to keep
4313 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004314 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004315 * // In this version, `session_format` determines
4316 * // the setting of those compile-time
4317 * // configuration options which influence
4318 * // the structure of mbedtls_ssl_session.
4319 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004320 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004321 * // - TLS 1.2 (0x0303)
4322 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004323 * uint8_t endpoint;
4324 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004325 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004326 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004327 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004328 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004330 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004331 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004332 *
4333 * };
4334 *
4335 * } serialized_session;
4336 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004337 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004338
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004339MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004340static int ssl_session_save(const mbedtls_ssl_session *session,
4341 unsigned char omit_header,
4342 unsigned char *buf,
4343 size_t buf_len,
4344 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004345{
4346 unsigned char *p = buf;
4347 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004348 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004349#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4350 size_t out_len;
4351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4352#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (session == NULL) {
4354 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4355 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004358 /*
4359 * Add Mbed TLS version identifier
4360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (used <= buf_len) {
4364 memcpy(p, ssl_serialized_session_header,
4365 sizeof(ssl_serialized_session_header));
4366 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004367 }
4368 }
4369
4370 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004371 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004372 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004373 used += 1 /* TLS version */
4374 + 1 /* endpoint */
4375 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (used <= buf_len) {
4377 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004378 *p++ = session->endpoint;
4379 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4380 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004381 }
4382
4383 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004384 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004386#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 case MBEDTLS_SSL_VERSION_TLS1_2:
4388 used += ssl_tls12_session_save(session, p, remaining_len);
4389 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004390#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4391
Jerry Yu251a12e2022-07-13 15:15:48 +08004392#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 case MBEDTLS_SSL_VERSION_TLS1_3:
4394 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4395 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4396 return ret;
4397 }
4398 used += out_len;
4399 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004400#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 default:
4403 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004404 }
4405
4406 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (used > buf_len) {
4408 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4409 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004412}
4413
4414/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004415 * Public wrapper for ssl_session_save()
4416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004417int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4418 unsigned char *buf,
4419 size_t buf_len,
4420 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004421{
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004423}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004424
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004425/*
4426 * Deserialize session, see mbedtls_ssl_session_save() for format.
4427 *
4428 * This internal version is wrapped by a public function that cleans up in
4429 * case of error, and has an extra option omit_header.
4430 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004431MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004432static int ssl_session_load(mbedtls_ssl_session *session,
4433 unsigned char omit_header,
4434 const unsigned char *buf,
4435 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004436{
4437 const unsigned char *p = buf;
4438 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004439 size_t remaining_len;
4440
4441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (session == NULL) {
4443 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4444 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004447 /*
4448 * Check Mbed TLS version identifier
4449 */
4450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4452 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004453 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004454
4455 if (memcmp(p, ssl_serialized_session_header,
4456 sizeof(ssl_serialized_session_header)) != 0) {
4457 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4458 }
4459 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004460 }
4461
4462 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004463 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004464 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004465 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4467 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004468 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004469 session->endpoint = *p++;
4470 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4471 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004472
4473 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004474 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004476#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 case MBEDTLS_SSL_VERSION_TLS1_2:
4478 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004479#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4480
Jerry Yu438ddd82022-07-07 06:55:50 +00004481#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 case MBEDTLS_SSL_VERSION_TLS1_3:
4483 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004484#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4485
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 default:
4487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004488 }
4489}
4490
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004491/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004492 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004494int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4495 const unsigned char *buf,
4496 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004497{
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (ret != 0) {
4501 mbedtls_ssl_session_free(session);
4502 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004503
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004505}
4506
4507/*
Paul Bakker1961b702013-01-25 14:49:24 +01004508 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004509 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004511static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004512{
4513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4514
Ronald Cron66dbf912022-02-02 15:33:46 +01004515 /*
4516 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004517 * that were written into the output buffer by the previous handshake step,
4518 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004519 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4520 * We proceed to the next handshake step only when all data from the
4521 * previous one have been sent to the peer, thus we make sure that this is
4522 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4523 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4524 * we have to wait before to go ahead.
4525 * In the case of TLS 1.3, handshake step handlers do not send data to the
4526 * peer. Data are only sent here and through
4527 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004528 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4531 return ret;
4532 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004533
4534#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4536 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4537 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4538 return ret;
4539 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004540 }
4541#endif /* MBEDTLS_SSL_PROTO_DTLS */
4542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004544}
4545
Gilles Peskine449bd832023-01-11 14:50:10 +01004546int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004547{
Hanno Becker41934dd2021-08-07 19:13:43 +01004548 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004551 ssl->conf == NULL ||
4552 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4554 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004555 }
4556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ret = ssl_prepare_handshake_step(ssl);
4558 if (ret != 0) {
4559 return ret;
4560 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 ret = mbedtls_ssl_handle_pending_alert(ssl);
4563 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004564 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 }
Jerry Yue7047812021-09-13 19:26:39 +08004566
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004567 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4568 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4569 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004571#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4573 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004574 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004575
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004577 case MBEDTLS_SSL_HELLO_REQUEST:
4578 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004579 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004580 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004581
Ronald Cron9f0fba32022-02-10 16:45:15 +01004582 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004584 break;
4585
4586 default:
4587#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4589 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4590 } else {
4591 ret = mbedtls_ssl_handshake_client_step(ssl);
4592 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004593#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004595#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004597#endif
4598 }
Jerry Yub9930e72021-08-06 17:11:51 +08004599 }
Ronald Cron6291b232023-03-08 15:51:25 +01004600#endif /* MBEDTLS_SSL_CLI_C */
4601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004602#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004604#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4605 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004607 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 ret = mbedtls_ssl_handshake_server_step(ssl);
4609 }
Ronald Cron6291b232023-03-08 15:51:25 +01004610#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4611 ret = mbedtls_ssl_handshake_server_step(ssl);
4612#else
4613 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004614#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004615 }
4616#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004619 /* handshake_step return error. And it is same
4620 * with alert_reason.
4621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (ssl->send_alert) {
4623 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004624 goto cleanup;
4625 }
4626 }
4627
4628cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004630}
4631
4632/*
4633 * Perform the SSL handshake
4634 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004635int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004636{
4637 int ret = 0;
4638
Hanno Beckera817ea42020-10-20 15:20:23 +01004639 /* Sanity checks */
4640
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 if (ssl == NULL || ssl->conf == NULL) {
4642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4643 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004644
Hanno Beckera817ea42020-10-20 15:20:23 +01004645#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4647 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4648 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4649 "mbedtls_ssl_set_timer_cb() for DTLS"));
4650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004651 }
4652#endif /* MBEDTLS_SSL_PROTO_DTLS */
4653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004655
Hanno Beckera817ea42020-10-20 15:20:23 +01004656 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4658 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004661 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 }
Paul Bakker1961b702013-01-25 14:49:24 +01004663 }
4664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004668}
4669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670#if defined(MBEDTLS_SSL_RENEGOTIATION)
4671#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004672/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004673 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004674 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004675MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004676static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004677{
Janos Follath865b3eb2019-12-16 11:46:15 +00004678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004681
4682 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004683 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4684 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4687 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4688 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004689 }
4690
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004694}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004696
4697/*
4698 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 * - any side: calling mbedtls_ssl_renegotiate(),
4700 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4701 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004702 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004703 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004707{
Janos Follath865b3eb2019-12-16 11:46:15 +00004708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004709
Gilles Peskine449bd832023-01-11 14:50:10 +01004710 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if ((ret = ssl_handshake_init(ssl)) != 0) {
4713 return ret;
4714 }
Paul Bakker48916f92012-09-16 19:57:18 +00004715
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004716 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4717 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4720 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4721 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004722 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004724 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004726 }
4727#endif
4728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4730 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4733 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4734 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004735 }
4736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004740}
4741
4742/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004743 * Renegotiate current connection on client,
4744 * or request renegotiation on server
4745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004747{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004748 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (ssl == NULL || ssl->conf == NULL) {
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4752 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004755 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4757 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4759 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004762
4763 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (ssl->out_left != 0) {
4765 return mbedtls_ssl_flush_output(ssl);
4766 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004767
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004769 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004771
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004772#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004773 /*
4774 * On client, either start the renegotiation process or,
4775 * if already in progress, continue the handshake
4776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4778 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004780 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004781
4782 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4783 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4784 return ret;
4785 }
4786 } else {
4787 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4788 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4789 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004790 }
4791 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004795}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004799{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004800 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004803 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004805
Valerio Setti6f0441d2023-07-03 12:11:36 +02004806#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Brett Warrene0edc842021-08-17 09:53:13 +01004807#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (ssl->handshake->group_list_heap_allocated) {
4809 mbedtls_free((void *) handshake->group_list);
4810 }
Brett Warrene0edc842021-08-17 09:53:13 +01004811 handshake->group_list = NULL;
4812#endif /* MBEDTLS_DEPRECATED_REMOVED */
Valerio Setti6f0441d2023-07-03 12:11:36 +02004813#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Brett Warrene0edc842021-08-17 09:53:13 +01004814
Ronald Crone68ab4f2022-10-05 12:46:29 +02004815#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004816#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (ssl->handshake->sig_algs_heap_allocated) {
4818 mbedtls_free((void *) handshake->sig_algs);
4819 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004820 handshake->sig_algs = NULL;
4821#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004822#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (ssl->handshake->certificate_request_context) {
4824 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004825 }
4826#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004827#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004828
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004829#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4831 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004832 handshake->async_in_progress = 0;
4833 }
4834#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4835
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004836#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004837#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004839#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004840 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004841#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004842#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01004843#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004846#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004847 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004848#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004849#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004850
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004851#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004853#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004854#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004855 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004857#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004858
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004859#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004860#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004862 /*
4863 * Opaque keys are not stored in the handshake's data and it's the user
4864 * responsibility to destroy them. Clear ones, instead, are created by
4865 * the TLS library and should be destroyed at the same level
4866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4868 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004869 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004870 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4871#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004873#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004874#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004876 handshake->ecjpake_cache = NULL;
4877 handshake->ecjpake_cache_len = 0;
4878#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004879#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004880
Valerio Setti7aeec542023-07-05 18:57:21 +02004881#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004882 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004883 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004884 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004886#endif
4887
Ronald Cron73fe8df2022-10-05 14:31:43 +02004888#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004889#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004891 /* The maintenance of the external PSK key slot is the
4892 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->handshake->psk_opaque_is_internal) {
4894 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004895 ssl->handshake->psk_opaque_is_internal = 0;
4896 }
4897 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4898 }
Neil Armstronge952a302022-05-03 10:22:14 +02004899#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004901 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004902 }
Neil Armstronge952a302022-05-03 10:22:14 +02004903#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004904#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004906#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4907 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004908 /*
4909 * Free only the linked list wrapper, not the keys themselves
4910 * since the belong to the SNI callback
4911 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004914
Gilles Peskineeccd8882020-03-10 12:19:08 +01004915#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4917 if (handshake->ecrs_peer_cert != NULL) {
4918 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4919 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004920 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004921#endif
4922
Hanno Becker75173122019-02-06 16:18:31 +00004923#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4924 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004926#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4927
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004928#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4930 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004931#endif /* MBEDTLS_SSL_CLI_C &&
4932 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004933
4934#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_ssl_flight_free(handshake->flight);
4936 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004937#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004938
Valerio Settiea59c432023-07-25 11:14:03 +02004939#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004940 if (handshake->xxdh_psa_privkey_is_external == 0) {
4941 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 }
Valerio Settiea59c432023-07-25 11:14:03 +02004943#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004944
Ronald Cron6f135e12021-12-08 16:57:54 +01004945#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 mbedtls_ssl_transform_free(handshake->transform_handshake);
4947 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004948#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4950 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004951#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004952#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004953
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004954
4955#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4956 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4957 * processes datagrams and the fact that a datagram is allowed to have
4958 * several records in it, it is possible that the I/O buffers are not
4959 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4961 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004962#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004963
Jerry Yuba9c7272021-10-30 11:54:10 +08004964 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 mbedtls_platform_zeroize(handshake,
4966 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004967}
4968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004970{
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004972 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004975#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004977#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004978
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004979#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004980#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4981 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004983#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004985#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004986
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004987#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4988 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004989 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004990#endif
4991
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004993}
4994
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004995#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004996
4997#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4998#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4999#else
5000#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
5001#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5002
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005003#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005004
5005#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5006#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
5007#else
5008#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
5009#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5010
5011#if defined(MBEDTLS_SSL_ALPN)
5012#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
5013#else
5014#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
5015#endif /* MBEDTLS_SSL_ALPN */
5016
5017#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
5018#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
5019#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
5020#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
5021
5022#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 ((uint32_t) ( \
5024 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
5025 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
5026 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
5027 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
5028 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
5029 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
5030 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
5031 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005032
Chien Wong4e9683e2023-12-28 17:07:43 +08005033static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005034 MBEDTLS_VERSION_MAJOR,
5035 MBEDTLS_VERSION_MINOR,
5036 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5038 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5039 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5040 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5041 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005042};
5043
Paul Bakker5121ce52009-01-03 21:22:43 +00005044/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005045 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005046 *
5047 * The format of the serialized data is:
5048 * (in the presentation language of TLS, RFC 8446 section 3)
5049 *
5050 * // header
5051 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005052 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005053 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005054 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005055 * Note: When updating the format, remember to keep these
5056 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005057 *
5058 * // session sub-structure
5059 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5060 * // transform sub-structure
5061 * uint8 random[64]; // ServerHello.random+ClientHello.random
5062 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5063 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5064 * // fields from ssl_context
5065 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5066 * uint64 in_window_top; // DTLS: last validated record seq_num
5067 * uint64 in_window; // DTLS: bitmask for replay protection
5068 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5069 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5070 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5071 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5072 *
5073 * Note that many fields of the ssl_context or sub-structures are not
5074 * serialized, as they fall in one of the following categories:
5075 *
5076 * 1. forced value (eg in_left must be 0)
5077 * 2. pointer to dynamically-allocated memory (eg session, transform)
5078 * 3. value can be re-derived from other data (eg session keys from MS)
5079 * 4. value was temporary (eg content of input buffer)
5080 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005082int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5083 unsigned char *buf,
5084 size_t buf_len,
5085 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005086{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005087 unsigned char *p = buf;
5088 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005089 size_t session_len;
5090 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005091
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005092 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005093 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5094 * this function's documentation.
5095 *
5096 * These are due to assumptions/limitations in the implementation. Some of
5097 * them are likely to stay (no handshake in progress) some might go away
5098 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005099 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005100 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5102 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005104 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 if (ssl->handshake != NULL) {
5106 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005108 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005109 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (ssl->transform == NULL || ssl->session == NULL) {
5111 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005113 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005114 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (mbedtls_ssl_check_pending(ssl) != 0) {
5116 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005118 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (ssl->out_left != 0) {
5120 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005122 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005123 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5125 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5126 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005127 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005128 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5130 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5131 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005132 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005133 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5135 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005137 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005138 /* Renegotiation must not be enabled */
5139#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5141 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5142 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005143 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005144#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005145
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005146 /*
5147 * Version and format identifier
5148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (used <= buf_len) {
5152 memcpy(p, ssl_serialized_context_header,
5153 sizeof(ssl_serialized_context_header));
5154 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005155 }
5156
5157 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005158 * Session (length + data)
5159 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5161 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5162 return ret;
5163 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005164
5165 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (used <= buf_len) {
5167 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005168 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005169
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 ret = ssl_session_save(ssl->session, 1,
5171 p, session_len, &session_len);
5172 if (ret != 0) {
5173 return ret;
5174 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005175
5176 p += session_len;
5177 }
5178
5179 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005180 * Transform
5181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 used += sizeof(ssl->transform->randbytes);
5183 if (used <= buf_len) {
5184 memcpy(p, ssl->transform->randbytes,
5185 sizeof(ssl->transform->randbytes));
5186 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005187 }
5188
5189#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005190 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005192 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005194 p += ssl->transform->in_cid_len;
5195
5196 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005198 p += ssl->transform->out_cid_len;
5199 }
5200#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5201
5202 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005203 * Saved fields from top-level ssl_context structure
5204 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005205 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (used <= buf_len) {
5207 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005208 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005209 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005210
5211#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5212 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if (used <= buf_len) {
5214 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005215 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005218 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005219 }
5220#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5221
5222#if defined(MBEDTLS_SSL_PROTO_DTLS)
5223 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005225 *p++ = ssl->disable_datagram_packing;
5226 }
5227#endif /* MBEDTLS_SSL_PROTO_DTLS */
5228
Jerry Yuae0b2e22021-10-08 15:21:19 +08005229 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (used <= buf_len) {
5231 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005232 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005233 }
5234
5235#if defined(MBEDTLS_SSL_PROTO_DTLS)
5236 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 if (used <= buf_len) {
5238 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005239 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005240 }
5241#endif /* MBEDTLS_SSL_PROTO_DTLS */
5242
5243#if defined(MBEDTLS_SSL_ALPN)
5244 {
5245 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005247 : 0;
5248
5249 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005251 *p++ = alpn_len;
5252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 if (ssl->alpn_chosen != NULL) {
5254 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005255 p += alpn_len;
5256 }
5257 }
5258 }
5259#endif /* MBEDTLS_SSL_ALPN */
5260
5261 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005262 * Done
5263 */
5264 *olen = used;
5265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if (used > buf_len) {
5267 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5268 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005273}
5274
5275/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005276 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005277 *
5278 * This internal version is wrapped by a public function that cleans up in
5279 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005280 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005282static int ssl_context_load(mbedtls_ssl_context *ssl,
5283 const unsigned char *buf,
5284 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005285{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005286 const unsigned char *p = buf;
5287 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005288 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005290#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005291 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005292#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005293
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005294 /*
5295 * The context should have been freshly setup or reset.
5296 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005297 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005298 * renegotiating, or if the user mistakenly loaded a session first.)
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5301 ssl->session != NULL) {
5302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005303 }
5304
5305 /*
5306 * We can't check that the config matches the initial one, but we can at
5307 * least check it matches the requirements for serializing.
5308 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005309 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005310#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005311 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005312#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005313 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5314 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5315 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5316 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005318 }
5319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005321
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005322 /*
5323 * Check version identifier
5324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005327 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005328
5329 if (memcmp(p, ssl_serialized_context_header,
5330 sizeof(ssl_serialized_context_header)) != 0) {
5331 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5332 }
5333 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005334
5335 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005336 * Session
5337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if ((size_t) (end - p) < 4) {
5339 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5340 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005341
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005342 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005343 p += 4;
5344
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005345 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005346 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005347 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005348 ssl->session_in = ssl->session;
5349 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005350 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005351
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 if ((size_t) (end - p) < session_len) {
5353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5354 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 ret = ssl_session_load(ssl->session, 1, p, session_len);
5357 if (ret != 0) {
5358 mbedtls_ssl_session_free(ssl->session);
5359 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005360 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005361
5362 p += session_len;
5363
5364 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365 * Transform
5366 */
5367
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005368 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005369 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005371 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005372 ssl->transform_in = ssl->transform;
5373 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005374 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005375#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005376
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005377#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5379 if (prf_func == NULL) {
5380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5381 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005382
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005383 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5386 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 ret = ssl_tls12_populate_transform(ssl->transform,
5389 ssl->session->ciphersuite,
5390 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005391#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005393#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 prf_func,
5395 p, /* currently pointing to randbytes */
5396 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5397 ssl->conf->endpoint,
5398 ssl);
5399 if (ret != 0) {
5400 return ret;
5401 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005402#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005404
5405#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5406 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005407 if ((size_t) (end - p) < 1) {
5408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5409 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005410
5411 ssl->transform->in_cid_len = *p++;
5412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5415 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005418 p += ssl->transform->in_cid_len;
5419
5420 ssl->transform->out_cid_len = *p++;
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5424 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005427 p += ssl->transform->out_cid_len;
5428#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5429
5430 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005431 * Saved fields from top-level ssl_context structure
5432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 if ((size_t) (end - p) < 4) {
5434 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5435 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005436
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005437 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005438 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005439
5440#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 if ((size_t) (end - p) < 16) {
5442 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5443 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005444
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005445 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005446 p += 8;
5447
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005448 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005449 p += 8;
5450#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5451
5452#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005453 if ((size_t) (end - p) < 1) {
5454 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5455 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005456
5457 ssl->disable_datagram_packing = *p++;
5458#endif /* MBEDTLS_SSL_PROTO_DTLS */
5459
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5462 }
5463 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5464 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005465
5466#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if ((size_t) (end - p) < 2) {
5468 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5469 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005470
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005471 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005472 p += 2;
5473#endif /* MBEDTLS_SSL_PROTO_DTLS */
5474
5475#if defined(MBEDTLS_SSL_ALPN)
5476 {
5477 uint8_t alpn_len;
5478 const char **cur;
5479
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if ((size_t) (end - p) < 1) {
5481 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5482 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005483
5484 alpn_len = *p++;
5485
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005487 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5489 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005490 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005491 ssl->alpn_chosen = *cur;
5492 break;
5493 }
5494 }
5495 }
5496
5497 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5499 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5500 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005501
5502 p += alpn_len;
5503 }
5504#endif /* MBEDTLS_SSL_ALPN */
5505
5506 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005507 * Forced fields from top-level ssl_context structure
5508 *
5509 * Most of them already set to the correct value by mbedtls_ssl_init() and
5510 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5511 */
5512 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005513 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005514
Hanno Becker361b10d2019-08-30 10:42:49 +01005515 /* Adjust pointers for header fields of outgoing records to
5516 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005518
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005519#if defined(MBEDTLS_SSL_PROTO_DTLS)
5520 ssl->in_epoch = 1;
5521#endif
5522
5523 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5524 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005525 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5526 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (ssl->handshake != NULL) {
5528 mbedtls_ssl_handshake_free(ssl);
5529 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005530 ssl->handshake = NULL;
5531 }
5532
5533 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005534 * Done - should have consumed entire buffer
5535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (p != end) {
5537 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5538 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005539
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005541}
5542
5543/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005544 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005545 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005546int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5547 const unsigned char *buf,
5548 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005549{
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 if (ret != 0) {
5553 mbedtls_ssl_free(context);
5554 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005557}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005558#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005559
5560/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005561 * Free an SSL context
5562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005563void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005564{
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005566 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005570
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005572#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5573 size_t out_buf_len = ssl->out_buf_len;
5574#else
5575 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5576#endif
5577
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005578 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005579 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005580 }
5581
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005583#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5584 size_t in_buf_len = ssl->in_buf_len;
5585#else
5586 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5587#endif
5588
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005589 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005590 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005591 }
5592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 if (ssl->transform) {
5594 mbedtls_ssl_transform_free(ssl->transform);
5595 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005596 }
5597
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (ssl->handshake) {
5599 mbedtls_ssl_handshake_free(ssl);
5600 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005601
5602#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5604 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005605#endif
5606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 mbedtls_ssl_session_free(ssl->session_negotiate);
5608 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005609 }
5610
Ronald Cron6f135e12021-12-08 16:57:54 +01005611#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 mbedtls_ssl_transform_free(ssl->transform_application);
5613 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005614#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005615
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 if (ssl->session) {
5617 mbedtls_ssl_session_free(ssl->session);
5618 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005619 }
5620
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005621#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskinee61852e2025-02-12 23:28:48 +01005622 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005623#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005624
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005625#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005627#endif
5628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005630
Paul Bakker86f04f42013-02-14 11:20:09 +01005631 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005633}
5634
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005635/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005636 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005638void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005639{
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005641}
5642
Gilles Peskineae270bf2021-06-02 00:05:29 +02005643/* The selection should be the same as mbedtls_x509_crt_profile_default in
5644 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005645 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005646 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005647 * about this list.
5648 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005649static const uint16_t ssl_preset_default_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005650#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Brett Warrene0edc842021-08-17 09:53:13 +01005651 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005652#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005653#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005654 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005655#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005656#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005657 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005658#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005659#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Brett Warrene0edc842021-08-17 09:53:13 +01005660 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005661#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005662#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005663 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005664#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005665#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005666 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005667#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005668#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005669 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005670#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005671#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005672 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005673#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005674#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005675 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5676 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5677 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5678 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5679 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5680#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005681 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005682};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005683
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005684static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005685 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5686 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5687 0
5688};
5689
Ronald Crone68ab4f2022-10-05 12:46:29 +02005690#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005691
Jerry Yu909df7b2022-01-22 11:56:27 +08005692/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005693 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005694 * rules SHOULD be upheld.
5695 * - No duplicate entries.
5696 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005697 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005698 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005699 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005700static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005701
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005702#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005703 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005704 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005705 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005706 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5707#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005708
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005709#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005710 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005711 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005712 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005713 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5714#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005715
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005716#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005717 defined(MBEDTLS_MD_CAN_SHA512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005718 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005719 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005720 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5721#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005722
Yanray Wang1136fad2023-11-22 16:54:31 +08005723#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005724 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005725#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005726
Yanray Wang1136fad2023-11-22 16:54:31 +08005727#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005728 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005729#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005730
Yanray Wang1136fad2023-11-22 16:54:31 +08005731#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005732 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005733#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005734
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005735#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005736 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005737#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005738
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005739#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005740 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005741#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005742
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005743#if defined(MBEDTLS_RSA_C) && defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005744 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005745#endif /* MBEDTLS_RSA_C && MBEDTLS_MD_CAN_SHA256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005746
Gabor Mezei15b95a62022-05-09 16:37:58 +02005747 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005748};
5749
5750/* NOTICE: see above */
5751#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5752static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005753
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005754#if defined(MBEDTLS_MD_CAN_SHA512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005755#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005757#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005758#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5759 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005760#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005761#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005763#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005764#endif /* MBEDTLS_MD_CAN_SHA512 */
5765
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005766#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005767#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005769#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005770#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5771 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005772#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005773#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005775#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005776#endif /* MBEDTLS_MD_CAN_SHA384 */
5777
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005778#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005779#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005781#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005782#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5783 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005784#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005785#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005787#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005788#endif /* MBEDTLS_MD_CAN_SHA256 */
5789
Gabor Mezei15b95a62022-05-09 16:37:58 +02005790 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005791};
5792#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005793
Jerry Yu909df7b2022-01-22 11:56:27 +08005794/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005795static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005796
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005797#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005798 defined(MBEDTLS_MD_CAN_SHA256) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005799 defined(MBEDTLS_ECP_HAVE_SECP256R1)
Jerry Yu909df7b2022-01-22 11:56:27 +08005800 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005801 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5802#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005803
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005804#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Valerio Setti45d56f32023-07-13 17:23:20 +02005805 defined(MBEDTLS_MD_CAN_SHA384) && \
Valerio Settidb6b4db2023-09-01 09:20:51 +02005806 defined(MBEDTLS_ECP_HAVE_SECP384R1)
Jerry Yu53037892022-01-25 11:02:06 +08005807 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005808 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5809#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005810
Gabor Mezei15b95a62022-05-09 16:37:58 +02005811 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005812};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005813
Jerry Yu909df7b2022-01-22 11:56:27 +08005814/* NOTICE: see above */
5815#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5816static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005817
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005818#if defined(MBEDTLS_MD_CAN_SHA256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005819#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005821#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005822#endif /* MBEDTLS_MD_CAN_SHA256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005823
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01005824#if defined(MBEDTLS_MD_CAN_SHA384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005825#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005827#endif
Yanray Wang1136fad2023-11-22 16:54:31 +08005828#endif /* MBEDTLS_MD_CAN_SHA384 */
5829
Gabor Mezei15b95a62022-05-09 16:37:58 +02005830 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005831};
Jerry Yu909df7b2022-01-22 11:56:27 +08005832#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5833
Ronald Crone68ab4f2022-10-05 12:46:29 +02005834#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005835
Chien Wong4e9683e2023-12-28 17:07:43 +08005836static const uint16_t ssl_preset_suiteb_groups[] = {
Valerio Settidb6b4db2023-09-01 09:20:51 +02005837#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005838 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005839#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02005840#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Brett Warrene0edc842021-08-17 09:53:13 +01005841 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005842#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005843 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005844};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005845
Ronald Crone68ab4f2022-10-05 12:46:29 +02005846#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005847/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005848 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005849MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005850static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005851{
5852 size_t i, j;
5853 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5856 for (j = 0; j < i; j++) {
5857 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005858 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 }
5860 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5861 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5862 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005863 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005864 }
5865 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005867}
5868
Ronald Crone68ab4f2022-10-05 12:46:29 +02005869#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005870
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005871/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005872 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005874int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5875 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005876{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005877#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005879#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005880
Ronald Crone68ab4f2022-10-05 12:46:29 +02005881#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5883 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5884 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005885 }
5886
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5888 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5889 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005890 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005891
5892#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5894 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5895 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005896 }
5897
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5899 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5900 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005901 }
5902#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005903#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005904
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005905 /* Use the functions here so that they are covered in tests,
5906 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 mbedtls_ssl_conf_endpoint(conf, endpoint);
5908 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005909
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005910 /*
5911 * Things that are common to all presets
5912 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005913#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005915 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5916#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Crond67f8012024-08-28 07:45:57 +02005917 mbedtls_ssl_conf_session_tickets(conf, MBEDTLS_SSL_SESSION_TICKETS_ENABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005918#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cronc46edd42024-08-28 16:54:42 +02005919 /* Contrary to TLS 1.2 tickets, TLS 1.3 NewSessionTicket message
5920 * handling is disabled by default in Mbed TLS 3.6.x for backward
5921 * compatibility with client applications developed using Mbed TLS 3.5
5922 * or earlier with the default configuration.
5923 *
5924 * Up to Mbed TLS 3.5, in the default configuration TLS 1.3 was
5925 * disabled, and a Mbed TLS client with the default configuration would
5926 * establish a TLS 1.2 connection with a TLS 1.2 and TLS 1.3 capable
5927 * server.
5928 *
5929 * Starting with Mbed TLS 3.6.0, TLS 1.3 is enabled by default, and thus
5930 * an Mbed TLS client with the default configuration establishes a
5931 * TLS 1.3 connection with a TLS 1.2 and TLS 1.3 capable server. If
5932 * following the handshake the TLS 1.3 server sends NewSessionTicket
5933 * messages and the Mbed TLS client processes them, this results in
5934 * Mbed TLS high level APIs (mbedtls_ssl_read(),
5935 * mbedtls_ssl_handshake(), ...) to eventually return an
5936 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET non fatal error code
5937 * (see the documentation of mbedtls_ssl_read() for more information on
5938 * that error code). Applications unaware of that TLS 1.3 specific non
5939 * fatal error code are then failing.
5940 */
Ronald Cron9f44c882024-08-28 16:44:10 +02005941 mbedtls_ssl_conf_tls13_enable_signal_new_session_tickets(
5942 conf, MBEDTLS_SSL_TLS1_3_SIGNAL_NEW_SESSION_TICKETS_DISABLED);
Ronald Cronbedddd72024-08-27 14:18:50 +02005943#endif
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005944#endif
5945 }
5946#endif
5947
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005948#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5949 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5950#endif
5951
5952#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5953 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5954#endif
5955
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005956#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005957 conf->f_cookie_write = ssl_cookie_write_dummy;
5958 conf->f_cookie_check = ssl_cookie_check_dummy;
5959#endif
5960
5961#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5962 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5963#endif
5964
Janos Follath088ce432017-04-10 12:42:31 +01005965#if defined(MBEDTLS_SSL_SRV_C)
5966 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005967 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005968#endif
5969
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005970#if defined(MBEDTLS_SSL_PROTO_DTLS)
5971 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5972 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5973#endif
5974
5975#if defined(MBEDTLS_SSL_RENEGOTIATION)
5976 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 memset(conf->renego_period, 0x00, 2);
5978 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005979#endif
5980
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005981#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005983 const unsigned char dhm_p[] =
5984 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5985 const unsigned char dhm_g[] =
5986 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5989 dhm_p, sizeof(dhm_p),
5990 dhm_g, sizeof(dhm_g))) != 0) {
5991 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005992 }
5993 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005994#endif
5995
Ronald Cron6f135e12021-12-08 16:57:54 +01005996#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005997
5998#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005999 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08006000#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08006001 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08006002#endif
6003#endif /* MBEDTLS_SSL_EARLY_DATA */
6004
Jerry Yud0766ec2022-09-22 10:46:57 +08006005#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08006006 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08006008#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01006009 /*
6010 * Allow all TLS 1.3 key exchange modes by default.
6011 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00006012 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01006013#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01006014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006016#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00006017 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00006018 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006019#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00006021#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00006023#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01006024 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6025 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006026#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
6027 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6028 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
6029#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
6030 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6031 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
6032#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00006034#endif
6035 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04006036
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006037 /*
6038 * Preset-specific defaults
6039 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006041 /*
6042 * NSA Suite B
6043 */
6044 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006045
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006046 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006047
6048#if defined(MBEDTLS_X509_CRT_PARSE_C)
6049 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006050#endif
6051
Ronald Crone68ab4f2022-10-05 12:46:29 +02006052#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006055 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006059#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006060
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006061#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006062 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006063#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006064 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006065 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006066
6067 /*
6068 * Default
6069 */
6070 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006071
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006072 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006073
6074#if defined(MBEDTLS_X509_CRT_PARSE_C)
6075 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6076#endif
6077
Ronald Crone68ab4f2022-10-05 12:46:29 +02006078#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006079#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006081 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006083#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006085#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006086
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006087#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006088 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006089#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006090 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006091
6092#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6093 conf->dhm_min_bitlen = 1024;
6094#endif
6095 }
6096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006098}
6099
6100/*
6101 * Free mbedtls_ssl_config
6102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006103void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006104{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006105 if (conf == NULL) {
6106 return;
6107 }
6108
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006109#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 mbedtls_mpi_free(&conf->dhm_P);
6111 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006112#endif
6113
Ronald Cron73fe8df2022-10-05 14:31:43 +02006114#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006115#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006117 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6118 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006119#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006121 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006122 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006123 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006124 }
6125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006127 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006128 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006129 conf->psk_identity_len = 0;
6130 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006131#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006132
6133#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006135#endif
6136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006138}
6139
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006140#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006141 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006142/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006143 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006145unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006146{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006147#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6149 return MBEDTLS_SSL_SIG_RSA;
6150 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006151#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006152#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6154 return MBEDTLS_SSL_SIG_ECDSA;
6155 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006156#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006158}
6159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006161{
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006163 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006165 case MBEDTLS_PK_ECDSA:
6166 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006168 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006170 }
6171}
6172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006174{
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006176#if defined(MBEDTLS_RSA_C)
6177 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006179#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006180#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006181 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006183#endif
6184 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006186 }
6187}
Valerio Settie9646ec2023-08-02 20:02:28 +02006188#endif /* MBEDTLS_PK_C &&
6189 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006190
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006191/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006192 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006195{
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006197#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006198 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006200#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006201#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006202 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006204#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006205#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006206 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006208#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006209#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006210 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006212#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006213#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006214 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006216#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006217#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006218 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006220#endif
6221 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006223 }
6224}
6225
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006226/*
6227 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6228 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006230{
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006232#if defined(MBEDTLS_MD_CAN_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006233 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006235#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006236#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006237 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006238 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006239#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006240#if defined(MBEDTLS_MD_CAN_SHA224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006241 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006243#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006244#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006245 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006247#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006248#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006249 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006251#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006252#if defined(MBEDTLS_MD_CAN_SHA512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006253 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006255#endif
6256 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006258 }
6259}
6260
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006261/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006262 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006263 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006265int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006266{
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (group_list == NULL) {
6270 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006271 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 for (; *group_list != 0; group_list++) {
6274 if (*group_list == tls_id) {
6275 return 0;
6276 }
6277 }
6278
6279 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006280}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006281
Valerio Setti49e69072023-06-27 17:27:51 +02006282#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006283/*
6284 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006286int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006287{
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006289
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006291 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006292 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006293
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006295}
Valerio Setti49e69072023-06-27 17:27:51 +02006296#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Valerio Setti67419f02023-01-04 16:12:42 +01006297
Valerio Setti18c9fed2022-12-30 17:44:24 +01006298static const struct {
6299 uint16_t tls_id;
6300 mbedtls_ecp_group_id ecp_group_id;
6301 psa_ecc_family_t psa_family;
6302 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006303} tls_id_match_table[] =
6304{
Valerio Settidb6b4db2023-09-01 09:20:51 +02006305#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006306 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006307#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006308#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006309 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006310#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006311#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006312 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006313#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006314#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006315 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006316#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006317#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006318 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006319#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006320#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006321 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006323#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006324 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006325#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006326#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006327 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006328#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006329#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006330 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006331#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006332#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006333 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006334#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006335#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006336 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006337#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006338#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settiacd32c02023-06-29 18:06:29 +02006339 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006340#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006341#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006342 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006343#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006344 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006345};
6346
Gilles Peskine449bd832023-01-11 14:50:10 +01006347int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006348 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006350{
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6352 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006353 if (type != NULL) {
6354 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 }
6356 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006357 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006359 return PSA_SUCCESS;
6360 }
6361 }
6362
6363 return PSA_ERROR_NOT_SUPPORTED;
6364}
6365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006367{
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6369 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006370 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006372 }
6373
6374 return MBEDTLS_ECP_DP_NONE;
6375}
6376
Gilles Peskine449bd832023-01-11 14:50:10 +01006377uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006378{
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6380 i++) {
6381 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006382 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006384 }
6385
6386 return 0;
6387}
6388
Valerio Setti67419f02023-01-04 16:12:42 +01006389#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006390static const struct {
6391 uint16_t tls_id;
6392 const char *name;
6393} tls_id_curve_name_table[] =
6394{
Valerio Setti54e23792023-07-07 10:49:27 +02006395 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6396 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6397 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6398 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6399 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6400 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6401 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6402 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6403 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6404 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6405 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6406 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6407 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006408 { 0, NULL },
6409};
6410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006412{
Valerio Settiacd32c02023-06-29 18:06:29 +02006413 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6414 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6415 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006417 }
6418
6419 return NULL;
6420}
Valerio Setti67419f02023-01-04 16:12:42 +01006421#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006422
Jerry Yu148165c2021-09-24 23:20:59 +08006423#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6425 const mbedtls_md_type_t md,
6426 unsigned char *dst,
6427 size_t dst_len,
6428 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006429{
Ronald Cronf6893e12022-01-07 22:09:01 +01006430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6431 psa_hash_operation_t *hash_operation_to_clone;
6432 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6433
Jerry Yu148165c2021-09-24 23:20:59 +08006434 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006437#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 case MBEDTLS_MD_SHA384:
6439 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6440 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006441#endif
6442
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006443#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 case MBEDTLS_MD_SHA256:
6445 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6446 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006447#endif
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 default:
6450 goto exit;
6451 }
6452
6453 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6454 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006455 goto exit;
6456 }
6457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6459 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006460 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006462
6463exit:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006464#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6465 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006466 (void) ssl;
6467#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006468 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006469}
6470#else /* MBEDTLS_USE_PSA_CRYPTO */
6471
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006472#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006473MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006474static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6475 unsigned char *dst,
6476 size_t dst_len,
6477 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006478{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006479 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006480 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 if (dst_len < 48) {
6483 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6484 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006485
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006486 mbedtls_md_init(&sha384);
6487 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006488 if (ret != 0) {
6489 goto exit;
6490 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006491 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006492 if (ret != 0) {
6493 goto exit;
6494 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006495
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006496 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006497 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498 goto exit;
6499 }
6500
6501 *olen = 48;
6502
6503exit:
6504
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006505 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006507}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006508#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006509
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006510#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006511MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006512static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6513 unsigned char *dst,
6514 size_t dst_len,
6515 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006516{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006517 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006518 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 if (dst_len < 32) {
6521 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6522 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006523
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006524 mbedtls_md_init(&sha256);
6525 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6526 if (ret != 0) {
6527 goto exit;
6528 }
6529 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6530 if (ret != 0) {
6531 goto exit;
6532 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006533
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006534 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6535 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006536 goto exit;
6537 }
6538
6539 *olen = 32;
6540
6541exit:
6542
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006543 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006545}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006546#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6549 const mbedtls_md_type_t md,
6550 unsigned char *dst,
6551 size_t dst_len,
6552 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006553{
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006555
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006556#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 case MBEDTLS_MD_SHA384:
6558 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006559#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006560
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006561#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 case MBEDTLS_MD_SHA256:
6563 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006564#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006565
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 default:
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006567#if !defined(MBEDTLS_MD_CAN_SHA384) && \
6568 !defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 (void) ssl;
6570 (void) dst;
6571 (void) dst_len;
6572 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006575 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006577}
XiaokangQian647719a2021-12-07 09:16:29 +00006578
Jerry Yu148165c2021-09-24 23:20:59 +08006579#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006580
Ronald Crone68ab4f2022-10-05 12:46:29 +02006581#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006582/* mbedtls_ssl_parse_sig_alg_ext()
6583 *
6584 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6585 * value (TLS 1.3 RFC8446):
6586 * enum {
6587 * ....
6588 * ecdsa_secp256r1_sha256( 0x0403 ),
6589 * ecdsa_secp384r1_sha384( 0x0503 ),
6590 * ecdsa_secp521r1_sha512( 0x0603 ),
6591 * ....
6592 * } SignatureScheme;
6593 *
6594 * struct {
6595 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6596 * } SignatureSchemeList;
6597 *
6598 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6599 * value (TLS 1.2 RFC5246):
6600 * enum {
6601 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6602 * sha512(6), (255)
6603 * } HashAlgorithm;
6604 *
6605 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6606 * SignatureAlgorithm;
6607 *
6608 * struct {
6609 * HashAlgorithm hash;
6610 * SignatureAlgorithm signature;
6611 * } SignatureAndHashAlgorithm;
6612 *
6613 * SignatureAndHashAlgorithm
6614 * supported_signature_algorithms<2..2^16-2>;
6615 *
6616 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6617 * generalization of the TLS 1.2 signature algorithm extension.
6618 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6619 * `SignatureScheme` field of TLS 1.3
6620 *
6621 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006622int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6623 const unsigned char *buf,
6624 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006625{
6626 const unsigned char *p = buf;
6627 size_t supported_sig_algs_len = 0;
6628 const unsigned char *supported_sig_algs_end;
6629 uint16_t sig_alg;
6630 uint32_t common_idx = 0;
6631
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6633 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006634 p += 2;
6635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 memset(ssl->handshake->received_sig_algs, 0,
6637 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006640 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 while (p < supported_sig_algs_end) {
6642 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6643 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006644 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6646 sig_alg,
6647 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006648#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6650 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6651 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006652 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006653 }
6654#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006655
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6657 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006660 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6661 common_idx += 1;
6662 }
6663 }
6664 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 if (p != end) {
6666 MBEDTLS_SSL_DEBUG_MSG(1,
6667 ("Signature algorithms extension length misaligned"));
6668 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6669 MBEDTLS_ERR_SSL_DECODE_ERROR);
6670 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006671 }
6672
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 if (common_idx == 0) {
6674 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6675 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6676 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6677 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006678 }
6679
Gabor Mezei15b95a62022-05-09 16:37:58 +02006680 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006682}
6683
Ronald Crone68ab4f2022-10-05 12:46:29 +02006684#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006685
Jerry Yudc7bd172022-02-17 13:44:15 +08006686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6687
6688#if defined(MBEDTLS_USE_PSA_CRYPTO)
6689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6691 mbedtls_svc_key_id_t key,
6692 psa_algorithm_t alg,
6693 const unsigned char *raw_psk, size_t raw_psk_length,
6694 const unsigned char *seed, size_t seed_length,
6695 const unsigned char *label, size_t label_length,
6696 const unsigned char *other_secret,
6697 size_t other_secret_length,
6698 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006699{
6700 psa_status_t status;
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 status = psa_key_derivation_setup(derivation, alg);
6703 if (status != PSA_SUCCESS) {
6704 return status;
6705 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6708 status = psa_key_derivation_input_bytes(derivation,
6709 PSA_KEY_DERIVATION_INPUT_SEED,
6710 seed, seed_length);
6711 if (status != PSA_SUCCESS) {
6712 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006713 }
6714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 if (other_secret != NULL) {
6716 status = psa_key_derivation_input_bytes(derivation,
6717 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6718 other_secret, other_secret_length);
6719 if (status != PSA_SUCCESS) {
6720 return status;
6721 }
6722 }
6723
6724 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006725 status = psa_key_derivation_input_bytes(
6726 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 raw_psk, raw_psk_length);
6728 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006729 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 if (status != PSA_SUCCESS) {
6733 return status;
6734 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 status = psa_key_derivation_input_bytes(derivation,
6737 PSA_KEY_DERIVATION_INPUT_LABEL,
6738 label, label_length);
6739 if (status != PSA_SUCCESS) {
6740 return status;
6741 }
6742 } else {
6743 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 }
6745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 status = psa_key_derivation_set_capacity(derivation, capacity);
6747 if (status != PSA_SUCCESS) {
6748 return status;
6749 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006752}
6753
Andrzej Kurek57d10632022-10-24 10:32:01 -04006754#if defined(PSA_WANT_ALG_SHA_384) || \
6755 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006756MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006757static int tls_prf_generic(mbedtls_md_type_t md_type,
6758 const unsigned char *secret, size_t slen,
6759 const char *label,
6760 const unsigned char *random, size_t rlen,
6761 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006762{
6763 psa_status_t status;
6764 psa_algorithm_t alg;
6765 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6766 psa_key_derivation_operation_t derivation =
6767 PSA_KEY_DERIVATION_OPERATION_INIT;
6768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006770 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006772 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006774
6775 /* Normally a "secret" should be long enough to be impossible to
6776 * find by brute force, and in particular should not be empty. But
6777 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6778 * and for this use case it makes sense to have a 0-length "secret".
6779 * Since the key API doesn't allow importing a key of length 0,
6780 * keep master_key=0, which setup_psa_key_derivation() understands
6781 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006783 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6785 psa_set_key_algorithm(&key_attributes, alg);
6786 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006787
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6789 if (status != PSA_SUCCESS) {
6790 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6791 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006792 }
6793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 status = setup_psa_key_derivation(&derivation,
6795 master_key, alg,
6796 NULL, 0,
6797 random, rlen,
6798 (unsigned char const *) label,
6799 (size_t) strlen(label),
6800 NULL, 0,
6801 dlen);
6802 if (status != PSA_SUCCESS) {
6803 psa_key_derivation_abort(&derivation);
6804 psa_destroy_key(master_key);
6805 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006806 }
6807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6809 if (status != PSA_SUCCESS) {
6810 psa_key_derivation_abort(&derivation);
6811 psa_destroy_key(master_key);
6812 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006813 }
6814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 status = psa_key_derivation_abort(&derivation);
6816 if (status != PSA_SUCCESS) {
6817 psa_destroy_key(master_key);
6818 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 if (!mbedtls_svc_key_id_is_null(master_key)) {
6822 status = psa_destroy_key(master_key);
6823 }
6824 if (status != PSA_SUCCESS) {
6825 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6826 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006829}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006830#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006831#else /* MBEDTLS_USE_PSA_CRYPTO */
6832
Andrzej Kurek57d10632022-10-24 10:32:01 -04006833#if defined(MBEDTLS_MD_C) && \
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006834 (defined(MBEDTLS_MD_CAN_SHA256) || \
6835 defined(MBEDTLS_MD_CAN_SHA384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006836MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006837static int tls_prf_generic(mbedtls_md_type_t md_type,
6838 const unsigned char *secret, size_t slen,
6839 const char *label,
6840 const unsigned char *random, size_t rlen,
6841 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006842{
6843 size_t nb;
6844 size_t i, j, k, md_len;
6845 unsigned char *tmp;
6846 size_t tmp_len = 0;
6847 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6848 const mbedtls_md_info_t *md_info;
6849 mbedtls_md_context_t md_ctx;
6850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6851
Gilles Peskine449bd832023-01-11 14:50:10 +01006852 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6855 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6856 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006859
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 tmp_len = md_len + strlen(label) + rlen;
6861 tmp = mbedtls_calloc(1, tmp_len);
6862 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006863 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6864 goto exit;
6865 }
6866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 nb = strlen(label);
6868 memcpy(tmp + md_len, label, nb);
6869 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006870 nb += rlen;
6871
6872 /*
6873 * Compute P_<hash>(secret, label + random)[0..dlen]
6874 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006876 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6880 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006881 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 }
6883 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6884 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006885 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 }
6887 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6888 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 for (i = 0; i < dlen; i += md_len) {
6893 ret = mbedtls_md_hmac_reset(&md_ctx);
6894 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006895 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 }
6897 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6898 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006899 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 }
6901 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6902 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006903 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006905
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 ret = mbedtls_md_hmac_reset(&md_ctx);
6907 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 }
6910 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6911 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 }
6914 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6915 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006916 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006918
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006922 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006924 }
6925
6926exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (tmp != NULL) {
6930 mbedtls_platform_zeroize(tmp, tmp_len);
6931 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006938}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006939#endif /* MBEDTLS_MD_C && ( MBEDTLS_MD_CAN_SHA256 || MBEDTLS_MD_CAN_SHA384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006940#endif /* MBEDTLS_USE_PSA_CRYPTO */
6941
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006942#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006943MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006944static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6945 const char *label,
6946 const unsigned char *random, size_t rlen,
6947 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006948{
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6950 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006951}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006952#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006953
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006954#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006956static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6957 const char *label,
6958 const unsigned char *random, size_t rlen,
6959 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006960{
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6962 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006963}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006964#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006965
Jerry Yuf009d862022-02-17 14:01:37 +08006966/*
6967 * Set appropriate PRF function and other SSL / TLS1.2 functions
6968 *
6969 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006970 * - hash associated with the ciphersuite (only used by TLS 1.2)
6971 *
6972 * Outputs:
6973 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6974 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006975MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006976static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6977 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006978{
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006979#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006980 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006981 handshake->tls_prf = tls_prf_sha384;
6982 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6983 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006985#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006986#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yuf009d862022-02-17 14:01:37 +08006987 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006988 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006989 handshake->tls_prf = tls_prf_sha256;
6990 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6991 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6992 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006993#else
Jerry Yuf009d862022-02-17 14:01:37 +08006994 {
Jerry Yuf009d862022-02-17 14:01:37 +08006995 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006996 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006998 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006999#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007002}
Jerry Yud6ab2352022-02-17 14:03:43 +08007003
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007004/*
7005 * Compute master secret if needed
7006 *
7007 * Parameters:
7008 * [in/out] handshake
7009 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7010 * (PSA-PSK) ciphersuite_info, psk_opaque
7011 * [out] premaster (cleared)
7012 * [out] master
7013 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7014 * debug: conf->f_dbg, conf->p_dbg
7015 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007016 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007017 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007018MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007019static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7020 unsigned char *master,
7021 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007022{
7023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7024
7025 /* cf. RFC 5246, Section 8.1:
7026 * "The master secret is always exactly 48 bytes in length." */
7027 size_t const master_secret_len = 48;
7028
7029#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7030 unsigned char session_hash[48];
7031#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7032
7033 /* The label for the KDF used for key expansion.
7034 * This is either "master secret" or "extended master secret"
7035 * depending on whether the Extended Master Secret extension
7036 * is used. */
7037 char const *lbl = "master secret";
7038
Przemek Stekielae4ed302022-04-05 17:15:55 +02007039 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007040 * - If the Extended Master Secret extension is not used,
7041 * this is ClientHello.Random + ServerHello.Random
7042 * (see Sect. 8.1 in RFC 5246).
7043 * - If the Extended Master Secret extension is used,
7044 * this is the transcript of the handshake so far.
7045 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007046 unsigned char const *seed = handshake->randbytes;
7047 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007048
7049#if !defined(MBEDTLS_DEBUG_C) && \
7050 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7051 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007053 ssl = NULL; /* make sure we don't use it except for those cases */
7054 (void) ssl;
7055#endif
7056
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 if (handshake->resume != 0) {
7058 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7059 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007060 }
7061
7062#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007064 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007065 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007066 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7067 if (ret != 0) {
7068 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7069 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7072 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007074#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007075
Przemek Stekiel99114f32022-04-22 11:20:09 +02007076#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007077 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007079 /* Perform PSK-to-MS expansion in a single step. */
7080 psa_status_t status;
7081 psa_algorithm_t alg;
7082 mbedtls_svc_key_id_t psk;
7083 psa_key_derivation_operation_t derivation =
7084 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007085 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007088
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007092 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007094 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007096
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007097 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007101 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007102 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007103 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007104 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007105 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007106 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007107 other_secret_len = 48;
7108 other_secret = handshake->premaster + 2;
7109 break;
7110 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007111 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007112 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7113 other_secret = handshake->premaster + 2;
7114 break;
7115 default:
7116 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 status = setup_psa_key_derivation(&derivation, psk, alg,
7120 ssl->conf->psk, ssl->conf->psk_len,
7121 seed, seed_len,
7122 (unsigned char const *) lbl,
7123 (size_t) strlen(lbl),
7124 other_secret, other_secret_len,
7125 master_secret_len);
7126 if (status != PSA_SUCCESS) {
7127 psa_key_derivation_abort(&derivation);
7128 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007129 }
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 status = psa_key_derivation_output_bytes(&derivation,
7132 master,
7133 master_secret_len);
7134 if (status != PSA_SUCCESS) {
7135 psa_key_derivation_abort(&derivation);
7136 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007137 }
7138
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 status = psa_key_derivation_abort(&derivation);
7140 if (status != PSA_SUCCESS) {
7141 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7142 }
7143 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007144#endif
7145 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007146#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7148 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007149 psa_status_t status;
7150 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7151 psa_key_derivation_operation_t derivation =
7152 PSA_KEY_DERIVATION_OPERATION_INIT;
7153
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007155
7156 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 status = psa_key_derivation_setup(&derivation, alg);
7159 if (status != PSA_SUCCESS) {
7160 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007161 }
7162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 status = psa_key_derivation_set_capacity(&derivation,
7164 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7165 if (status != PSA_SUCCESS) {
7166 psa_key_derivation_abort(&derivation);
7167 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007168 }
7169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7171 &derivation);
7172 if (status != PSA_SUCCESS) {
7173 psa_key_derivation_abort(&derivation);
7174 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007175 }
7176
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 status = psa_key_derivation_output_bytes(&derivation,
7178 handshake->premaster,
7179 handshake->pmslen);
7180 if (status != PSA_SUCCESS) {
7181 psa_key_derivation_abort(&derivation);
7182 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7183 }
7184
7185 status = psa_key_derivation_abort(&derivation);
7186 if (status != PSA_SUCCESS) {
7187 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007188 }
7189 }
7190#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7192 lbl, seed, seed_len,
7193 master,
7194 master_secret_len);
7195 if (ret != 0) {
7196 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7197 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007198 }
7199
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7201 handshake->premaster,
7202 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 mbedtls_platform_zeroize(handshake->premaster,
7205 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007206 }
7207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007209}
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007212{
7213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7214 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7215 ssl->handshake->ciphersuite_info;
7216
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007218
7219 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007221 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 if (ret != 0) {
7223 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7224 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007225 }
7226
7227 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 ret = ssl_compute_master(ssl->handshake,
7229 ssl->session_negotiate->master,
7230 ssl);
7231 if (ret != 0) {
7232 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7233 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007234 }
7235
7236 /* Swap the client and server random values:
7237 * - MS derivation wanted client+server (RFC 5246 8.1)
7238 * - key derivation wants server+client (RFC 5246 6.3) */
7239 {
7240 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 memcpy(tmp, ssl->handshake->randbytes, 64);
7242 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7243 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7244 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007245 }
7246
7247 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7249 ssl->session_negotiate->ciphersuite,
7250 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007251#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007253#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 ssl->handshake->tls_prf,
7255 ssl->handshake->randbytes,
7256 ssl->tls_version,
7257 ssl->conf->endpoint,
7258 ssl);
7259 if (ret != 0) {
7260 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7261 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007262 }
7263
7264 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7266 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007271}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007274{
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 switch (md) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007276#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007277 case MBEDTLS_SSL_HASH_SHA384:
7278 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7279 break;
7280#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007281#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007282 case MBEDTLS_SSL_HASH_SHA256:
7283 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7284 break;
7285#endif
7286 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007288 }
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007289#if !defined(MBEDTLS_MD_CAN_SHA384) && \
7290 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007291 (void) ssl;
7292#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007294}
7295
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007296#if defined(MBEDTLS_USE_PSA_CRYPTO)
7297static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7298 const psa_hash_operation_t *hs_op,
7299 size_t buffer_size,
7300 unsigned char *hash,
7301 size_t *hlen)
7302{
7303 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007304 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007305
7306#if !defined(MBEDTLS_DEBUG_C)
7307 (void) ssl;
7308#endif
7309 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007310 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007311 if (status != PSA_SUCCESS) {
7312 goto exit;
7313 }
7314
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007315 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007316 if (status != PSA_SUCCESS) {
7317 goto exit;
7318 }
7319
7320 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7321 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7322
7323exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007324 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007325 return mbedtls_md_error_from_psa(status);
7326}
7327#else
7328static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7329 const mbedtls_md_context_t *hs_ctx,
7330 unsigned char *hash,
7331 size_t *hlen)
7332{
7333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007334 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007335
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007336 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007337
7338#if !defined(MBEDTLS_DEBUG_C)
7339 (void) ssl;
7340#endif
7341 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7342
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007343 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007344 if (ret != 0) {
7345 goto exit;
7346 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007347 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007348 if (ret != 0) {
7349 goto exit;
7350 }
7351
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007352 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007353 if (ret != 0) {
7354 goto exit;
7355 }
7356
7357 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7358
7359 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7360 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7361
7362exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007363 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007364 return ret;
7365}
7366#endif /* MBEDTLS_USE_PSA_CRYPTO */
7367
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007368#if defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007369int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7370 unsigned char *hash,
7371 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007372{
7373#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007374 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7375 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007376#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7378 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007379#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007380}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007381#endif /* MBEDTLS_MD_CAN_SHA256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007382
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007383#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007384int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7385 unsigned char *hash,
7386 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007387{
7388#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007389 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7390 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007391#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007392 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7393 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007394#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007395}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01007396#endif /* MBEDTLS_MD_CAN_SHA384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007397
Neil Armstrong80f6f322022-05-03 17:56:38 +02007398#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7399 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007400int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007401{
7402 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007404 const unsigned char *psk = NULL;
7405 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007409 /*
7410 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007411 * checked before calling this function.
7412 *
7413 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007414 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7417 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7418 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007419 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007420 }
7421
7422 /*
7423 * PMS = struct {
7424 * opaque other_secret<0..2^16-1>;
7425 * opaque psk<0..2^16-1>;
7426 * };
7427 * with "other_secret" depending on the particular key exchange
7428 */
7429#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7431 if (end - p < 2) {
7432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7433 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007434
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007436 p += 2;
7437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (end < p || (size_t) (end - p) < psk_len) {
7439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7440 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007443 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007445#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7446#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007448 /*
7449 * other_secret already set by the ClientKeyExchange message,
7450 * and is 48 bytes long
7451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (end - p < 2) {
7453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7454 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007455
7456 *p++ = 0;
7457 *p++ = 48;
7458 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007460#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7461#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7464 size_t len;
7465
7466 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007468 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7470 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7471 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007472 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007474 p += 2 + len;
7475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7477 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007478#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007479#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007481 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7482 size_t zlen;
7483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007485 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7487 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7488 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007489 }
7490
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007492 p += 2 + zlen;
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7495 MBEDTLS_DEBUG_ECDH_Z);
7496 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007497#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007498 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7500 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007501 }
7502
7503 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (end - p < 2) {
7505 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7506 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007509 p += 2;
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 if (end < p || (size_t) (end - p) < psk_len) {
7512 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7513 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007514
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007516 p += psk_len;
7517
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007518 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007521}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007522#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007523
7524#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007525MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007526static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007527
7528#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007529int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007530{
7531 /* If renegotiation is not enforced, retransmit until we would reach max
7532 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007534 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7535 unsigned char doublings = 1;
7536
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007538 ++doublings;
7539 ratio >>= 1;
7540 }
7541
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 if (++ssl->renego_records_seen > doublings) {
7543 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7544 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007545 }
7546 }
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007549}
7550#endif
7551#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007552
Jerry Yud9526692022-02-17 14:23:47 +08007553/*
7554 * Handshake functions
7555 */
7556#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7557/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007558int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007559{
7560 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7561 ssl->handshake->ciphersuite_info;
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7566 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007567 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007569 }
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7572 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007573}
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007576{
7577 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7578 ssl->handshake->ciphersuite_info;
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7583 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007584 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007586 }
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7589 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007590}
7591
7592#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7593/* Some certificate support -> implement write and parse */
7594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007596{
7597 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7598 size_t i, n;
7599 const mbedtls_x509_crt *crt;
7600 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7601 ssl->handshake->ciphersuite_info;
7602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7606 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007607 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007609 }
7610
7611#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7613 if (ssl->handshake->client_auth == 0) {
7614 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007615 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007617 }
7618 }
7619#endif /* MBEDTLS_SSL_CLI_C */
7620#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7622 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007623 /* Should never happen because we shouldn't have picked the
7624 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007626 }
7627 }
7628#endif
7629
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007631
7632 /*
7633 * 0 . 0 handshake type
7634 * 1 . 3 handshake length
7635 * 4 . 6 length of all certs
7636 * 7 . 9 length of cert. 1
7637 * 10 . n-1 peer certificate
7638 * n . n+2 length of cert. 2
7639 * n+3 . ... upper level cert, etc.
7640 */
7641 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007645 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7647 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7648 " > %" MBEDTLS_PRINTF_SIZET,
7649 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7650 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007651 }
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7654 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7655 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007658 i += n; crt = crt->next;
7659 }
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7662 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7663 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007664
7665 ssl->out_msglen = i;
7666 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7667 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7668
7669 ssl->state++;
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7672 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7673 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007674 }
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007679}
7680
7681#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7682
7683#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007685static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7686 unsigned char *crt_buf,
7687 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007688{
7689 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (peer_crt == NULL) {
7692 return -1;
7693 }
Jerry Yud9526692022-02-17 14:23:47 +08007694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 if (peer_crt->raw.len != crt_buf_len) {
7696 return -1;
7697 }
Jerry Yud9526692022-02-17 14:23:47 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007700}
7701#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007702MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007703static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7704 unsigned char *crt_buf,
7705 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007706{
7707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7708 unsigned char const * const peer_cert_digest =
7709 ssl->session->peer_cert_digest;
7710 mbedtls_md_type_t const peer_cert_digest_type =
7711 ssl->session->peer_cert_digest_type;
7712 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007714 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7715 size_t digest_len;
7716
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if (peer_cert_digest == NULL || digest_info == NULL) {
7718 return -1;
7719 }
Jerry Yud9526692022-02-17 14:23:47 +08007720
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 digest_len = mbedtls_md_get_size(digest_info);
7722 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7723 return -1;
7724 }
Jerry Yud9526692022-02-17 14:23:47 +08007725
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7727 if (ret != 0) {
7728 return -1;
7729 }
Jerry Yud9526692022-02-17 14:23:47 +08007730
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007732}
7733#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7734#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7735
7736/*
7737 * Once the certificate message is read, parse it into a cert chain and
7738 * perform basic checks, but leave actual verification to the caller
7739 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007740MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007741static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7742 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007743{
7744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7745#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007747#endif
7748 size_t i, n;
7749 uint8_t alert;
7750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7752 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7753 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7754 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7755 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007756 }
7757
Gilles Peskine449bd832023-01-11 14:50:10 +01007758 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7759 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7760 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7761 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007762 }
7763
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7766 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7767 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7768 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007769 }
7770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007772
7773 /*
7774 * Same message structure as in mbedtls_ssl_write_certificate()
7775 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007776 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (ssl->in_msg[i] != 0 ||
7779 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7780 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7781 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7782 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7783 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007784 }
7785
7786 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7787 i += 3;
7788
7789 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007791 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 if (i + 3 > ssl->in_hslen) {
7793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7794 mbedtls_ssl_send_alert_message(ssl,
7795 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7796 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7797 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007798 }
7799 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7800 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (ssl->in_msg[i] != 0) {
7802 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7803 mbedtls_ssl_send_alert_message(ssl,
7804 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7805 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7806 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007807 }
7808
7809 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007810 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007811 i += 3;
7812
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (n < 128 || i + n > ssl->in_hslen) {
7814 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7815 mbedtls_ssl_send_alert_message(ssl,
7816 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7817 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7818 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007819 }
7820
7821 /* Check if we're handling the first CRT in the chain. */
7822#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007824 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007826 /* During client-side renegotiation, check that the server's
7827 * end-CRTs hasn't changed compared to the initial handshake,
7828 * mitigating the triple handshake attack. On success, reuse
7829 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7831 if (ssl_check_peer_crt_unchanged(ssl,
7832 &ssl->in_msg[i],
7833 n) != 0) {
7834 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7835 mbedtls_ssl_send_alert_message(ssl,
7836 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7837 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7838 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007839 }
7840
7841 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007843 }
7844#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7845
7846 /* Parse the next certificate in the chain. */
7847#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007849#else
7850 /* If we don't need to store the CRT chain permanently, parse
7851 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007853#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007855 case 0: /*ok*/
7856 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7857 /* Ignore certificate with an unknown algorithm: maybe a
7858 prior certificate was already trusted. */
7859 break;
7860
7861 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7862 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7863 goto crt_parse_der_failed;
7864
7865 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7866 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7867 goto crt_parse_der_failed;
7868
7869 default:
7870 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007871crt_parse_der_failed:
7872 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7873 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7874 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007875 }
7876
7877 i += n;
7878 }
7879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7881 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007882}
7883
7884#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007885MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007886static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007887{
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7889 return -1;
7890 }
Jerry Yud9526692022-02-17 14:23:47 +08007891
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007893 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7894 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7896 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7897 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007898 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007900}
7901#endif /* MBEDTLS_SSL_SRV_C */
7902
7903/* Check if a certificate message is expected.
7904 * Return either
7905 * - SSL_CERTIFICATE_EXPECTED, or
7906 * - SSL_CERTIFICATE_SKIP
7907 * indicating whether a Certificate message is expected or not.
7908 */
7909#define SSL_CERTIFICATE_EXPECTED 0
7910#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007912static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7913 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007914{
7915 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7916 ssl->handshake->ciphersuite_info;
7917
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7919 return SSL_CERTIFICATE_SKIP;
7920 }
Jerry Yud9526692022-02-17 14:23:47 +08007921
7922#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7924 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7925 return SSL_CERTIFICATE_SKIP;
7926 }
Jerry Yud9526692022-02-17 14:23:47 +08007927
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007929 ssl->session_negotiate->verify_result =
7930 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007932 }
7933 }
7934#else
7935 ((void) authmode);
7936#endif /* MBEDTLS_SSL_SRV_C */
7937
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007939}
7940
Jerry Yud9526692022-02-17 14:23:47 +08007941#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007942MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007943static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7944 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007945{
7946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7947 /* Remember digest of the peer's end-CRT. */
7948 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007949 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7950 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7951 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7952 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7953 mbedtls_ssl_send_alert_message(ssl,
7954 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7955 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007956
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007958 }
7959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 ret = mbedtls_md(mbedtls_md_info_from_type(
7961 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7962 start, len,
7963 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007964
7965 ssl->session_negotiate->peer_cert_digest_type =
7966 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7967 ssl->session_negotiate->peer_cert_digest_len =
7968 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7969
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007971}
7972
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007973MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007974static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7975 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007976{
7977 unsigned char *end = start + len;
7978 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7979
7980 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7982 ret = mbedtls_pk_parse_subpubkey(&start, end,
7983 &ssl->handshake->peer_pubkey);
7984 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007985 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007987 }
7988
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007990}
7991#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007994{
7995 int ret = 0;
7996 int crt_expected;
Manuel Pégourié-Gonnarde1cc9262024-08-14 09:47:38 +02007997 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007998#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7999 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8000 ? ssl->handshake->sni_authmode
8001 : ssl->conf->authmode;
8002#else
8003 const int authmode = ssl->conf->authmode;
8004#endif
8005 void *rs_ctx = NULL;
8006 mbedtls_x509_crt *chain = NULL;
8007
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008009
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8011 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8012 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008013 goto exit;
8014 }
8015
8016#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if (ssl->handshake->ecrs_enabled &&
8018 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008019 chain = ssl->handshake->ecrs_peer_cert;
8020 ssl->handshake->ecrs_peer_cert = NULL;
8021 goto crt_verify;
8022 }
8023#endif
8024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008026 /* mbedtls_ssl_read_record may have sent an alert already. We
8027 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008029 goto exit;
8030 }
8031
8032#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008034 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8035
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008037 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 }
Jerry Yud9526692022-02-17 14:23:47 +08008039
8040 goto exit;
8041 }
8042#endif /* MBEDTLS_SSL_SRV_C */
8043
8044 /* Clear existing peer CRT structure in case we tried to
8045 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008047
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8049 if (chain == NULL) {
8050 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8051 sizeof(mbedtls_x509_crt)));
8052 mbedtls_ssl_send_alert_message(ssl,
8053 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8054 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008055
8056 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8057 goto exit;
8058 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008060
Gilles Peskine449bd832023-01-11 14:50:10 +01008061 ret = ssl_parse_certificate_chain(ssl, chain);
8062 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008063 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 }
Jerry Yud9526692022-02-17 14:23:47 +08008065
8066#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008068 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 }
Jerry Yud9526692022-02-17 14:23:47 +08008070
8071crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008073 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 }
Jerry Yud9526692022-02-17 14:23:47 +08008075#endif
8076
Manuel Pégourié-Gonnardce603302024-08-16 11:03:42 +02008077 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
8078 ssl->handshake->ciphersuite_info,
8079 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 }
Jerry Yud9526692022-02-17 14:23:47 +08008083
8084#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8085 {
8086 unsigned char *crt_start, *pk_start;
8087 size_t crt_len, pk_len;
8088
8089 /* We parse the CRT chain without copying, so
8090 * these pointers point into the input buffer,
8091 * and are hence still valid after freeing the
8092 * CRT chain. */
8093
8094 crt_start = chain->raw.p;
8095 crt_len = chain->raw.len;
8096
8097 pk_start = chain->pk_raw.p;
8098 pk_len = chain->pk_raw.len;
8099
8100 /* Free the CRT structures before computing
8101 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 mbedtls_x509_crt_free(chain);
8103 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008104 chain = NULL;
8105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8107 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008108 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 }
Jerry Yud9526692022-02-17 14:23:47 +08008110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8112 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 }
Jerry Yud9526692022-02-17 14:23:47 +08008115 }
8116#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8117 /* Pass ownership to session structure. */
8118 ssl->session_negotiate->peer_cert = chain;
8119 chain = NULL;
8120#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8121
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008123
8124exit:
8125
Gilles Peskine449bd832023-01-11 14:50:10 +01008126 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008127 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 }
Jerry Yud9526692022-02-17 14:23:47 +08008129
8130#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008132 ssl->handshake->ecrs_peer_cert = chain;
8133 chain = NULL;
8134 }
8135#endif
8136
Gilles Peskine449bd832023-01-11 14:50:10 +01008137 if (chain != NULL) {
8138 mbedtls_x509_crt_free(chain);
8139 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008140 }
8141
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008143}
8144#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8145
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008146static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8147 unsigned char *padbuf, size_t hlen,
8148 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008149{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008150 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008151 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008152#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008153 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008154 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008155 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008156 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008157#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008159 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008160 mbedtls_md_context_t cloned_ctx;
8161 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008162#endif
8163
8164 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008165 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008166 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008168
Gilles Peskine449bd832023-01-11 14:50:10 +01008169 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008170 ? "client finished"
8171 : "server finished";
8172
8173#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008174 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008175
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008176 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008178 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008179 }
8180
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008181 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008183 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008184 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008185 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008186#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008187 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008188
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008189 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008190 if (ret != 0) {
8191 goto exit;
8192 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008193 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008194 if (ret != 0) {
8195 goto exit;
8196 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008197
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008198 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008199 if (ret != 0) {
8200 goto exit;
8201 }
8202#endif /* MBEDTLS_USE_PSA_CRYPTO */
8203
8204 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8205
Jerry Yu615bd6f2022-02-17 14:25:15 +08008206 /*
8207 * TLSv1.2:
8208 * hash = PRF( master, finished_label,
8209 * Hash( handshake ) )[0.11]
8210 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008212 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008213
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008215
Paul Elliottecb95be2023-08-11 16:41:04 +01008216 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008217
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008218 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008219
8220exit:
8221#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008222 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008223 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008224#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008225 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008226 return ret;
8227#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008228}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008229
8230#if defined(MBEDTLS_MD_CAN_SHA256)
8231static int ssl_calc_finished_tls_sha256(
8232 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8233{
8234 unsigned char padbuf[32];
8235 return ssl_calc_finished_tls_generic(ssl,
8236#if defined(MBEDTLS_USE_PSA_CRYPTO)
8237 &ssl->handshake->fin_sha256_psa,
8238#else
8239 &ssl->handshake->fin_sha256,
8240#endif
8241 padbuf, sizeof(padbuf),
8242 buf, from);
8243}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008244#endif /* MBEDTLS_MD_CAN_SHA256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008245
Jerry Yub7ba49e2022-02-17 14:25:53 +08008246
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008247#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008248static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008249 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008250{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008251 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008252 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008253#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008254 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008255#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008256 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008257#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008258 padbuf, sizeof(padbuf),
8259 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008260}
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008261#endif /* MBEDTLS_MD_CAN_SHA384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008262
Gilles Peskine449bd832023-01-11 14:50:10 +01008263void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008264{
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008266
8267 /*
8268 * Free our handshake params
8269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 mbedtls_ssl_handshake_free(ssl);
8271 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008272 ssl->handshake = NULL;
8273
8274 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008275 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 if (ssl->transform) {
8278 mbedtls_ssl_transform_free(ssl->transform);
8279 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008280 }
8281 ssl->transform = ssl->transform_negotiate;
8282 ssl->transform_negotiate = NULL;
8283
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008285}
8286
Gilles Peskine449bd832023-01-11 14:50:10 +01008287void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008288{
8289 int resume = ssl->handshake->resume;
8290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008292
8293#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008295 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8296 ssl->renego_records_seen = 0;
8297 }
8298#endif
8299
8300 /*
8301 * Free the previous session and switch in the current one
8302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008304#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8305 /* RFC 7366 3.1: keep the EtM state */
8306 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008307 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008308#endif
8309
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 mbedtls_ssl_session_free(ssl->session);
8311 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008312 }
8313 ssl->session = ssl->session_negotiate;
8314 ssl->session_negotiate = NULL;
8315
8316 /*
8317 * Add cache entry
8318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008320 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008321 resume == 0) {
8322 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8323 ssl->session->id,
8324 ssl->session->id_len,
8325 ssl->session) != 0) {
8326 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8327 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008328 }
8329
8330#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008331 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8332 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008333 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008334 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008335
8336 /* Keep last flight around in case we need to resend it:
8337 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8339 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008340#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008342
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008343 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008344
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008346}
8347
Gilles Peskine449bd832023-01-11 14:50:10 +01008348int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008349{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008350 int ret;
8351 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008352
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008354
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008356
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008357 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8358 if (ret != 0) {
8359 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8360 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008361
8362 /*
8363 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8364 * may define some other value. Currently (early 2016), no defined
8365 * ciphersuite does this (and this is unlikely to change as activity has
8366 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8367 */
8368 hash_len = 12;
8369
8370#if defined(MBEDTLS_SSL_RENEGOTIATION)
8371 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008373#endif
8374
8375 ssl->out_msglen = 4 + hash_len;
8376 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8377 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8378
8379 /*
8380 * In case of session resuming, invert the client and server
8381 * ChangeCipherSpec messages order.
8382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008384#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008386 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008388#endif
8389#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008391 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008395 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008397
8398 /*
8399 * Switch to our negotiated transform and session parameters for outbound
8400 * data.
8401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008403
8404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008406 unsigned char i;
8407
8408 /* Remember current epoch settings for resending */
8409 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8411 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008412
8413 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008415
8416
8417 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 for (i = 2; i > 0; i--) {
8419 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008420 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008421 }
8422 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008423
8424 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008425 if (i == 0) {
8426 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8427 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008430#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008432
8433 ssl->transform_out = ssl->transform_negotiate;
8434 ssl->session_out = ssl->session_negotiate;
8435
8436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008437 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8438 mbedtls_ssl_send_flight_completed(ssl);
8439 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008440#endif
8441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8444 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008445 }
8446
8447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8449 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8450 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8451 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008452 }
8453#endif
8454
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008458}
8459
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008460#define SSL_MAX_HASH_LEN 12
8461
Gilles Peskine449bd832023-01-11 14:50:10 +01008462int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008463{
8464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8465 unsigned int hash_len = 12;
8466 unsigned char buf[SSL_MAX_HASH_LEN];
8467
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008469
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008470 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8471 if (ret != 0) {
8472 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8473 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8476 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008477 goto exit;
8478 }
8479
Gilles Peskine449bd832023-01-11 14:50:10 +01008480 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8481 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8482 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8483 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008484 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8485 goto exit;
8486 }
8487
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8489 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8490 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008491 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8492 goto exit;
8493 }
8494
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8496 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8497 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8498 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008499 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8500 goto exit;
8501 }
8502
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8504 buf, hash_len) != 0) {
8505 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8506 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8507 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008508 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8509 goto exit;
8510 }
8511
8512#if defined(MBEDTLS_SSL_RENEGOTIATION)
8513 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008515#endif
8516
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008518#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008520 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008522#endif
8523#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008525 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008527#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008529 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008531
8532#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8534 mbedtls_ssl_recv_flight_completed(ssl);
8535 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008536#endif
8537
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008539
8540exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 mbedtls_platform_zeroize(buf, hash_len);
8542 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008543}
8544
Jerry Yu392112c2022-02-17 14:34:10 +08008545#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8546/*
8547 * Helper to get TLS 1.2 PRF from ciphersuite
8548 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8549 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008550static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008551{
Jerry Yu392112c2022-02-17 14:34:10 +08008552 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008554#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8556 return tls_prf_sha384;
8557 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008558#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008559#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008560 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008561 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8562 return tls_prf_sha256;
8563 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008564 }
8565#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008566#if !defined(MBEDTLS_MD_CAN_SHA384) && \
8567 !defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008568 (void) ciphersuite_info;
8569#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008572}
8573#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008574
Gilles Peskine449bd832023-01-11 14:50:10 +01008575static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008576{
8577 ((void) tls_prf);
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008578#if defined(MBEDTLS_MD_CAN_SHA384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 if (tls_prf == tls_prf_sha384) {
8580 return MBEDTLS_SSL_TLS_PRF_SHA384;
8581 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008582#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01008583#if defined(MBEDTLS_MD_CAN_SHA256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 if (tls_prf == tls_prf_sha256) {
8585 return MBEDTLS_SSL_TLS_PRF_SHA256;
8586 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008587#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008589}
8590
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591/*
8592 * Populate a transform structure with session keys and all the other
8593 * necessary information.
8594 *
8595 * Parameters:
8596 * - [in/out]: transform: structure to populate
8597 * [in] must be just initialised with mbedtls_ssl_transform_init()
8598 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8599 * - [in] ciphersuite
8600 * - [in] master
8601 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008602 * - [in] tls_prf: pointer to PRF to use for key derivation
8603 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008604 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008605 * - [in] endpoint: client or server
8606 * - [in] ssl: used for:
8607 * - ssl->conf->{f,p}_export_keys
8608 * [in] optionally used for:
8609 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8610 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008611MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008612static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8613 int ciphersuite,
8614 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008615#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008617#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 ssl_tls_prf_t tls_prf,
8619 const unsigned char randbytes[64],
8620 mbedtls_ssl_protocol_version tls_version,
8621 unsigned endpoint,
8622 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008623{
8624 int ret = 0;
8625 unsigned char keyblk[256];
8626 unsigned char *key1;
8627 unsigned char *key2;
8628 unsigned char *mac_enc;
8629 unsigned char *mac_dec;
8630 size_t mac_key_len = 0;
8631 size_t iv_copy_len;
8632 size_t keylen;
8633 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008634 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008635#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008636 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008637 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008638#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008639
8640#if defined(MBEDTLS_USE_PSA_CRYPTO)
8641 psa_key_type_t key_type;
8642 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8643 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008644 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008645 size_t key_bits;
8646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8647#endif
8648
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008649 /*
8650 * Some data just needs copying into the structure
8651 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008652#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008653 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008654#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008655 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008656
8657#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008658 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008659#endif
8660
8661#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008662 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008663 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8664 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008665 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008666 }
8667#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8668
8669 /*
8670 * Get various info structures
8671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008672 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8673 if (ciphersuite_info == NULL) {
8674 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8675 ciphersuite));
8676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008677 }
8678
Neil Armstrongab555e02022-04-04 11:07:59 +02008679 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008680#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008682#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008683 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008684
Gilles Peskine449bd832023-01-11 14:50:10 +01008685 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008686 transform->taglen =
8687 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008689
8690#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008691 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 transform->taglen,
8693 &alg,
8694 &key_type,
8695 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008696 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008698 goto end;
8699 }
8700#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008701 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 if (cipher_info == NULL) {
8703 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8704 ciphersuite_info->cipher));
8705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008706 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008707#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008708
Neil Armstronge4512952022-03-08 09:08:22 +01008709#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008710 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008711 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008712 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 (unsigned) ciphersuite_info->mac));
8714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008715 }
8716#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008717 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if (md_info == NULL) {
8719 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8720 (unsigned) ciphersuite_info->mac));
8721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008722 }
Neil Armstronge4512952022-03-08 09:08:22 +01008723#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008724
8725#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8726 /* Copy own and peer's CID if the use of the CID
8727 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008728 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8729 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008730
8731 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8733 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8734 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008735
8736 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8738 ssl->handshake->peer_cid_len);
8739 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8740 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008741 }
8742#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8743
8744 /*
8745 * Compute key block using the PRF
8746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8748 if (ret != 0) {
8749 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8750 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008751 }
8752
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8754 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8755 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8756 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8757 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008758
8759 /*
8760 * Determine the appropriate key, IV and MAC length.
8761 */
8762
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008763#if defined(MBEDTLS_USE_PSA_CRYPTO)
8764 keylen = PSA_BITS_TO_BYTES(key_bits);
8765#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008767#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008768
Valerio Settie5707042023-10-11 11:54:42 +02008769#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008771 size_t explicit_ivlen;
8772
8773 transform->maclen = 0;
8774 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008775
8776 /* All modes haves 96-bit IVs, but the length of the static parts vary
8777 * with mode and version:
8778 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8779 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8780 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8781 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8782 * sequence number).
8783 */
8784 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008785
8786 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008787#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008788 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008789#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8791 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008792#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008793
Gilles Peskine449bd832023-01-11 14:50:10 +01008794 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008795 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008796 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008797 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008799
8800 /* Minimum length of encrypted record */
8801 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8802 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008803 } else
Valerio Settie5707042023-10-11 11:54:42 +02008804#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008805#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008807 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008808 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008809#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008810 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008811#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008812 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008813#endif /* MBEDTLS_USE_PSA_CRYPTO */
8814
8815#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008816 /* Get MAC length */
8817 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8818#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008819 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008820 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8821 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8822 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008823 goto end;
8824 }
8825
8826 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008827 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008828#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008829 transform->maclen = mac_key_len;
8830
8831 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008832#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008833 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008834#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008835 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008836#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008837
8838 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008839 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842 /*
8843 * GenericBlockCipher:
8844 * 1. if EtM is in use: one block plus MAC
8845 * otherwise: * first multiple of blocklen greater than maclen
8846 * 2. IV
8847 */
8848#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 + block_size;
8852 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008853#endif
8854 {
8855 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 + block_size
8857 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008858 }
8859
Gilles Peskine449bd832023-01-11 14:50:10 +01008860 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008861 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008862 } else {
8863 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008864 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8865 goto end;
8866 }
8867 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8870 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008871 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8872 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008873 }
8874
Gilles Peskine449bd832023-01-11 14:50:10 +01008875 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8876 (unsigned) keylen,
8877 (unsigned) transform->minlen,
8878 (unsigned) transform->ivlen,
8879 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008880
8881 /*
8882 * Finally setup the cipher contexts, IVs and MAC secrets.
8883 */
8884#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008886 key1 = keyblk + mac_key_len * 2;
8887 key2 = keyblk + mac_key_len * 2 + keylen;
8888
8889 mac_enc = keyblk;
8890 mac_dec = keyblk + mac_key_len;
8891
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 iv_copy_len = (transform->fixed_ivlen) ?
8893 transform->fixed_ivlen : transform->ivlen;
8894 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8895 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8896 iv_copy_len);
8897 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008898#endif /* MBEDTLS_SSL_CLI_C */
8899#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008901 key1 = keyblk + mac_key_len * 2 + keylen;
8902 key2 = keyblk + mac_key_len * 2;
8903
8904 mac_enc = keyblk + mac_key_len;
8905 mac_dec = keyblk;
8906
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 iv_copy_len = (transform->fixed_ivlen) ?
8908 transform->fixed_ivlen : transform->ivlen;
8909 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8910 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8911 iv_copy_len);
8912 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008913#endif /* MBEDTLS_SSL_SRV_C */
8914 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008915 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008916 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8917 goto end;
8918 }
8919
Paul Elliott4fb19552023-10-18 12:15:30 +01008920 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 ssl->f_export_keys(ssl->p_export_keys,
8922 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8923 master, 48,
8924 randbytes + 32,
8925 randbytes,
8926 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008927 }
8928
8929#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008930 transform->psa_alg = alg;
8931
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8933 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8934 psa_set_key_algorithm(&attributes, alg);
8935 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008936
Gilles Peskine449bd832023-01-11 14:50:10 +01008937 if ((status = psa_import_key(&attributes,
8938 key1,
8939 PSA_BITS_TO_BYTES(key_bits),
8940 &transform->psa_key_enc)) != PSA_SUCCESS) {
8941 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008942 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008944 goto end;
8945 }
8946
Gilles Peskine449bd832023-01-11 14:50:10 +01008947 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008948
Gilles Peskine449bd832023-01-11 14:50:10 +01008949 if ((status = psa_import_key(&attributes,
8950 key2,
8951 PSA_BITS_TO_BYTES(key_bits),
8952 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008953 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008954 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008955 goto end;
8956 }
8957 }
8958#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8960 cipher_info)) != 0) {
8961 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008962 goto end;
8963 }
8964
Gilles Peskine449bd832023-01-11 14:50:10 +01008965 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8966 cipher_info)) != 0) {
8967 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008968 goto end;
8969 }
8970
Gilles Peskine449bd832023-01-11 14:50:10 +01008971 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8972 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8973 MBEDTLS_ENCRYPT)) != 0) {
8974 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008975 goto end;
8976 }
8977
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8979 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8980 MBEDTLS_DECRYPT)) != 0) {
8981 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008982 goto end;
8983 }
8984
8985#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008986 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8987 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8988 MBEDTLS_PADDING_NONE)) != 0) {
8989 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008990 goto end;
8991 }
8992
Gilles Peskine449bd832023-01-11 14:50:10 +01008993 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8994 MBEDTLS_PADDING_NONE)) != 0) {
8995 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008996 goto end;
8997 }
8998 }
8999#endif /* MBEDTLS_CIPHER_MODE_CBC */
9000#endif /* MBEDTLS_USE_PSA_CRYPTO */
9001
Neil Armstrong29c0c042022-03-17 17:47:28 +01009002#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9003 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9004 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009006#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009007 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009008
Gilles Peskine449bd832023-01-11 14:50:10 +01009009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9010 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9011 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009012
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 if ((status = psa_import_key(&attributes,
9014 mac_enc, mac_key_len,
9015 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009016 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009018 goto end;
9019 }
9020
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9022 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009023#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009025#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009026 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009027 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009028 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9029 PSA_KEY_USAGE_VERIFY_HASH);
9030 } else {
9031 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9032 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009033
Gilles Peskine449bd832023-01-11 14:50:10 +01009034 if ((status = psa_import_key(&attributes,
9035 mac_dec, mac_key_len,
9036 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009037 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009038 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009039 goto end;
9040 }
9041#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9043 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009044 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009045 }
9046 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9047 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009048 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009049 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009050#endif /* MBEDTLS_USE_PSA_CRYPTO */
9051 }
9052#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9053
9054 ((void) mac_dec);
9055 ((void) mac_enc);
9056
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009057end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009058 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9059 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009060}
9061
Valerio Settia08b1a42022-11-17 15:10:02 +01009062#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9063 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009064int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 psa_pake_operation_t *pake_ctx,
9066 const unsigned char *buf,
9067 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009068{
9069 psa_status_t status;
9070 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009071 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009072 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9073 * At round two perform a single cycle
9074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 for (; remaining_steps > 0; remaining_steps--) {
9078 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009079 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009080 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009081 /* Length is stored at the first byte */
9082 size_t length = buf[input_offset];
9083 input_offset += 1;
9084
Gilles Peskine449bd832023-01-11 14:50:10 +01009085 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009086 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9087 }
9088
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 status = psa_pake_input(pake_ctx, step,
9090 buf + input_offset, length);
9091 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009092 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009093 }
9094
9095 input_offset += length;
9096 }
9097 }
9098
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009100 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009101 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009102
Gilles Peskine449bd832023-01-11 14:50:10 +01009103 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009104}
9105
Valerio Setti6b3dab02022-11-17 17:14:54 +01009106int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009107 psa_pake_operation_t *pake_ctx,
9108 unsigned char *buf,
9109 size_t len, size_t *olen,
9110 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009111{
9112 psa_status_t status;
9113 size_t output_offset = 0;
9114 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009115 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009116 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9117 * At round two perform a single cycle
9118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009119 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009120
Gilles Peskine449bd832023-01-11 14:50:10 +01009121 for (; remaining_steps > 0; remaining_steps--) {
9122 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9123 step <= PSA_PAKE_STEP_ZK_PROOF;
9124 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009125 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009126 * For each step, prepend 1 byte with the length of the data as
9127 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 status = psa_pake_output(pake_ctx, step,
9130 buf + output_offset + 1,
9131 len - output_offset - 1,
9132 &output_len);
9133 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009134 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009135 }
9136
Valerio Setti99d88c12022-11-22 16:03:43 +01009137 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009138
9139 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009140 }
9141 }
9142
9143 *olen = output_offset;
9144
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009146}
Valerio Settia08b1a42022-11-17 15:10:02 +01009147#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9148
Jerry Yuee40f9d2022-02-17 14:55:16 +08009149#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009150int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9151 unsigned char *hash, size_t *hashlen,
9152 unsigned char *data, size_t data_len,
9153 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009154{
9155 psa_status_t status;
9156 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009157 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009158
Gilles Peskine449bd832023-01-11 14:50:10 +01009159 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009160
Gilles Peskine449bd832023-01-11 14:50:10 +01009161 if ((status = psa_hash_setup(&hash_operation,
9162 hash_alg)) != PSA_SUCCESS) {
9163 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009164 goto exit;
9165 }
9166
Gilles Peskine449bd832023-01-11 14:50:10 +01009167 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9168 64)) != PSA_SUCCESS) {
9169 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009170 goto exit;
9171 }
9172
Gilles Peskine449bd832023-01-11 14:50:10 +01009173 if ((status = psa_hash_update(&hash_operation,
9174 data, data_len)) != PSA_SUCCESS) {
9175 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009176 goto exit;
9177 }
9178
Gilles Peskine449bd832023-01-11 14:50:10 +01009179 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9180 hashlen)) != PSA_SUCCESS) {
9181 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9182 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009183 }
9184
9185exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (status != PSA_SUCCESS) {
9187 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9188 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9189 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009190 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009191 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009192 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9193 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009194 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009195 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009197 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009199 }
9200 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009201 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009202}
9203
9204#else
9205
Gilles Peskine449bd832023-01-11 14:50:10 +01009206int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9207 unsigned char *hash, size_t *hashlen,
9208 unsigned char *data, size_t data_len,
9209 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009210{
9211 int ret = 0;
9212 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9214 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009215
Gilles Peskine449bd832023-01-11 14:50:10 +01009216 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009217
Gilles Peskine449bd832023-01-11 14:50:10 +01009218 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009219
9220 /*
9221 * digitally-signed struct {
9222 * opaque client_random[32];
9223 * opaque server_random[32];
9224 * ServerDHParams params;
9225 * };
9226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009227 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9228 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009229 goto exit;
9230 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009231 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9232 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009233 goto exit;
9234 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009235 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9236 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009237 goto exit;
9238 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009239 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9240 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009241 goto exit;
9242 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9244 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009245 goto exit;
9246 }
9247
9248exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009250
Gilles Peskine449bd832023-01-11 14:50:10 +01009251 if (ret != 0) {
9252 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9253 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9254 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009255
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009257}
9258#endif /* MBEDTLS_USE_PSA_CRYPTO */
9259
Jerry Yud9d91da2022-02-17 14:57:06 +08009260#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9261
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009262/* Find the preferred hash for a given signature algorithm. */
9263unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009264 mbedtls_ssl_context *ssl,
9265 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009266{
Gabor Mezei078e8032022-04-27 21:17:56 +02009267 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009268 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009269
Gilles Peskine449bd832023-01-11 14:50:10 +01009270 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9271 return MBEDTLS_SSL_HASH_NONE;
9272 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009273
Gilles Peskine449bd832023-01-11 14:50:10 +01009274 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009275 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9277 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009278 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009279 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9280 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009281
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009282 mbedtls_md_type_t md_alg =
9283 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9284 if (md_alg == MBEDTLS_MD_NONE) {
9285 continue;
9286 }
9287
Gilles Peskine449bd832023-01-11 14:50:10 +01009288 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009289#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009291 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009292 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9295 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9296 PSA_ALG_ECDSA(psa_hash_alg),
9297 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009298 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009299 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009300
Gilles Peskine449bd832023-01-11 14:50:10 +01009301 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9302 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9303 PSA_ALG_RSA_PKCS1V15_SIGN(
9304 psa_hash_alg),
9305 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009306 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009307 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009308 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009309#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009310
Gilles Peskine449bd832023-01-11 14:50:10 +01009311 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009312 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009313 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009314
Gilles Peskine449bd832023-01-11 14:50:10 +01009315 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009316}
9317
9318#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9319
Jerry Yudc7bd172022-02-17 13:44:15 +08009320#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9321
XiaokangQian75d40ef2022-04-20 11:05:24 +00009322int mbedtls_ssl_validate_ciphersuite(
9323 const mbedtls_ssl_context *ssl,
9324 const mbedtls_ssl_ciphersuite_t *suite_info,
9325 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009326 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009327{
9328 (void) ssl;
9329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 if (suite_info == NULL) {
9331 return -1;
9332 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009333
Gilles Peskine449bd832023-01-11 14:50:10 +01009334 if ((suite_info->min_tls_version > max_tls_version) ||
9335 (suite_info->max_tls_version < min_tls_version)) {
9336 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009337 }
9338
XiaokangQian060d8672022-04-21 09:24:56 +00009339#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009340#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009342 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9343 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009344#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009345 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9346 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009347#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009348 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009350 }
9351#endif
9352
9353 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9354#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9356 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9357 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009358 }
9359#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9360#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9361
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009363}
9364
Ronald Crone68ab4f2022-10-05 12:46:29 +02009365#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009366/*
9367 * Function for writing a signature algorithm extension.
9368 *
9369 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9370 * value (TLS 1.3 RFC8446):
9371 * enum {
9372 * ....
9373 * ecdsa_secp256r1_sha256( 0x0403 ),
9374 * ecdsa_secp384r1_sha384( 0x0503 ),
9375 * ecdsa_secp521r1_sha512( 0x0603 ),
9376 * ....
9377 * } SignatureScheme;
9378 *
9379 * struct {
9380 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9381 * } SignatureSchemeList;
9382 *
9383 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9384 * value (TLS 1.2 RFC5246):
9385 * enum {
9386 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9387 * sha512(6), (255)
9388 * } HashAlgorithm;
9389 *
9390 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9391 * SignatureAlgorithm;
9392 *
9393 * struct {
9394 * HashAlgorithm hash;
9395 * SignatureAlgorithm signature;
9396 * } SignatureAndHashAlgorithm;
9397 *
9398 * SignatureAndHashAlgorithm
9399 * supported_signature_algorithms<2..2^16-2>;
9400 *
9401 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9402 * generalization of the TLS 1.2 signature algorithm extension.
9403 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9404 * `SignatureScheme` field of TLS 1.3
9405 *
9406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009407int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9408 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009409{
9410 unsigned char *p = buf;
9411 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9412 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9413
9414 *out_len = 0;
9415
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009417
9418 /* Check if we have space for header and length field:
9419 * - extension_type (2 bytes)
9420 * - extension_data_length (2 bytes)
9421 * - supported_signature_algorithms_length (2 bytes)
9422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009423 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009424 p += 6;
9425
9426 /*
9427 * Write supported_signature_algorithms
9428 */
9429 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9431 if (sig_alg == NULL) {
9432 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9433 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009434
Gilles Peskine449bd832023-01-11 14:50:10 +01009435 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9436 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9437 *sig_alg,
9438 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9439 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009440 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 }
9442 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9443 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009444 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009445 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9446 *sig_alg,
9447 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009448 }
9449
9450 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009451 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009452 if (supported_sig_alg_len == 0) {
9453 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9454 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009455 }
9456
Gilles Peskine449bd832023-01-11 14:50:10 +01009457 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9458 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9459 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009460
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009461 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009462
9463#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009464 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009465#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009466
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009468}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009469#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009470
XiaokangQian40a35232022-05-07 09:02:40 +00009471#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009472/*
9473 * mbedtls_ssl_parse_server_name_ext
9474 *
9475 * Structure of server_name extension:
9476 *
9477 * enum {
9478 * host_name(0), (255)
9479 * } NameType;
9480 * opaque HostName<1..2^16-1>;
9481 *
9482 * struct {
9483 * NameType name_type;
9484 * select (name_type) {
9485 * case host_name: HostName;
9486 * } name;
9487 * } ServerName;
9488 * struct {
9489 * ServerName server_name_list<1..2^16-1>
9490 * } ServerNameList;
9491 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009493int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9494 const unsigned char *buf,
9495 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009496{
9497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9498 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009499 size_t server_name_list_len, hostname_len;
9500 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009501
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009503
Gilles Peskine449bd832023-01-11 14:50:10 +01009504 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9505 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009506 p += 2;
9507
Gilles Peskine449bd832023-01-11 14:50:10 +01009508 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009509 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009510 while (p < server_name_list_end) {
9511 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9512 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9513 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9514 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009515
Gilles Peskine449bd832023-01-11 14:50:10 +01009516 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009517 /* sni_name is intended to be used only during the parsing of the
9518 * ClientHello message (it is reset to NULL before the end of
9519 * the message parsing). Thus it is ok to just point to the
9520 * reception buffer and not make a copy of it.
9521 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009522 ssl->handshake->sni_name = p + 3;
9523 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009524 if (ssl->conf->f_sni == NULL) {
9525 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009526 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009527 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9528 ssl, p + 3, hostname_len);
9529 if (ret != 0) {
9530 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9531 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9532 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9533 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9534 }
9535 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009536 }
9537
9538 p += hostname_len + 3;
9539 }
9540
Gilles Peskine449bd832023-01-11 14:50:10 +01009541 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009542}
9543#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9544
XiaokangQianacb39922022-06-17 10:18:48 +00009545#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009546MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009547int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9548 const unsigned char *buf,
9549 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009550{
9551 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009552 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009553 const unsigned char *protocol_name_list;
9554 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009555 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009556
9557 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 if (ssl->conf->alpn_list == NULL) {
9559 return 0;
9560 }
XiaokangQianacb39922022-06-17 10:18:48 +00009561
9562 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009563 * RFC7301, section 3.1
9564 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009565 *
XiaokangQianc7403452022-06-23 03:24:12 +00009566 * struct {
9567 * ProtocolName protocol_name_list<2..2^16-1>
9568 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009569 */
9570
XiaokangQianc7403452022-06-23 03:24:12 +00009571 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009572 * protocol_name_list_len 2 bytes
9573 * protocol_name_len 1 bytes
9574 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009577
Gilles Peskine449bd832023-01-11 14:50:10 +01009578 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009579 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009581 protocol_name_list = p;
9582 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009583
9584 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009585 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009586 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009587 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9588 protocol_name_len);
9589 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009590 MBEDTLS_SSL_PEND_FATAL_ALERT(
9591 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009592 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9593 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009594 }
9595
9596 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009597 }
9598
9599 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009600 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9601 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009602 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009604 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 if (protocol_name_len == alpn_len &&
9606 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009607 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009608 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009609 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009610
9611 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009612 }
9613 }
9614
XiaokangQian95d5f542022-06-24 02:29:26 +00009615 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009616 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9618 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9619 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009620}
9621
Gilles Peskine449bd832023-01-11 14:50:10 +01009622int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9623 unsigned char *buf,
9624 unsigned char *end,
9625 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009626{
9627 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009628 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009629 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009630
Gilles Peskine449bd832023-01-11 14:50:10 +01009631 if (ssl->alpn_chosen == NULL) {
9632 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009633 }
9634
Gilles Peskine449bd832023-01-11 14:50:10 +01009635 protocol_name_len = strlen(ssl->alpn_chosen);
9636 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009637
Gilles Peskine449bd832023-01-11 14:50:10 +01009638 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009639 /*
9640 * 0 . 1 ext identifier
9641 * 2 . 3 ext length
9642 * 4 . 5 protocol list length
9643 * 6 . 6 protocol name length
9644 * 7 . 7+n protocol name
9645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009646 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009647
XiaokangQian95d5f542022-06-24 02:29:26 +00009648 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009649
Gilles Peskine449bd832023-01-11 14:50:10 +01009650 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9651 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009652 /* Note: the length of the chosen protocol has been checked to be less
9653 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009655 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009656
Gilles Peskine449bd832023-01-11 14:50:10 +01009657 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009658
9659#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009660 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009661#endif
9662
Gilles Peskine449bd832023-01-11 14:50:10 +01009663 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009664}
9665#endif /* MBEDTLS_SSL_ALPN */
9666
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009667#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009668 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009669 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009670 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009671int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9672 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009673{
9674 /* Initialize to suppress unnecessary compiler warning */
9675 size_t hostname_len = 0;
9676
9677 /* Check if new hostname is valid before
9678 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009679 if (hostname != NULL) {
9680 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009681
Gilles Peskine449bd832023-01-11 14:50:10 +01009682 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9683 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9684 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009685 }
9686
9687 /* Now it's clear that we will overwrite the old hostname,
9688 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009689 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009690 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009691 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009692 }
9693
9694 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009695 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009696 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009697 } else {
9698 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9699 if (session->hostname == NULL) {
9700 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9701 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009702
Gilles Peskine449bd832023-01-11 14:50:10 +01009703 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009704 }
9705
Gilles Peskine449bd832023-01-11 14:50:10 +01009706 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009707}
Xiaokang Qian03409292022-10-12 02:49:52 +00009708#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9709 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009710 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009711 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009712
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009713#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9714 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009715int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9716 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009717{
9718 size_t alpn_len = 0;
9719
9720 if (alpn != NULL) {
9721 alpn_len = strlen(alpn);
9722
9723 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9725 }
9726 }
9727
9728 if (session->ticket_alpn != NULL) {
9729 mbedtls_zeroize_and_free(session->ticket_alpn,
9730 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009731 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009732 }
9733
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009734 if (alpn != NULL) {
9735 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009736 if (session->ticket_alpn == NULL) {
9737 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9738 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009739 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009740 }
9741
9742 return 0;
9743}
9744#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009745
9746/*
9747 * The following functions are used by 1.2 and 1.3, client and server.
9748 */
9749#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
9750int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
9751 const mbedtls_ssl_ciphersuite_t *ciphersuite,
9752 int recv_endpoint,
9753 mbedtls_ssl_protocol_version tls_version,
9754 uint32_t *flags)
9755{
9756 int ret = 0;
9757 unsigned int usage = 0;
9758 const char *ext_oid;
9759 size_t ext_len;
9760
9761 /*
9762 * keyUsage
9763 */
9764
9765 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
9766 * to check what a compliant client will think while choosing which cert
9767 * to send to the client. */
9768#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
9769 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9770 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9771 /* TLS 1.2 server part of the key exchange */
9772 switch (ciphersuite->key_exchange) {
9773 case MBEDTLS_KEY_EXCHANGE_RSA:
9774 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
9775 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
9776 break;
9777
9778 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
9779 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
9780 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
9781 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9782 break;
9783
9784 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
9785 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
9786 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
9787 break;
9788
9789 /* Don't use default: we want warnings when adding new values */
9790 case MBEDTLS_KEY_EXCHANGE_NONE:
9791 case MBEDTLS_KEY_EXCHANGE_PSK:
9792 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
9793 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
9794 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
9795 usage = 0;
9796 }
9797 } else
9798#endif
9799 {
9800 /* This is either TLS 1.3 authentication, which always uses signatures,
9801 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
9802 * options we implement, both using signatures. */
9803 (void) tls_version;
9804 (void) ciphersuite;
9805 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9806 }
9807
9808 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
9809 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
9810 ret = -1;
9811 }
9812
9813 /*
9814 * extKeyUsage
9815 */
9816
9817 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9818 ext_oid = MBEDTLS_OID_SERVER_AUTH;
9819 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
9820 } else {
9821 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
9822 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
9823 }
9824
9825 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
9826 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
9827 ret = -1;
9828 }
9829
9830 return ret;
9831}
9832
Gilles Peskinee61852e2025-02-12 23:28:48 +01009833static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
9834 const char **hostname)
9835{
9836 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
9837 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
9838 }
9839
9840 *hostname = mbedtls_ssl_get_hostname_pointer(ssl);
9841 if (*hostname == NULL) {
9842 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
9843 }
9844
9845 return 0;
9846}
9847
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009848int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
9849 int authmode,
9850 mbedtls_x509_crt *chain,
9851 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
9852 void *rs_ctx)
9853{
9854 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
9855 return 0;
9856 }
9857
9858 /*
9859 * Primary check: use the appropriate X.509 verification function
9860 */
9861 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
9862 void *p_vrfy;
9863 if (ssl->f_vrfy != NULL) {
9864 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
9865 f_vrfy = ssl->f_vrfy;
9866 p_vrfy = ssl->p_vrfy;
9867 } else {
9868 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
9869 f_vrfy = ssl->conf->f_vrfy;
9870 p_vrfy = ssl->conf->p_vrfy;
9871 }
9872
Gilles Peskinee61852e2025-02-12 23:28:48 +01009873 const char *hostname = "";
9874 int ret = get_hostname_for_verification(ssl, &hostname);
9875 if (ret != 0) {
9876 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
9877 return ret;
9878 }
9879
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009880 int have_ca_chain_or_callback = 0;
9881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
9882 if (ssl->conf->f_ca_cb != NULL) {
9883 ((void) rs_ctx);
9884 have_ca_chain_or_callback = 1;
9885
9886 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
9887 ret = mbedtls_x509_crt_verify_with_ca_cb(
9888 chain,
9889 ssl->conf->f_ca_cb,
9890 ssl->conf->p_ca_cb,
9891 ssl->conf->cert_profile,
Gilles Peskinee61852e2025-02-12 23:28:48 +01009892 hostname,
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009893 &ssl->session_negotiate->verify_result,
9894 f_vrfy, p_vrfy);
9895 } else
9896#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
9897 {
9898 mbedtls_x509_crt *ca_chain;
9899 mbedtls_x509_crl *ca_crl;
9900#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
9901 if (ssl->handshake->sni_ca_chain != NULL) {
9902 ca_chain = ssl->handshake->sni_ca_chain;
9903 ca_crl = ssl->handshake->sni_ca_crl;
9904 } else
9905#endif
9906 {
9907 ca_chain = ssl->conf->ca_chain;
9908 ca_crl = ssl->conf->ca_crl;
9909 }
9910
9911 if (ca_chain != NULL) {
9912 have_ca_chain_or_callback = 1;
9913 }
9914
9915 ret = mbedtls_x509_crt_verify_restartable(
9916 chain,
9917 ca_chain, ca_crl,
9918 ssl->conf->cert_profile,
Gilles Peskinee61852e2025-02-12 23:28:48 +01009919 hostname,
Manuel Pégourié-Gonnardc32a4a22024-08-20 12:14:43 +02009920 &ssl->session_negotiate->verify_result,
9921 f_vrfy, p_vrfy, rs_ctx);
9922 }
9923
9924 if (ret != 0) {
9925 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
9926 }
9927
9928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
9929 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
9930 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
9931 }
9932#endif
9933
9934 /*
9935 * Secondary checks: always done, but change 'ret' only if it was 0
9936 */
9937
9938 /* With TLS 1.2 and ECC certs, check that the curve used by the
9939 * certificate is on our list of acceptable curves.
9940 *
9941 * With TLS 1.3 this is not needed because the curve is part of the
9942 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
9943 * we validate the signature made with the key associated to this cert.
9944 */
9945#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
9946 defined(MBEDTLS_PK_HAVE_ECC_KEYS)
9947 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9948 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
9949 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
9950 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
9951 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
9952 if (ret == 0) {
9953 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9954 }
9955 }
9956 }
9957#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_PK_HAVE_ECC_KEYS */
9958
9959 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9960 if (mbedtls_ssl_check_cert_usage(chain,
9961 ciphersuite_info,
9962 ssl->conf->endpoint,
9963 ssl->tls_version,
9964 &ssl->session_negotiate->verify_result) != 0) {
9965 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9966 if (ret == 0) {
9967 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9968 }
9969 }
9970
9971 /* With authmode optional, we want to keep going if the certificate was
9972 * unacceptable, but still fail on other errors (out of memory etc),
9973 * including fatal errors from the f_vrfy callback.
9974 *
9975 * The only acceptable errors are:
9976 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9977 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9978 * Anything else is a fatal error. */
9979 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9980 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9981 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9982 ret = 0;
9983 }
9984
9985 /* Return a specific error as this is a user error: inconsistent
9986 * configuration - can't verify without trust anchors. */
9987 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9988 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9989 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9990 }
9991
9992 if (ret != 0) {
9993 uint8_t alert;
9994
9995 /* The certificate may have been rejected for several reasons.
9996 Pick one and send the corresponding alert. Which alert to send
9997 may be a subject of debate in some cases. */
9998 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9999 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
10000 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
10001 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
10002 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
10003 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
10004 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
10005 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
10006 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
10007 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
10008 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
10009 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
10010 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
10011 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
10012 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
10013 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
10014 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
10015 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
10016 } else {
10017 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
10018 }
10019 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
10020 alert);
10021 }
10022
10023#if defined(MBEDTLS_DEBUG_C)
10024 if (ssl->session_negotiate->verify_result != 0) {
10025 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
10026 (unsigned int) ssl->session_negotiate->verify_result));
10027 } else {
10028 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
10029 }
10030#endif /* MBEDTLS_DEBUG_C */
10031
10032 return ret;
10033}
10034#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
10035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010036#endif /* MBEDTLS_SSL_TLS_C */