blob: 1c0aab0ac211d400bab9d77da3409ef46eab240a [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
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.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"
Max Fillingerbd81c9d2024-07-22 14:43:56 +020021#include "ssl_tls13_keys.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
Valerio Setti384fbde2024-01-02 13:26:40 +010031#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035
Janos Follath23bdca02016-10-07 14:47:14 +010036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020038#endif
39
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define local translating functions to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049
Ronald Cronad8c17b2022-06-10 17:18:09 +020050#if defined(MBEDTLS_TEST_HOOKS)
51static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
52
53void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010054 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020055{
56 chk_buf_ptr_fail_args.cur = cur;
57 chk_buf_ptr_fail_args.end = end;
58 chk_buf_ptr_fail_args.need = need;
59}
60
Gilles Peskine449bd832023-01-11 14:50:10 +010061void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020062{
Gilles Peskine449bd832023-01-11 14:50:10 +010063 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020064}
65
Gilles Peskine449bd832023-01-11 14:50:10 +010066int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020067{
Gilles Peskine449bd832023-01-11 14:50:10 +010068 return (chk_buf_ptr_fail_args.cur != args->cur) ||
69 (chk_buf_ptr_fail_args.end != args->end) ||
70 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020071}
72#endif /* MBEDTLS_TEST_HOOKS */
73
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010075
Hanno Beckera0e20d02019-05-15 14:03:01 +010076#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010077/* Top-level Connection ID API */
78
Gilles Peskine449bd832023-01-11 14:50:10 +010079int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
80 size_t len,
81 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
84 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
85 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010086
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
88 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
89 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010090 }
91
92 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010093 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010094 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010095}
96
Gilles Peskine449bd832023-01-11 14:50:10 +010097int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
98 int enable,
99 unsigned char const *own_cid,
100 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100101{
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
104 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100105
Hanno Beckerca092242019-04-25 16:01:49 +0100106 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 if (enable == MBEDTLS_SSL_CID_DISABLED) {
108 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
109 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100110 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
112 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (own_cid_len != ssl->conf->cid_len) {
115 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
116 (unsigned) own_cid_len,
117 (unsigned) ssl->conf->cid_len));
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100119 }
120
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100122 /* Truncation is not an issue here because
123 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
124 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100127}
128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
130 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100131 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000133{
134 *enabled = MBEDTLS_SSL_CID_DISABLED;
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000139
140 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
141 * zero as this is indistinguishable from not requesting to use
142 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
144 return 0;
145 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000148 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 if (own_cid != NULL) {
150 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
151 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 }
153
154 *enabled = MBEDTLS_SSL_CID_ENABLED;
155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000157}
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
160 int *enabled,
161 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
162 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100164 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
167 mbedtls_ssl_is_handshake_over(ssl) == 0) {
168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100169 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100170
Hanno Beckerc5f24222019-05-03 12:54:52 +0100171 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
172 * were used, but client and server requested the empty CID.
173 * This is indistinguishable from not using the CID extension
174 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 if (ssl->transform_in->in_cid_len == 0 &&
176 ssl->transform_in->out_cid_len == 0) {
177 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100178 }
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100181 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 if (peer_cid != NULL) {
183 memcpy(peer_cid, ssl->transform_in->out_cid,
184 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100185 }
186 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100187
188 *enabled = MBEDTLS_SSL_CID_ENABLED;
189
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100191}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200197/*
198 * Convert max_fragment_length codes to length.
199 * RFC 6066 says:
200 * enum{
201 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
202 * } MaxFragmentLength;
203 * and we add 0 -> extension unused
204 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100205static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200206{
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 switch (mfl) {
208 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
209 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
210 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
211 return 512;
212 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
213 return 1024;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
215 return 2048;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
217 return 4096;
218 default:
219 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000220 }
221}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
225 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200226{
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 mbedtls_ssl_session_free(dst);
228 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800229#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
230 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000231#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
232 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000233 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800234#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800236
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000237#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
238 defined(MBEDTLS_SSL_EARLY_DATA)
239 dst->ticket_alpn = NULL;
240#endif
241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000243
244#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
249 if (dst->peer_cert == NULL) {
250 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
251 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
256 src->peer_cert->raw.len)) != 0) {
257 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200260 }
261 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000262#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000264 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 mbedtls_calloc(1, src->peer_cert_digest_len);
266 if (dst->peer_cert_digest == NULL) {
267 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
268 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000269
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
271 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000273 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 }
275#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200278
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000279#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
280 defined(MBEDTLS_SSL_EARLY_DATA)
281 {
282 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
283 if (ret != 0) {
284 return ret;
285 }
286 }
287#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800321 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000349 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000381 ssl->in_hdr = ssl->in_buf + hdr_in;
382 mbedtls_ssl_update_in_pointers(ssl);
383 mbedtls_ssl_reset_out_pointers(ssl);
384
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
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100428#if defined(PSA_WANT_ALG_SHA_256)
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
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100437#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100439#if defined(PSA_WANT_ALG_SHA_384)
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);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100448#endif /* PSA_WANT_ALG_SHA_384*/
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
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100458#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100460#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100462#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100464#endif /* PSA_WANT_ALG_SHA_384*/
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)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100476#if defined(PSA_WANT_ALG_SHA_384)
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;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100480#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100481#if defined(PSA_WANT_ALG_SHA_256)
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;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100485#endif /* PSA_WANT_ALG_SHA_256*/
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
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100787#if defined(PSA_WANT_ALG_SHA_384)
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
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100792#if defined(PSA_WANT_ALG_SHA_256)
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{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100833#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100834 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100836#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800837 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100838#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100839#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
841 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200842 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100843 }
844 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
845 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800848#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100849#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100850 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
854 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
855 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200856 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100857 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800858#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100859 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800860}
861
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100862static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100863 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800864{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100865#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100866 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100867 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100868#else /* SHA-256 or SHA-384 */
869 ((void) ssl);
870 (void) buf;
871 (void) len;
872#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100873#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100874 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
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é-Gonnarddf949012023-02-06 10:00:52 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100879#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100880 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
881 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200882 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100883 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800884#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100885 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800886}
887
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100888#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100889static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100890 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800891{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200892 return mbedtls_md_error_from_psa(psa_hash_update(
893 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895#endif
896
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100897#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100898static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100899 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800900{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200901 return mbedtls_md_error_from_psa(psa_hash_update(
902 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800903}
904#endif
905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200907{
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200909
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100910#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500912#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100913#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500914 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916
917 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100918
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200919#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200920 handshake->psa_pake_ctx = psa_pake_operation_init();
921 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200922#if defined(MBEDTLS_SSL_CLI_C)
923 handshake->ecjpake_cache = NULL;
924 handshake->ecjpake_cache_len = 0;
925#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200926#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200927
Gilles Peskineeccd8882020-03-10 12:19:08 +0100928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200930#endif
931
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200932#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
933 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
934#endif
Hanno Becker75173122019-02-06 16:18:31 +0000935
936#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
937 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000939#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200940}
941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200943{
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200945
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
947 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100948
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000949#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100950 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
951 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100952#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953}
954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956{
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200958}
959
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100961static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000962{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
964
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 if (ssl->transform_negotiate) {
968 mbedtls_ssl_transform_free(ssl->transform_negotiate);
969 }
Jerry Yu2e199812022-12-01 18:57:19 +0800970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 if (ssl->session_negotiate) {
972 mbedtls_ssl_session_free(ssl->session_negotiate);
973 }
974 if (ssl->handshake) {
975 mbedtls_ssl_handshake_free(ssl);
976 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977
Jerry Yu2e199812022-12-01 18:57:19 +0800978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200979 /*
980 * Either the pointers are now NULL or cleared properly and can be freed.
981 * Now allocate missing structures.
982 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if (ssl->transform_negotiate == NULL) {
984 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Jerry Yu2e199812022-12-01 18:57:19 +0800986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (ssl->session_negotiate == NULL) {
989 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200990 }
Paul Bakker48916f92012-09-16 19:57:18 +0000991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (ssl->handshake == NULL) {
993 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200994 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
996 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
999 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001000#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001001
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001002 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001005 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001006#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl->session_negotiate == NULL) {
1008 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001011 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001012
1013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001015 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001016#endif
1017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019 ssl->session_negotiate = NULL;
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001022 }
1023
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001024#if defined(MBEDTLS_SSL_EARLY_DATA)
1025#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001026 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001027#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001028#if defined(MBEDTLS_SSL_SRV_C)
1029 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1030#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001031 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001032#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001033
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 mbedtls_ssl_session_init(ssl->session_negotiate);
1036 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001037
Jerry Yu2e199812022-12-01 18:57:19 +08001038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001040#endif
1041
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001042 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001043 ret = mbedtls_ssl_reset_checksum(ssl);
1044 if (ret != 0) {
1045 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1046 return ret;
1047 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001048
Jerry Yud0766ec2022-09-22 10:46:57 +08001049#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1050 defined(MBEDTLS_SSL_SRV_C) && \
1051 defined(MBEDTLS_SSL_SESSION_TICKETS)
1052 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001054#endif
1055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001058 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001063 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001067 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001068#endif
1069
Ronald Crone68ab4f2022-10-05 12:46:29 +02001070#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001073 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1074 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1076 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001077 const int *md;
1078 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001079 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001080 uint16_t *p;
1081
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001082 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1083 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1084 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1087 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001088 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001092#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001093
Jerry Yub476a442022-01-21 18:14:45 +08001094#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001096#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1098 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1099 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001100 }
1101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1103 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1104 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1107 sizeof(uint16_t));
1108 if (ssl->handshake->sig_algs == NULL) {
1109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1110 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 p = (uint16_t *) ssl->handshake->sig_algs;
1113 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1114 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1115 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001116 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001120 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001121#endif
1122#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001125#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001127 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001128 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001130#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001131 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001132 ssl->handshake->sig_algs_heap_allocated = 0;
1133 }
Jerry Yucc539102022-06-27 16:27:35 +08001134#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001135#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001137}
1138
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001139#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001140/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001142static int ssl_cookie_write_dummy(void *ctx,
1143 unsigned char **p, unsigned char *end,
1144 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001145{
1146 ((void) ctx);
1147 ((void) p);
1148 ((void) end);
1149 ((void) cli_id);
1150 ((void) cli_id_len);
1151
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001153}
1154
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001155MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001156static int ssl_cookie_check_dummy(void *ctx,
1157 const unsigned char *cookie, size_t cookie_len,
1158 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001159{
1160 ((void) ctx);
1161 ((void) cookie);
1162 ((void) cookie_len);
1163 ((void) cli_id);
1164 ((void) cli_id_len);
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001168#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001169
Paul Bakker5121ce52009-01-03 21:22:43 +00001170/*
1171 * Initialize an SSL context
1172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174{
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001176}
1177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001179static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001180{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001181 const mbedtls_ssl_config *conf = ssl->conf;
1182
Ronald Cron6f135e12021-12-08 16:57:54 +01001183#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1185 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1186 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1187 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001188 }
1189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1191 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001192 }
1193#endif
1194
1195#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1197 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1198 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001199 }
1200#endif
1201
Ronald Cron6f135e12021-12-08 16:57:54 +01001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1204 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1205 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1206 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 }
1208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1210 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001211 }
1212#endif
1213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1215 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001216}
1217
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001218MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001219static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1220{
1221 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 ret = ssl_conf_version_check(ssl);
1223 if (ret != 0) {
1224 return ret;
1225 }
Jerry Yu60835a82021-08-04 10:13:52 +08001226
1227 /* Space for further checks */
1228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001230}
1231
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001232/*
1233 * Setup an SSL context
1234 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1237 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001238{
Janos Follath865b3eb2019-12-16 11:46:15 +00001239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001240 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1241 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001242
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001243 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if ((ret = ssl_conf_check(ssl)) != 0) {
1246 return ret;
1247 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001248 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001249
Paul Bakker62f2dee2012-09-28 07:31:51 +00001250 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001251 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001252 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001253
1254 /* Set to NULL in case of an error condition */
1255 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001256
Darryl Greenb33cc762019-11-28 14:29:44 +00001257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1258 ssl->in_buf_len = in_buf_len;
1259#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1261 if (ssl->in_buf == NULL) {
1262 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001263 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001264 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001265 }
1266
Darryl Greenb33cc762019-11-28 14:29:44 +00001267#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1268 ssl->out_buf_len = out_buf_len;
1269#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1271 if (ssl->out_buf == NULL) {
1272 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001273 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001274 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 }
1276
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001277 mbedtls_ssl_reset_in_pointers(ssl);
1278 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001279
Johan Pascalb62bb512015-12-03 21:56:45 +01001280#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#endif
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001285 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001289
1290error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 mbedtls_free(ssl->in_buf);
1292 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001293
1294 ssl->conf = NULL;
1295
Darryl Greenb33cc762019-11-28 14:29:44 +00001296#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1297 ssl->in_buf_len = 0;
1298 ssl->out_buf_len = 0;
1299#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001300 ssl->in_buf = NULL;
1301 ssl->out_buf = NULL;
1302
1303 ssl->in_hdr = NULL;
1304 ssl->in_ctr = NULL;
1305 ssl->in_len = NULL;
1306 ssl->in_iv = NULL;
1307 ssl->in_msg = NULL;
1308
1309 ssl->out_hdr = NULL;
1310 ssl->out_ctr = NULL;
1311 ssl->out_len = NULL;
1312 ssl->out_iv = NULL;
1313 ssl->out_msg = NULL;
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001316}
1317
1318/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001319 * Reset an initialized and used SSL context for re-use while retaining
1320 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001321 *
1322 * If partial is non-zero, keep data in the input buffer and client ID.
1323 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1326 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001327{
Darryl Greenb33cc762019-11-28 14:29:44 +00001328#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1329 size_t in_buf_len = ssl->in_buf_len;
1330 size_t out_buf_len = ssl->out_buf_len;
1331#else
1332 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1333 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1334#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001335
Hanno Beckerb0302c42021-08-03 09:39:42 +01001336#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1337 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001338#endif
1339
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001340 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001343 mbedtls_ssl_reset_in_pointers(ssl);
1344 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001345
1346 /* Reset incoming message parsing */
1347 ssl->in_offt = NULL;
1348 ssl->nb_zero = 0;
1349 ssl->in_msgtype = 0;
1350 ssl->in_msglen = 0;
1351 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001352 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001353 ssl->keep_current_message = 0;
1354 ssl->transform_in = NULL;
1355
1356#if defined(MBEDTLS_SSL_PROTO_DTLS)
1357 ssl->next_record_offset = 0;
1358 ssl->in_epoch = 0;
1359#endif
1360
1361 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001365 }
1366
Ronald Cronad8c17b2022-06-10 17:18:09 +02001367 ssl->send_alert = 0;
1368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 /* Reset outgoing message writing */
1370 ssl->out_msgtype = 0;
1371 ssl->out_msglen = 0;
1372 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 memset(ssl->out_buf, 0, out_buf_len);
1374 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001375 ssl->transform_out = NULL;
1376
1377#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379#endif
1380
XiaokangQian2b01dc32022-01-21 02:53:13 +00001381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (ssl->transform) {
1383 mbedtls_ssl_transform_free(ssl->transform);
1384 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001385 ssl->transform = NULL;
1386 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1388
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 mbedtls_ssl_transform_free(ssl->transform_application);
1391 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001392 ssl->transform_application = NULL;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001395#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1397 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001398 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1402 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403 ssl->handshake->transform_handshake = NULL;
1404 }
1405
XiaokangQian2b01dc32022-01-21 02:53:13 +00001406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407}
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001410{
1411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1412
Gilles Peskinef670ba52025-03-07 15:09:32 +01001413 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001414 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1527 void (*f_dbg)(void *, int, const char *, int, const char *),
1528 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001530 conf->f_dbg = f_dbg;
1531 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1535 void *p_bio,
1536 mbedtls_ssl_send_t *f_send,
1537 mbedtls_ssl_recv_t *f_recv,
1538 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001539{
1540 ssl->p_bio = p_bio;
1541 ssl->f_send = f_send;
1542 ssl->f_recv = f_recv;
1543 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001544}
1545
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001547void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001548{
1549 ssl->mtu = mtu;
1550}
1551#endif
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001554{
1555 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001556}
1557
Gilles Peskine449bd832023-01-11 14:50:10 +01001558void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1559 void *p_timer,
1560 mbedtls_ssl_set_timer_t *f_set_timer,
1561 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001562{
1563 ssl->p_timer = p_timer;
1564 ssl->f_set_timer = f_set_timer;
1565 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001566
1567 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001569}
1570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001572void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1573 void *p_cache,
1574 mbedtls_ssl_cache_get_t *f_get_cache,
1575 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001576{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001577 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001578 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001579 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001580}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001584int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001585{
Janos Follath865b3eb2019-12-16 11:46:15 +00001586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001589 session == NULL ||
1590 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1592 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001593 }
1594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if (ssl->handshake->resume == 1) {
1596 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1597 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001598
Jerry Yu21092062022-10-10 21:21:31 +08001599#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001601#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001602 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001606 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1608 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1609 session->ciphersuite));
1610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001611 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001612#else
1613 /*
1614 * If session tickets are not enabled, it is not possible to resume a
1615 * TLS 1.3 session, thus do not make any change to the SSL context in
1616 * the first place.
1617 */
1618 return 0;
1619#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001620 }
Jerry Yu21092062022-10-10 21:21:31 +08001621#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1624 session)) != 0) {
1625 return ret;
1626 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001627
Paul Bakker0a597072012-09-25 21:55:46 +00001628 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001631}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1635 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001636{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001637 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001638}
1639
Ronald Cron6f135e12021-12-08 16:57:54 +01001640#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1642 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001643{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001644 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001645}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001646
1647#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001648void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1649 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001650{
1651 conf->early_data_enabled = early_data_enabled;
1652}
Jerry Yucc4e0072022-11-22 17:22:22 +08001653
1654#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001655void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001657{
Jerry Yu39da9852022-12-06 16:58:36 +08001658 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001659}
1660#endif /* MBEDTLS_SSL_SRV_C */
1661
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001662#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001663#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001666void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1667 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001668{
1669 conf->cert_profile = profile;
1670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001673{
1674 mbedtls_ssl_key_cert *cur = key_cert, *next;
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001677 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001679 cur = next;
1680 }
1681}
1682
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001683/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001685static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1686 mbedtls_x509_crt *cert,
1687 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001688{
niisato8ee24222018-06-25 19:05:48 +09001689 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001692 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001694 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001696 }
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1699 if (new_cert == NULL) {
1700 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1701 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001702
niisato8ee24222018-06-25 19:05:48 +09001703 new_cert->cert = cert;
1704 new_cert->key = key;
1705 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001706
Glenn Strauss36872db2022-01-22 05:06:31 -05001707 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001709 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001711 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001713 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 }
niisato8ee24222018-06-25 19:05:48 +09001715 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001716 }
1717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719}
1720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001722 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001724{
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001726}
1727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001729 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001732 conf->ca_chain = ca_chain;
1733 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001734
1735#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1736 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1737 * cannot be used together. */
1738 conf->f_ca_cb = NULL;
1739 conf->p_ca_cb = NULL;
1740#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001741}
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1745 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1746 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001747{
1748 conf->f_ca_cb = f_ca_cb;
1749 conf->p_ca_cb = p_ca_cb;
1750
1751 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1752 * cannot be used together. */
1753 conf->ca_chain = NULL;
1754 conf->ca_crl = NULL;
1755}
1756#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001758
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001759#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001760const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1761 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001762{
1763 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001765}
1766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1768 mbedtls_x509_crt *own_cert,
1769 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001770{
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1772 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001773}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *ca_chain,
1777 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001778{
1779 ssl->handshake->sni_ca_chain = ca_chain;
1780 ssl->handshake->sni_ca_crl = ca_crl;
1781}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001782
Glenn Strauss999ef702022-03-11 01:37:23 -05001783#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001784void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1785 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001786{
1787 ssl->handshake->dn_hints = crt;
1788}
1789#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1792 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001793{
1794 ssl->handshake->sni_authmode = authmode;
1795}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001796#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1797
Hanno Becker8927c832019-04-03 12:52:50 +01001798#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1800 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1801 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001802{
1803 ssl->f_vrfy = f_vrfy;
1804 ssl->p_vrfy = p_vrfy;
1805}
1806#endif
1807
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001808#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001809
Przemek Stekielfde11282023-03-13 16:06:09 +01001810static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1811static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1812
Valerio Setti016f6822022-12-09 14:17:50 +01001813static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_ssl_context *ssl,
1815 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001816{
1817 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001818 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001819 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001820 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001821 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001822 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1824 psa_pake_cs_set_primitive(&cipher_suite,
1825 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1826 PSA_ECC_FAMILY_SECP_R1,
1827 256));
1828 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1831 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001832 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001836 user = jpake_server_id;
1837 user_len = sizeof(jpake_server_id);
1838 peer = jpake_client_id;
1839 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001841 user = jpake_client_id;
1842 user_len = sizeof(jpake_client_id);
1843 peer = jpake_server_id;
1844 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001846
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001847 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1848 if (status != PSA_SUCCESS) {
1849 return status;
1850 }
1851
1852 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001854 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 }
Valerio Setti016f6822022-12-09 14:17:50 +01001856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1858 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001859 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 }
Valerio Setti016f6822022-12-09 14:17:50 +01001861
1862 ssl->handshake->psa_pake_ctx_is_ok = 1;
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1868 const unsigned char *pw,
1869 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001870{
1871 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1872 psa_status_t status;
1873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 if (ssl->handshake == NULL || ssl->conf == NULL) {
1875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001876 }
1877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 /* Empty password is not valid */
1879 if ((pw == NULL) || (pw_len == 0)) {
1880 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1881 }
1882
1883 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1884 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1885 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1886
1887 status = psa_import_key(&attributes, pw, pw_len,
1888 &ssl->handshake->psa_pake_password);
1889 if (status != PSA_SUCCESS) {
1890 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1891 }
1892
1893 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1894 ssl->handshake->psa_pake_password);
1895 if (status != PSA_SUCCESS) {
1896 psa_destroy_key(ssl->handshake->psa_pake_password);
1897 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1898 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1899 }
1900
1901 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001902}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1905 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001906{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001907 psa_status_t status;
1908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (ssl->handshake == NULL || ssl->conf == NULL) {
1910 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001911 }
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (mbedtls_svc_key_id_is_null(pwd)) {
1914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1915 }
1916
1917 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1918 if (status != PSA_SUCCESS) {
1919 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1920 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1921 }
1922
1923 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001924}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001925#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001926
Ronald Cron73fe8df2022-10-05 14:31:43 +02001927#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001928int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001929{
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (conf->psk_identity == NULL ||
1931 conf->psk_identity_len == 0) {
1932 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001933 }
1934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1936 return 1;
1937 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001938
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 if (conf->psk != NULL && conf->psk_len != 0) {
1940 return 1;
1941 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001944}
1945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001947{
1948 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001950 /* The maintenance of the PSK key slot is the
1951 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001952 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001953 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001955 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001956 conf->psk = NULL;
1957 conf->psk_len = 0;
1958 }
1959
1960 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (conf->psk_identity != NULL) {
1962 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001963 conf->psk_identity = NULL;
1964 conf->psk_identity_len = 0;
1965 }
1966}
1967
Hanno Becker7390c712018-11-15 13:33:04 +00001968/* This function assumes that PSK identity in the SSL config is unset.
1969 * It checks that the provided identity is well-formed and attempts
1970 * to make a copy of it in the SSL config.
1971 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001972MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001973static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1974 unsigned char const *psk_identity,
1975 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001976{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001977 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001979 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 (psk_identity_len >> 16) != 0 ||
1981 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001983 }
1984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1986 if (conf->psk_identity == NULL) {
1987 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1988 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001989
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001990 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001994}
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1997 const unsigned char *psk, size_t psk_len,
1998 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001999{
Janos Follath865b3eb2019-12-16 11:46:15 +00002000 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002001
2002 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2004 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2005 }
Hanno Becker7390c712018-11-15 13:33:04 +00002006
2007 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if (psk == NULL) {
2009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2010 }
2011 if (psk_len == 0) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2013 }
2014 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2016 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2019 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2020 }
Hanno Becker7390c712018-11-15 13:33:04 +00002021 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002023
2024 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2026 if (ret != 0) {
2027 ssl_conf_remove_psk(conf);
2028 }
Hanno Becker7390c712018-11-15 13:33:04 +00002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002031}
2032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002034{
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002036 /* The maintenance of the external PSK key slot is the
2037 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (ssl->handshake->psk_opaque_is_internal) {
2039 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002040 ssl->handshake->psk_opaque_is_internal = 0;
2041 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002042 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002043 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002044}
2045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2047 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002048{
Neil Armstrong501c9322022-05-03 09:35:09 +02002049 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002051 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002052 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if (psk == NULL || ssl->handshake == NULL) {
2055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2056 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002063
Jerry Yuccc68a42022-07-26 16:39:20 +08002064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2066 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2067 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2068 } else {
2069 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2070 }
2071 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002072 }
2073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002074
Jerry Yu568ec252022-07-22 21:27:34 +08002075#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2077 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2078 psa_set_key_usage_flags(&key_attributes,
2079 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002080 }
2081#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 psa_set_key_algorithm(&key_attributes, alg);
2084 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2087 if (status != PSA_SUCCESS) {
2088 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2089 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002090
2091 /* Allow calling psa_destroy_key() on psk remove */
2092 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002094}
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2097 mbedtls_svc_key_id_t psk,
2098 const unsigned char *psk_identity,
2099 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002100{
Janos Follath865b3eb2019-12-16 11:46:15 +00002101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102
2103 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2105 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2106 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002107
Hanno Becker7390c712018-11-15 13:33:04 +00002108 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (mbedtls_svc_key_id_is_null(psk)) {
2110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2111 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002112 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002113
2114 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2116 psk_identity_len);
2117 if (ret != 0) {
2118 ssl_conf_remove_psk(conf);
2119 }
Hanno Becker7390c712018-11-15 13:33:04 +00002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122}
2123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2125 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002126{
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if ((mbedtls_svc_key_id_is_null(psk)) ||
2128 (ssl->handshake == NULL)) {
2129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2130 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002133 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002135}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002136
Jerry Yu8897c072022-08-12 13:56:53 +08002137#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002138void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2139 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2140 size_t),
2141 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002142{
2143 conf->f_psk = f_psk;
2144 conf->p_psk = p_psk;
2145}
Jerry Yu8897c072022-08-12 13:56:53 +08002146#endif /* MBEDTLS_SSL_SRV_C */
2147
Ronald Cron73fe8df2022-10-05 14:31:43 +02002148#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002149
Gilles Peskine301711e2022-04-26 16:57:05 +02002150static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002153#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 if (alg == PSA_ALG_CBC_NO_PADDING) {
2155 return MBEDTLS_SSL_MODE_CBC;
2156 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002157#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (PSA_ALG_IS_AEAD(alg)) {
2159 return MBEDTLS_SSL_MODE_AEAD;
2160 }
2161 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002162}
2163
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002164
Gilles Peskinee108d982022-04-26 16:50:40 +02002165static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2166 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002168{
2169#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2171 base_mode == MBEDTLS_SSL_MODE_CBC) {
2172 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002173 }
2174#else
2175 (void) encrypt_then_mac;
2176#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002178}
2179
Neil Armstrongab555e02022-04-04 11:07:59 +02002180mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002182{
Gilles Peskinee108d982022-04-26 16:50:40 +02002183 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002185 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002186
Gilles Peskinee108d982022-04-26 16:50:40 +02002187 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002188#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002189 encrypt_then_mac = transform->encrypt_then_mac;
2190#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002192}
2193
Neil Armstrongab555e02022-04-04 11:07:59 +02002194mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002195#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002197#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002199{
Gilles Peskinee108d982022-04-26 16:50:40 +02002200 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2201
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002202 psa_status_t status;
2203 psa_algorithm_t alg;
2204 psa_key_type_t type;
2205 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002206 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2207 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (status == PSA_SUCCESS) {
2209 base_mode = mbedtls_ssl_get_base_mode(alg);
2210 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002211
Gilles Peskinee108d982022-04-26 16:50:40 +02002212#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2213 int encrypt_then_mac = 0;
2214#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002216}
2217
Jerry Yu251a12e2022-07-13 15:15:48 +08002218
Ronald Cron8b592d22024-11-12 18:08:25 +01002219const mbedtls_error_pair_t psa_to_ssl_errors[] =
2220{
2221 { PSA_SUCCESS, 0 },
2222 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2223 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2224 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2225 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2226 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2227 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2228};
2229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2231 size_t taglen,
2232 psa_algorithm_t *alg,
2233 psa_key_type_t *key_type,
2234 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002235{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002236#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002237 (void) taglen;
2238#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002240#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002241 case MBEDTLS_CIPHER_AES_128_CBC:
2242 *alg = PSA_ALG_CBC_NO_PADDING;
2243 *key_type = PSA_KEY_TYPE_AES;
2244 *key_size = 128;
2245 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002246#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002247#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002248 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002250 *key_type = PSA_KEY_TYPE_AES;
2251 *key_size = 128;
2252 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002253#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002254#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002255 case MBEDTLS_CIPHER_AES_128_GCM:
2256 *alg = PSA_ALG_GCM;
2257 *key_type = PSA_KEY_TYPE_AES;
2258 *key_size = 128;
2259 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002260#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002261#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002262 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002264 *key_type = PSA_KEY_TYPE_AES;
2265 *key_size = 192;
2266 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002267#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002268#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002269 case MBEDTLS_CIPHER_AES_192_GCM:
2270 *alg = PSA_ALG_GCM;
2271 *key_type = PSA_KEY_TYPE_AES;
2272 *key_size = 192;
2273 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002274#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002275#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002276 case MBEDTLS_CIPHER_AES_256_CBC:
2277 *alg = PSA_ALG_CBC_NO_PADDING;
2278 *key_type = PSA_KEY_TYPE_AES;
2279 *key_size = 256;
2280 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002281#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002282#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002283 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002285 *key_type = PSA_KEY_TYPE_AES;
2286 *key_size = 256;
2287 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002288#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002289#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002290 case MBEDTLS_CIPHER_AES_256_GCM:
2291 *alg = PSA_ALG_GCM;
2292 *key_type = PSA_KEY_TYPE_AES;
2293 *key_size = 256;
2294 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002295#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002296#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002297 case MBEDTLS_CIPHER_ARIA_128_CBC:
2298 *alg = PSA_ALG_CBC_NO_PADDING;
2299 *key_type = PSA_KEY_TYPE_ARIA;
2300 *key_size = 128;
2301 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002302#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002303#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002304 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002306 *key_type = PSA_KEY_TYPE_ARIA;
2307 *key_size = 128;
2308 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002309#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002310#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002311 case MBEDTLS_CIPHER_ARIA_128_GCM:
2312 *alg = PSA_ALG_GCM;
2313 *key_type = PSA_KEY_TYPE_ARIA;
2314 *key_size = 128;
2315 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002316#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002317#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002318 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002320 *key_type = PSA_KEY_TYPE_ARIA;
2321 *key_size = 192;
2322 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002323#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002324#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002325 case MBEDTLS_CIPHER_ARIA_192_GCM:
2326 *alg = PSA_ALG_GCM;
2327 *key_type = PSA_KEY_TYPE_ARIA;
2328 *key_size = 192;
2329 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002330#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002331#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002332 case MBEDTLS_CIPHER_ARIA_256_CBC:
2333 *alg = PSA_ALG_CBC_NO_PADDING;
2334 *key_type = PSA_KEY_TYPE_ARIA;
2335 *key_size = 256;
2336 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002337#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002338#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002339 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002341 *key_type = PSA_KEY_TYPE_ARIA;
2342 *key_size = 256;
2343 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002344#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002345#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002346 case MBEDTLS_CIPHER_ARIA_256_GCM:
2347 *alg = PSA_ALG_GCM;
2348 *key_type = PSA_KEY_TYPE_ARIA;
2349 *key_size = 256;
2350 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002351#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002352#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002353 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2354 *alg = PSA_ALG_CBC_NO_PADDING;
2355 *key_type = PSA_KEY_TYPE_CAMELLIA;
2356 *key_size = 128;
2357 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002358#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002359#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002360 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002362 *key_type = PSA_KEY_TYPE_CAMELLIA;
2363 *key_size = 128;
2364 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002365#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002366#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002367 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2368 *alg = PSA_ALG_GCM;
2369 *key_type = PSA_KEY_TYPE_CAMELLIA;
2370 *key_size = 128;
2371 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002372#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002373#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002374 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002376 *key_type = PSA_KEY_TYPE_CAMELLIA;
2377 *key_size = 192;
2378 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002379#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002380#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002381 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2382 *alg = PSA_ALG_GCM;
2383 *key_type = PSA_KEY_TYPE_CAMELLIA;
2384 *key_size = 192;
2385 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002386#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002387#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002388 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2389 *alg = PSA_ALG_CBC_NO_PADDING;
2390 *key_type = PSA_KEY_TYPE_CAMELLIA;
2391 *key_size = 256;
2392 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002393#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002394#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002395 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002397 *key_type = PSA_KEY_TYPE_CAMELLIA;
2398 *key_size = 256;
2399 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002400#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002401#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002402 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2403 *alg = PSA_ALG_GCM;
2404 *key_type = PSA_KEY_TYPE_CAMELLIA;
2405 *key_size = 256;
2406 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002407#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002408#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002409 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2410 *alg = PSA_ALG_CHACHA20_POLY1305;
2411 *key_type = PSA_KEY_TYPE_CHACHA20;
2412 *key_size = 256;
2413 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002414#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002415 case MBEDTLS_CIPHER_NULL:
2416 *alg = MBEDTLS_SSL_NULL_CIPHER;
2417 *key_type = 0;
2418 *key_size = 0;
2419 break;
2420 default:
2421 return PSA_ERROR_NOT_SUPPORTED;
2422 }
2423
2424 return PSA_SUCCESS;
2425}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002426
Ronald Crone68ab4f2022-10-05 12:46:29 +02002427#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002428#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002429/*
2430 * Set allowed/preferred hashes for handshake signatures
2431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2433 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002434{
2435 conf->sig_hashes = hashes;
2436}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002437#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002438
Jerry Yuf017ee42022-01-12 15:49:48 +08002439/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2441 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002442{
Jerry Yuf017ee42022-01-12 15:49:48 +08002443#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2444 conf->sig_hashes = NULL;
2445#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2446 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002447}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002448#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002449
Brett Warrene0edc842021-08-17 09:53:13 +01002450/*
2451 * Set the allowed groups
2452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2454 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002455{
Brett Warrene0edc842021-08-17 09:53:13 +01002456 conf->group_list = group_list;
2457}
2458
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002459#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002460
2461#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2462/** Whether mbedtls_ssl_set_hostname() has been called.
2463 *
2464 * \param[in] ssl SSL context
2465 *
2466 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2467 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2468 * otherwise \c 0.
2469 */
2470static int mbedtls_ssl_has_set_hostname_been_called(
2471 const mbedtls_ssl_context *ssl)
2472{
Gilles Peskine434016e2025-02-20 18:49:59 +01002473 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002474}
2475#endif
2476
2477static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2478{
2479 if (ssl->hostname != NULL) {
2480 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2481 }
2482 ssl->hostname = NULL;
2483}
2484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002486{
Hanno Becker947194e2017-04-07 13:25:49 +01002487 /* Initialize to suppress unnecessary compiler warning */
2488 size_t hostname_len = 0;
2489
2490 /* Check if new hostname is valid before
2491 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (hostname != NULL) {
2493 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2497 }
Hanno Becker947194e2017-04-07 13:25:49 +01002498 }
2499
2500 /* Now it's clear that we will overwrite the old hostname,
2501 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002502 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002503
2504 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002507 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 } else {
2509 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2510 if (ssl->hostname == NULL) {
2511 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2512 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002515
Hanno Becker947194e2017-04-07 13:25:49 +01002516 ssl->hostname[hostname_len] = '\0';
2517 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002518
Gilles Peskine434016e2025-02-20 18:49:59 +01002519 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002522}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002525#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002526void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2527 int (*f_sni)(void *, mbedtls_ssl_context *,
2528 const unsigned char *, size_t),
2529 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002530{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002531 conf->f_sni = f_sni;
2532 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002533}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002537int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2538 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002539{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002540 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002541 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002542
2543 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002544 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2545 * MUST NOT be truncated."
2546 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002547 */
2548 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 for (p = protos; *p != NULL; p++) {
2550 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002551 tot_len += cur_len;
2552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if ((cur_len == 0) ||
2554 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2555 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2556 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2557 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002558 }
2559
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002560 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002563}
2564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002566{
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002568}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002570
Johan Pascalb62bb512015-12-03 21:56:45 +01002571#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002572void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2573 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002574{
2575 conf->dtls_srtp_mki_support = support_mki_value;
2576}
2577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2579 unsigned char *mki_value,
2580 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002581{
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2583 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002584 }
Ron Eldor591f1622018-01-22 12:30:04 +02002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2587 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002588 }
Ron Eldor591f1622018-01-22 12:30:04 +02002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002591 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002593}
2594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2596 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002597{
Johan Pascal253d0262020-09-22 13:04:45 +02002598 const mbedtls_ssl_srtp_profile *p;
2599 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002600
Johan Pascal253d0262020-09-22 13:04:45 +02002601 /* check the profiles list: all entry must be valid,
2602 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2604 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2605 p++) {
2606 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002607 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002609 /* unsupported value, stop parsing and set the size to an error value */
2610 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002611 }
2612 }
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2615 conf->dtls_srtp_profile_list = NULL;
2616 conf->dtls_srtp_profile_list_len = 0;
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002618 }
2619
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002620 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002621 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002624}
2625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2627 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002628{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002629 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2630 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002632 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002634 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2636 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002637 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002638}
Johan Pascalb62bb512015-12-03 21:56:45 +01002639#endif /* MBEDTLS_SSL_DTLS_SRTP */
2640
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302641#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002642void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002643{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002644 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002645}
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002648{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002649 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002650}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302651#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002652
Janos Follath088ce432017-04-10 12:42:31 +01002653#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002654void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2655 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002656{
2657 conf->cert_req_ca_list = cert_req_ca_list;
2658}
2659#endif
2660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002662void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002664 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002665}
2666#endif
2667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002669void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002670{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002671 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002672}
2673#endif
2674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002676int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002677{
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2679 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002681 }
2682
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002683 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002686}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002690{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002691 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002692}
2693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002695void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002696{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002697 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002698}
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002701{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002702 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002703}
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2706 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002707{
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002709}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002713#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002714void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002715{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002716 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002717}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002718#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002719
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002720#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002721
Jerry Yud0766ec2022-09-22 10:46:57 +08002722#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002723void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2724 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002725{
Jerry Yud0766ec2022-09-22 10:46:57 +08002726 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002727}
2728#endif
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2731 mbedtls_ssl_ticket_write_t *f_ticket_write,
2732 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2733 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002734{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002735 conf->f_ticket_write = f_ticket_write;
2736 conf->f_ticket_parse = f_ticket_parse;
2737 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002738}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002739#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2743 mbedtls_ssl_export_keys_t *f_export_keys,
2744 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002745{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002746 ssl->f_export_keys = f_export_keys;
2747 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002748}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002749
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002750#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002751void mbedtls_ssl_conf_async_private_cb(
2752 mbedtls_ssl_config *conf,
2753 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002754 mbedtls_ssl_async_resume_t *f_async_resume,
2755 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002757{
2758 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002759 conf->f_async_resume = f_async_resume;
2760 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002761 conf->p_async_config_data = async_config_data;
2762}
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002765{
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002767}
2768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002770{
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 if (ssl->handshake == NULL) {
2772 return NULL;
2773 } else {
2774 return ssl->handshake->user_async_ctx;
2775 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002776}
2777
Gilles Peskine449bd832023-01-11 14:50:10 +01002778void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2779 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002780{
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002782 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002784}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002785#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002786
Paul Bakker5121ce52009-01-03 21:22:43 +00002787/*
2788 * SSL get accessors
2789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002791{
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 if (ssl->session != NULL) {
2793 return ssl->session->verify_result;
2794 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (ssl->session_negotiate != NULL) {
2797 return ssl->session_negotiate->verify_result;
2798 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002801}
2802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002804{
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (ssl == NULL || ssl->session == NULL) {
2806 return 0;
2807 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002810}
2811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002813{
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (ssl == NULL || ssl->session == NULL) {
2815 return NULL;
2816 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002817
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002819}
2820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002822{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2825 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002826 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002828 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002830 }
2831 }
2832#endif
2833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002835 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002837 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002839 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002841 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002842}
2843
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002844#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2845
2846size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2847{
2848 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2849 size_t record_size_limit = max_len;
2850
2851 if (ssl->session != NULL &&
2852 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2853 ssl->session->record_size_limit < max_len) {
2854 record_size_limit = ssl->session->record_size_limit;
2855 }
2856
2857 // TODO: this is currently untested
2858 /* During a handshake, use the value being negotiated */
2859 if (ssl->session_negotiate != NULL &&
2860 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2861 ssl->session_negotiate->record_size_limit < max_len) {
2862 record_size_limit = ssl->session_negotiate->record_size_limit;
2863 }
2864
2865 return record_size_limit;
2866}
2867#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2868
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002869#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002871{
David Horstmann95d516f2021-05-04 18:36:56 +01002872 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002873 size_t read_mfl;
2874
Jerry Yuddda0502022-12-01 19:43:12 +08002875#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002876 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2878 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2879 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002880 }
Jerry Yuddda0502022-12-01 19:43:12 +08002881#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002882
2883 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->session_out != NULL) {
2885 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2886 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002887 max_len = read_mfl;
2888 }
2889 }
2890
Jerry Yuddda0502022-12-01 19:43:12 +08002891 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (ssl->session_negotiate != NULL) {
2893 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2894 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002895 max_len = read_mfl;
2896 }
2897 }
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002900}
2901
Gilles Peskine449bd832023-01-11 14:50:10 +01002902size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002903{
2904 size_t max_len;
2905
2906 /*
2907 * Assume mfl_code is correct since it was checked when set
2908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002910
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002911 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (ssl->session_out != NULL &&
2913 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2914 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002915 }
2916
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002917 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (ssl->session_negotiate != NULL &&
2919 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2920 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002921 }
2922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002924}
2925#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2926
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002927#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002928size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002929{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002930 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2932 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2933 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2934 return 0;
2935 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2938 return ssl->mtu;
2939 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 if (ssl->mtu == 0) {
2942 return ssl->handshake->mtu;
2943 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 return ssl->mtu < ssl->handshake->mtu ?
2946 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002947}
2948#endif /* MBEDTLS_SSL_PROTO_DTLS */
2949
Gilles Peskine449bd832023-01-11 14:50:10 +01002950int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002951{
2952 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2953
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002954#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002955 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002956 !defined(MBEDTLS_SSL_PROTO_DTLS)
2957 (void) ssl;
2958#endif
2959
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002960#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002964 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002966#endif
2967
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002968#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2969 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2970
2971 if (max_len > record_size_limit) {
2972 max_len = record_size_limit;
2973 }
2974#endif
2975
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002976 if (ssl->transform_out != NULL &&
2977 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002978 /*
2979 * In TLS 1.3 case, when records are protected, `max_len` as computed
2980 * above is the maximum length of the TLSInnerPlaintext structure that
2981 * along the plaintext payload contains the inner content type (one byte)
2982 * and some zero padding. Given the algorithm used for padding
2983 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2984 * the plaintext payload. Round down to a multiple of
2985 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2986 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002987 */
2988 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2989 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2990 }
2991
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002992#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2994 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2995 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002996 const size_t overhead = (size_t) ret;
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 if (ret < 0) {
2999 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003000 }
3001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 if (mtu <= overhead) {
3003 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3004 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3005 }
3006
3007 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003008 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003010 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003011#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003012
Hanno Becker0defedb2018-08-10 12:35:02 +01003013#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003014 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3015 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003016 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003017#endif
3018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003020}
3021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003023{
3024 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3025
3026#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3027 (void) ssl;
3028#endif
3029
3030#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003034 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003036#endif
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003039}
3040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003042const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003043{
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 if (ssl == NULL || ssl->session == NULL) {
3045 return NULL;
3046 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003047
Hanno Beckere6824572019-02-07 13:18:46 +00003048#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003050#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003052#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003053}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003057int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3058 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003059{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003060 int ret;
3061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003063 dst == NULL ||
3064 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003067 }
3068
Hanno Beckere810bbc2021-05-14 16:01:05 +01003069 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3070 * idempotent: Each session can only be exported once.
3071 *
3072 * (This is in preparation for TLS 1.3 support where we will
3073 * need the ability to export multiple sessions (aka tickets),
3074 * which will be achieved by calling mbedtls_ssl_get_session()
3075 * multiple times until it fails.)
3076 *
3077 * Check whether we have already exported the current session,
3078 * and fail if so.
3079 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (ssl->session->exported == 1) {
3081 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3082 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003083
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3085 if (ret != 0) {
3086 return ret;
3087 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003088
3089 /* Remember that we've exported the session. */
3090 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003092}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003094
David Horstmanncb01b362024-02-29 17:31:46 +00003095#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3096
3097/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003098 *
David Horstmanncb01b362024-02-29 17:31:46 +00003099 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003100 */
3101static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3102 unsigned char *buf,
3103 size_t buf_len)
3104{
3105 unsigned char *p = buf;
3106 size_t used = 0;
3107
3108#if defined(MBEDTLS_HAVE_TIME)
3109 uint64_t start;
3110#endif
3111#if defined(MBEDTLS_X509_CRT_PARSE_C)
3112#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3113 size_t cert_len;
3114#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3115#endif /* MBEDTLS_X509_CRT_PARSE_C */
3116
3117 /*
3118 * Time
3119 */
3120#if defined(MBEDTLS_HAVE_TIME)
3121 used += 8;
3122
3123 if (used <= buf_len) {
3124 start = (uint64_t) session->start;
3125
3126 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3127 p += 8;
3128 }
3129#endif /* MBEDTLS_HAVE_TIME */
3130
3131 /*
3132 * Basic mandatory fields
3133 */
3134 used += 1 /* id_len */
3135 + sizeof(session->id)
3136 + sizeof(session->master)
3137 + 4; /* verify_result */
3138
3139 if (used <= buf_len) {
3140 *p++ = MBEDTLS_BYTE_0(session->id_len);
3141 memcpy(p, session->id, 32);
3142 p += 32;
3143
3144 memcpy(p, session->master, 48);
3145 p += 48;
3146
3147 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3148 p += 4;
3149 }
3150
3151 /*
3152 * Peer's end-entity certificate
3153 */
3154#if defined(MBEDTLS_X509_CRT_PARSE_C)
3155#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3156 if (session->peer_cert == NULL) {
3157 cert_len = 0;
3158 } else {
3159 cert_len = session->peer_cert->raw.len;
3160 }
3161
3162 used += 3 + cert_len;
3163
3164 if (used <= buf_len) {
3165 *p++ = MBEDTLS_BYTE_2(cert_len);
3166 *p++ = MBEDTLS_BYTE_1(cert_len);
3167 *p++ = MBEDTLS_BYTE_0(cert_len);
3168
3169 if (session->peer_cert != NULL) {
3170 memcpy(p, session->peer_cert->raw.p, cert_len);
3171 p += cert_len;
3172 }
3173 }
3174#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3175 if (session->peer_cert_digest != NULL) {
3176 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3177 if (used <= buf_len) {
3178 *p++ = (unsigned char) session->peer_cert_digest_type;
3179 *p++ = (unsigned char) session->peer_cert_digest_len;
3180 memcpy(p, session->peer_cert_digest,
3181 session->peer_cert_digest_len);
3182 p += session->peer_cert_digest_len;
3183 }
3184 } else {
3185 used += 2;
3186 if (used <= buf_len) {
3187 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3188 *p++ = 0;
3189 }
3190 }
3191#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3192#endif /* MBEDTLS_X509_CRT_PARSE_C */
3193
3194 /*
3195 * Session ticket if any, plus associated data
3196 */
3197#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3198#if defined(MBEDTLS_SSL_CLI_C)
3199 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3200 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3201
3202 if (used <= buf_len) {
3203 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3204 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3205 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3206
3207 if (session->ticket != NULL) {
3208 memcpy(p, session->ticket, session->ticket_len);
3209 p += session->ticket_len;
3210 }
3211
3212 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3213 p += 4;
3214 }
3215 }
3216#endif /* MBEDTLS_SSL_CLI_C */
3217#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3218 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3219 used += 8;
3220
3221 if (used <= buf_len) {
3222 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3223 p += 8;
3224 }
3225 }
3226#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3227#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3228
3229 /*
3230 * Misc extension-related info
3231 */
3232#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3233 used += 1;
3234
3235 if (used <= buf_len) {
3236 *p++ = session->mfl_code;
3237 }
3238#endif
3239
3240#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3241 used += 1;
3242
3243 if (used <= buf_len) {
3244 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3245 }
3246#endif
3247
3248 return used;
3249}
3250
3251MBEDTLS_CHECK_RETURN_CRITICAL
3252static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3253 const unsigned char *buf,
3254 size_t len)
3255{
3256#if defined(MBEDTLS_HAVE_TIME)
3257 uint64_t start;
3258#endif
3259#if defined(MBEDTLS_X509_CRT_PARSE_C)
3260#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3261 size_t cert_len;
3262#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3263#endif /* MBEDTLS_X509_CRT_PARSE_C */
3264
3265 const unsigned char *p = buf;
3266 const unsigned char * const end = buf + len;
3267
3268 /*
3269 * Time
3270 */
3271#if defined(MBEDTLS_HAVE_TIME)
3272 if (8 > (size_t) (end - p)) {
3273 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3274 }
3275
3276 start = MBEDTLS_GET_UINT64_BE(p, 0);
3277 p += 8;
3278
3279 session->start = (time_t) start;
3280#endif /* MBEDTLS_HAVE_TIME */
3281
3282 /*
3283 * Basic mandatory fields
3284 */
3285 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3287 }
3288
3289 session->id_len = *p++;
3290 memcpy(session->id, p, 32);
3291 p += 32;
3292
3293 memcpy(session->master, p, 48);
3294 p += 48;
3295
3296 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3297 p += 4;
3298
3299 /* Immediately clear invalid pointer values that have been read, in case
3300 * we exit early before we replaced them with valid ones. */
3301#if defined(MBEDTLS_X509_CRT_PARSE_C)
3302#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3303 session->peer_cert = NULL;
3304#else
3305 session->peer_cert_digest = NULL;
3306#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3307#endif /* MBEDTLS_X509_CRT_PARSE_C */
3308#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3309 session->ticket = NULL;
3310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3311
3312 /*
3313 * Peer certificate
3314 */
3315#if defined(MBEDTLS_X509_CRT_PARSE_C)
3316#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3317 /* Deserialize CRT from the end of the ticket. */
3318 if (3 > (size_t) (end - p)) {
3319 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3320 }
3321
3322 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3323 p += 3;
3324
3325 if (cert_len != 0) {
3326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3327
3328 if (cert_len > (size_t) (end - p)) {
3329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3330 }
3331
3332 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3333
3334 if (session->peer_cert == NULL) {
3335 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3336 }
3337
3338 mbedtls_x509_crt_init(session->peer_cert);
3339
3340 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3341 p, cert_len)) != 0) {
3342 mbedtls_x509_crt_free(session->peer_cert);
3343 mbedtls_free(session->peer_cert);
3344 session->peer_cert = NULL;
3345 return ret;
3346 }
3347
3348 p += cert_len;
3349 }
3350#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3351 /* Deserialize CRT digest from the end of the ticket. */
3352 if (2 > (size_t) (end - p)) {
3353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3354 }
3355
3356 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3357 session->peer_cert_digest_len = (size_t) *p++;
3358
3359 if (session->peer_cert_digest_len != 0) {
3360 const mbedtls_md_info_t *md_info =
3361 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3362 if (md_info == NULL) {
3363 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3364 }
3365 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3366 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3367 }
3368
3369 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3370 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3371 }
3372
3373 session->peer_cert_digest =
3374 mbedtls_calloc(1, session->peer_cert_digest_len);
3375 if (session->peer_cert_digest == NULL) {
3376 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3377 }
3378
3379 memcpy(session->peer_cert_digest, p,
3380 session->peer_cert_digest_len);
3381 p += session->peer_cert_digest_len;
3382 }
3383#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3384#endif /* MBEDTLS_X509_CRT_PARSE_C */
3385
3386 /*
3387 * Session ticket and associated data
3388 */
3389#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3390#if defined(MBEDTLS_SSL_CLI_C)
3391 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3392 if (3 > (size_t) (end - p)) {
3393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3394 }
3395
3396 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3397 p += 3;
3398
3399 if (session->ticket_len != 0) {
3400 if (session->ticket_len > (size_t) (end - p)) {
3401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3402 }
3403
3404 session->ticket = mbedtls_calloc(1, session->ticket_len);
3405 if (session->ticket == NULL) {
3406 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3407 }
3408
3409 memcpy(session->ticket, p, session->ticket_len);
3410 p += session->ticket_len;
3411 }
3412
3413 if (4 > (size_t) (end - p)) {
3414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3415 }
3416
3417 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3418 p += 4;
3419 }
3420#endif /* MBEDTLS_SSL_CLI_C */
3421#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3422 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3423 if (8 > (size_t) (end - p)) {
3424 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3425 }
3426 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3427 p += 8;
3428 }
3429#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3430#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3431
3432 /*
3433 * Misc extension-related info
3434 */
3435#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3436 if (1 > (size_t) (end - p)) {
3437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3438 }
3439
3440 session->mfl_code = *p++;
3441#endif
3442
3443#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3444 if (1 > (size_t) (end - p)) {
3445 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3446 }
3447
3448 session->encrypt_then_mac = *p++;
3449#endif
3450
3451 /* Done, should have consumed entire buffer */
3452 if (p != end) {
3453 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3454 }
3455
3456 return 0;
3457}
3458
3459#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3460
3461#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3462/* Serialization of TLS 1.3 sessions:
3463 *
David Horstmanncb01b362024-02-29 17:31:46 +00003464 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003465 */
3466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3467MBEDTLS_CHECK_RETURN_CRITICAL
3468static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3469 unsigned char *buf,
3470 size_t buf_len,
3471 size_t *olen)
3472{
3473 unsigned char *p = buf;
3474#if defined(MBEDTLS_SSL_CLI_C) && \
3475 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3476 size_t hostname_len = (session->hostname == NULL) ?
3477 0 : strlen(session->hostname) + 1;
3478#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003479
3480#if defined(MBEDTLS_SSL_SRV_C) && \
3481 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003482 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003483 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003484#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003485 size_t needed = 4 /* ticket_age_add */
3486 + 1 /* ticket_flags */
3487 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003488
David Horstmanne59f9702024-02-29 16:08:57 +00003489 *olen = 0;
3490
3491 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3492 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3493 }
3494 needed += session->resumption_key_len; /* resumption_key */
3495
3496#if defined(MBEDTLS_SSL_EARLY_DATA)
3497 needed += 4; /* max_early_data_size */
3498#endif
3499#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3500 needed += 2; /* record_size_limit */
3501#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3502
3503#if defined(MBEDTLS_HAVE_TIME)
3504 needed += 8; /* ticket_creation_time or ticket_reception_time */
3505#endif
3506
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003507#if defined(MBEDTLS_SSL_SRV_C)
3508 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3509#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003510 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003511 + alpn_len; /* alpn */
3512#endif
3513 }
3514#endif /* MBEDTLS_SSL_SRV_C */
3515
David Horstmanne59f9702024-02-29 16:08:57 +00003516#if defined(MBEDTLS_SSL_CLI_C)
3517 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3518#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3519 needed += 2 /* hostname_len */
3520 + hostname_len; /* hostname */
3521#endif
3522
3523 needed += 4 /* ticket_lifetime */
3524 + 2; /* ticket_len */
3525
3526 /* Check size_t overflow */
3527 if (session->ticket_len > SIZE_MAX - needed) {
3528 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3529 }
3530
3531 needed += session->ticket_len; /* ticket */
3532 }
3533#endif /* MBEDTLS_SSL_CLI_C */
3534
3535 *olen = needed;
3536 if (needed > buf_len) {
3537 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3538 }
3539
3540 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3541 p[4] = session->ticket_flags;
3542
3543 /* save resumption_key */
3544 p[5] = session->resumption_key_len;
3545 p += 6;
3546 memcpy(p, session->resumption_key, session->resumption_key_len);
3547 p += session->resumption_key_len;
3548
3549#if defined(MBEDTLS_SSL_EARLY_DATA)
3550 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3551 p += 4;
3552#endif
3553#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3554 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3555 p += 2;
3556#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3557
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003558#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003559 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003560#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003561 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3562 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003563#endif /* MBEDTLS_HAVE_TIME */
3564
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003565#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003566 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3567 p += 2;
3568
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003569 if (alpn_len > 0) {
3570 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003571 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003572 p += alpn_len;
3573 }
3574#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3575 }
3576#endif /* MBEDTLS_SSL_SRV_C */
3577
David Horstmanne59f9702024-02-29 16:08:57 +00003578#if defined(MBEDTLS_SSL_CLI_C)
3579 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3580#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3581 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3582 p += 2;
3583 if (hostname_len > 0) {
3584 /* save host name */
3585 memcpy(p, session->hostname, hostname_len);
3586 p += hostname_len;
3587 }
3588#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3589
3590#if defined(MBEDTLS_HAVE_TIME)
3591 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3592 p += 8;
3593#endif
3594 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3595 p += 4;
3596
3597 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3598 p += 2;
3599
3600 if (session->ticket != NULL && session->ticket_len > 0) {
3601 memcpy(p, session->ticket, session->ticket_len);
3602 p += session->ticket_len;
3603 }
3604 }
3605#endif /* MBEDTLS_SSL_CLI_C */
3606 return 0;
3607}
3608
3609MBEDTLS_CHECK_RETURN_CRITICAL
3610static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3611 const unsigned char *buf,
3612 size_t len)
3613{
3614 const unsigned char *p = buf;
3615 const unsigned char *end = buf + len;
3616
3617 if (end - p < 6) {
3618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3619 }
3620 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3621 session->ticket_flags = p[4];
3622
3623 /* load resumption_key */
3624 session->resumption_key_len = p[5];
3625 p += 6;
3626
3627 if (end - p < session->resumption_key_len) {
3628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3629 }
3630
3631 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3633 }
3634 memcpy(session->resumption_key, p, session->resumption_key_len);
3635 p += session->resumption_key_len;
3636
3637#if defined(MBEDTLS_SSL_EARLY_DATA)
3638 if (end - p < 4) {
3639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3640 }
3641 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3642 p += 4;
3643#endif
3644#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3645 if (end - p < 2) {
3646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3647 }
3648 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3649 p += 2;
3650#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3651
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003652#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003653 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003654#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003655 if (end - p < 8) {
3656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3657 }
3658 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3659 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003660#endif /* MBEDTLS_HAVE_TIME */
3661
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003662#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003663 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003664
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003665 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3667 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003668
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003669 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3670 p += 2;
3671
3672 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3674 }
3675
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003676 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003677 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3678 if (ret != 0) {
3679 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003680 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003681 p += alpn_len;
3682 }
3683#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3684 }
3685#endif /* MBEDTLS_SSL_SRV_C */
3686
David Horstmanne59f9702024-02-29 16:08:57 +00003687#if defined(MBEDTLS_SSL_CLI_C)
3688 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3689#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3690 size_t hostname_len;
3691 /* load host name */
3692 if (end - p < 2) {
3693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694 }
3695 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3696 p += 2;
3697
3698 if (end - p < (long int) hostname_len) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 if (hostname_len > 0) {
3702 session->hostname = mbedtls_calloc(1, hostname_len);
3703 if (session->hostname == NULL) {
3704 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3705 }
3706 memcpy(session->hostname, p, hostname_len);
3707 p += hostname_len;
3708 }
3709#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3710
3711#if defined(MBEDTLS_HAVE_TIME)
3712 if (end - p < 8) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3716 p += 8;
3717#endif
3718 if (end - p < 4) {
3719 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3720 }
3721 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3722 p += 4;
3723
3724 if (end - p < 2) {
3725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3726 }
3727 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3728 p += 2;
3729
3730 if (end - p < (long int) session->ticket_len) {
3731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3732 }
3733 if (session->ticket_len > 0) {
3734 session->ticket = mbedtls_calloc(1, session->ticket_len);
3735 if (session->ticket == NULL) {
3736 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3737 }
3738 memcpy(session->ticket, p, session->ticket_len);
3739 p += session->ticket_len;
3740 }
3741 }
3742#endif /* MBEDTLS_SSL_CLI_C */
3743
3744 return 0;
3745
3746}
3747#else /* MBEDTLS_SSL_SESSION_TICKETS */
3748MBEDTLS_CHECK_RETURN_CRITICAL
3749static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3750 unsigned char *buf,
3751 size_t buf_len,
3752 size_t *olen)
3753{
3754 ((void) session);
3755 ((void) buf);
3756 ((void) buf_len);
3757 *olen = 0;
3758 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3759}
3760
3761static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003762 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003763 size_t buf_len)
3764{
3765 ((void) session);
3766 ((void) buf);
3767 ((void) buf_len);
3768 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3769}
3770#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3771#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3772
Paul Bakker5121ce52009-01-03 21:22:43 +00003773/*
Hanno Beckera835da52019-05-16 12:39:07 +01003774 * Define ticket header determining Mbed TLS version
3775 * and structure of the ticket.
3776 */
3777
Hanno Becker94ef3b32019-05-16 12:50:45 +01003778/*
Hanno Becker50b59662019-05-28 14:30:45 +01003779 * Define bitflag determining compile-time settings influencing
3780 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003781 */
3782
Hanno Becker50b59662019-05-28 14:30:45 +01003783#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003784#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003785#else
Hanno Becker3e088662019-05-29 11:10:18 +01003786#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003787#endif /* MBEDTLS_HAVE_TIME */
3788
3789#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003790#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791#else
Hanno Becker3e088662019-05-29 11:10:18 +01003792#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003793#endif /* MBEDTLS_X509_CRT_PARSE_C */
3794
David Horstmann5c5a32f2024-02-13 17:53:35 +00003795#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003796#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003797#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003798#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003799#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3800
Hanno Becker94ef3b32019-05-16 12:50:45 +01003801#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003802#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003803#else
Hanno Becker3e088662019-05-29 11:10:18 +01003804#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003805#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3806
3807#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003808#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003809#else
Hanno Becker3e088662019-05-29 11:10:18 +01003810#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003811#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3812
Hanno Becker94ef3b32019-05-16 12:50:45 +01003813#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003814#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003815#else
Hanno Becker3e088662019-05-29 11:10:18 +01003816#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003817#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3818
Hanno Becker94ef3b32019-05-16 12:50:45 +01003819#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3820#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3821#else
3822#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3823#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3824
David Horstmann92b258b2024-02-13 17:23:34 +00003825#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3826#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3827#else
3828#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3829#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3830
3831#if defined(MBEDTLS_SSL_EARLY_DATA)
3832#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3833#else
3834#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3835#endif /* MBEDTLS_SSL_EARLY_DATA */
3836
3837#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3838#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3839#else
3840#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3841#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3842
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003843#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3844 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003845#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3846#else
3847#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3848#endif /* MBEDTLS_SSL_ALPN */
3849
Hanno Becker3e088662019-05-29 11:10:18 +01003850#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3851#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3852#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3853#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003854#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3855#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003856#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003857#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3858#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3859#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003860#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003861
Hanno Becker50b59662019-05-28 14:30:45 +01003862#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 ((uint16_t) ( \
3864 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3865 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3866 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3867 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3868 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3869 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003870 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003871 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3872 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003873 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3874 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3875 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3876 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003877 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003878 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003879 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003880
Chien Wong4e9683e2023-12-28 17:07:43 +08003881static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003882 MBEDTLS_VERSION_MAJOR,
3883 MBEDTLS_VERSION_MINOR,
3884 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3886 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003887};
Hanno Beckera835da52019-05-16 12:39:07 +01003888
3889/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003890 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003891 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003892 *
David Horstmanncb01b362024-02-29 17:31:46 +00003893 * TLS 1.2 session:
3894 *
3895 * struct {
3896 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3897 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3898 * uint32 ticket_lifetime;
3899 * #endif
3900 * } ClientOnlyData;
3901 *
3902 * struct {
3903 * #if defined(MBEDTLS_HAVE_TIME)
3904 * uint64 start_time;
3905 * #endif
3906 * uint8 session_id_len; // at most 32
3907 * opaque session_id[32];
3908 * opaque master[48]; // fixed length in the standard
3909 * uint32 verify_result;
3910 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3911 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3912 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003913 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003914 * opaque peer_cert_digest<0..2^8-1>
3915 * #endif
3916 * select (endpoint) {
3917 * case client: ClientOnlyData;
3918 * case server: uint64 ticket_creation_time;
3919 * };
3920 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3921 * uint8 mfl_code; // up to 255 according to standard
3922 * #endif
3923 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3924 * uint8 encrypt_then_mac; // 0 or 1
3925 * #endif
3926 * } serialized_session_tls12;
3927 *
3928 *
3929 * TLS 1.3 Session:
3930 *
3931 * struct {
3932 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3933 * opaque hostname<0..2^16-1>;
3934 * #endif
3935 * #if defined(MBEDTLS_HAVE_TIME)
3936 * uint64 ticket_reception_time;
3937 * #endif
3938 * uint32 ticket_lifetime;
3939 * opaque ticket<1..2^16-1>;
3940 * } ClientOnlyData;
3941 *
3942 * struct {
3943 * uint32 ticket_age_add;
3944 * uint8 ticket_flags;
3945 * opaque resumption_key<0..255>;
3946 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3947 * uint32 max_early_data_size;
3948 * #endif
3949 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3950 * uint16 record_size_limit;
3951 * #endif
3952 * select ( endpoint ) {
3953 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003954 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003955 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003956 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003957 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003958 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003959 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003960 * #endif
3961 * };
3962 * } serialized_session_tls13;
3963 *
3964 *
3965 * SSL session:
3966 *
3967 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003968 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003969 * opaque mbedtls_version[3]; // library version: major, minor, patch
3970 * opaque session_format[2]; // library-version specific 16-bit field
3971 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003972 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003973 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003974 * Note: When updating the format, remember to keep
3975 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003976 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003977 * // In this version, `session_format` determines
3978 * // the setting of those compile-time
3979 * // configuration options which influence
3980 * // the structure of mbedtls_ssl_session.
3981 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003982 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003983 * // - TLS 1.2 (0x0303)
3984 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003985 * uint8_t endpoint;
3986 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003987 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003988 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003989 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003990 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003991 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003992 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003993 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003994 *
3995 * };
3996 *
3997 * } serialized_session;
3998 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003999 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004000
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004001MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004002static int ssl_session_save(const mbedtls_ssl_session *session,
4003 unsigned char omit_header,
4004 unsigned char *buf,
4005 size_t buf_len,
4006 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004007{
4008 unsigned char *p = buf;
4009 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004010 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004011#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4012 size_t out_len;
4013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4014#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 if (session == NULL) {
4016 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4017 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004018
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004020 /*
4021 * Add Mbed TLS version identifier
4022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 if (used <= buf_len) {
4026 memcpy(p, ssl_serialized_session_header,
4027 sizeof(ssl_serialized_session_header));
4028 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029 }
4030 }
4031
4032 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004033 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004034 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004035 used += 1 /* TLS version */
4036 + 1 /* endpoint */
4037 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (used <= buf_len) {
4039 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004040 *p++ = session->endpoint;
4041 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4042 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004043 }
4044
4045 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004046 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004048#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 case MBEDTLS_SSL_VERSION_TLS1_2:
4050 used += ssl_tls12_session_save(session, p, remaining_len);
4051 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004052#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4053
Jerry Yu251a12e2022-07-13 15:15:48 +08004054#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 case MBEDTLS_SSL_VERSION_TLS1_3:
4056 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4057 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4058 return ret;
4059 }
4060 used += out_len;
4061 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004062#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 default:
4065 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004066 }
4067
4068 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 if (used > buf_len) {
4070 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4071 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004072
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004074}
4075
4076/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004077 * Public wrapper for ssl_session_save()
4078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004079int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4080 unsigned char *buf,
4081 size_t buf_len,
4082 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004083{
Gilles Peskine449bd832023-01-11 14:50:10 +01004084 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004085}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004086
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004087/*
4088 * Deserialize session, see mbedtls_ssl_session_save() for format.
4089 *
4090 * This internal version is wrapped by a public function that cleans up in
4091 * case of error, and has an extra option omit_header.
4092 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004094static int ssl_session_load(mbedtls_ssl_session *session,
4095 unsigned char omit_header,
4096 const unsigned char *buf,
4097 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004098{
4099 const unsigned char *p = buf;
4100 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004101 size_t remaining_len;
4102
4103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (session == NULL) {
4105 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4106 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004109 /*
4110 * Check Mbed TLS version identifier
4111 */
4112
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004116
4117 if (memcmp(p, ssl_serialized_session_header,
4118 sizeof(ssl_serialized_session_header)) != 0) {
4119 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4120 }
4121 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004122 }
4123
4124 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004125 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004126 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004127 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4129 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004130 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004131 session->endpoint = *p++;
4132 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4133 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004134
4135 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004136 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004138#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 case MBEDTLS_SSL_VERSION_TLS1_2:
4140 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004141#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4142
Jerry Yu438ddd82022-07-07 06:55:50 +00004143#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 case MBEDTLS_SSL_VERSION_TLS1_3:
4145 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004146#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 default:
4149 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004150 }
4151}
4152
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004153/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004154 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004156int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4157 const unsigned char *buf,
4158 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004159{
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004161
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (ret != 0) {
4163 mbedtls_ssl_session_free(session);
4164 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004167}
4168
4169/*
Paul Bakker1961b702013-01-25 14:49:24 +01004170 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004171 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004172MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004173static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004174{
4175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4176
Ronald Cron66dbf912022-02-02 15:33:46 +01004177 /*
4178 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004179 * that were written into the output buffer by the previous handshake step,
4180 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004181 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4182 * We proceed to the next handshake step only when all data from the
4183 * previous one have been sent to the peer, thus we make sure that this is
4184 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4185 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4186 * we have to wait before to go ahead.
4187 * In the case of TLS 1.3, handshake step handlers do not send data to the
4188 * peer. Data are only sent here and through
4189 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004190 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4193 return ret;
4194 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004195
4196#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4198 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4199 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4200 return ret;
4201 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004202 }
4203#endif /* MBEDTLS_SSL_PROTO_DTLS */
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004206}
4207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004209{
Hanno Becker41934dd2021-08-07 19:13:43 +01004210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004213 ssl->conf == NULL ||
4214 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4216 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004217 }
4218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 ret = ssl_prepare_handshake_step(ssl);
4220 if (ret != 0) {
4221 return ret;
4222 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 ret = mbedtls_ssl_handle_pending_alert(ssl);
4225 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004226 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004227 }
Jerry Yue7047812021-09-13 19:26:39 +08004228
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004229 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4230 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4231 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004233#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4235 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004236 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004237
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004239 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004240 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004241 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004242 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004243
Ronald Cron9f0fba32022-02-10 16:45:15 +01004244 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004246 break;
4247
4248 default:
4249#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4251 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4252 } else {
4253 ret = mbedtls_ssl_handshake_client_step(ssl);
4254 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004255#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004257#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004259#endif
4260 }
Jerry Yub9930e72021-08-06 17:11:51 +08004261 }
Ronald Cron6291b232023-03-08 15:51:25 +01004262#endif /* MBEDTLS_SSL_CLI_C */
4263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004264#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004266#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4267 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004269 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 ret = mbedtls_ssl_handshake_server_step(ssl);
4271 }
Ronald Cron6291b232023-03-08 15:51:25 +01004272#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4273 ret = mbedtls_ssl_handshake_server_step(ssl);
4274#else
4275 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004276#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004277 }
4278#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004279
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004281 /* handshake_step return error. And it is same
4282 * with alert_reason.
4283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 if (ssl->send_alert) {
4285 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004286 goto cleanup;
4287 }
4288 }
4289
4290cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004292}
4293
4294/*
4295 * Perform the SSL handshake
4296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004297int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004298{
4299 int ret = 0;
4300
Hanno Beckera817ea42020-10-20 15:20:23 +01004301 /* Sanity checks */
4302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (ssl == NULL || ssl->conf == NULL) {
4304 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4305 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004306
Hanno Beckera817ea42020-10-20 15:20:23 +01004307#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4309 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4310 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4311 "mbedtls_ssl_set_timer_cb() for DTLS"));
4312 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004313 }
4314#endif /* MBEDTLS_SSL_PROTO_DTLS */
4315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004317
Hanno Beckera817ea42020-10-20 15:20:23 +01004318 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4320 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004323 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 }
Paul Bakker1961b702013-01-25 14:49:24 +01004325 }
4326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004330}
4331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004332#if defined(MBEDTLS_SSL_RENEGOTIATION)
4333#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004334/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004335 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004336 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004337MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004338static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004339{
Janos Follath865b3eb2019-12-16 11:46:15 +00004340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004343
4344 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004345 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4346 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4349 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4350 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004351 }
4352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004356}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004357#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004358
4359/*
4360 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361 * - any side: calling mbedtls_ssl_renegotiate(),
4362 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4363 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004364 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004365 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004366 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004368int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004369{
Janos Follath865b3eb2019-12-16 11:46:15 +00004370 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004373
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if ((ret = ssl_handshake_init(ssl)) != 0) {
4375 return ret;
4376 }
Paul Bakker48916f92012-09-16 19:57:18 +00004377
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004378 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4379 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004380#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4382 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4383 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004384 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004386 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004388 }
4389#endif
4390
Gilles Peskinef670ba52025-03-07 15:09:32 +01004391 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004392 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4395 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4396 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004397 }
4398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004400
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004402}
4403
4404/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004405 * Renegotiate current connection on client,
4406 * or request renegotiation on server
4407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004408int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004409{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004410 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (ssl == NULL || ssl->conf == NULL) {
4413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4414 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004415
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004416#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004417 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4419 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4421 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004423 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004424
4425 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (ssl->out_left != 0) {
4427 return mbedtls_ssl_flush_output(ssl);
4428 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004431 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004434#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004435 /*
4436 * On client, either start the renegotiation process or,
4437 * if already in progress, continue the handshake
4438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4440 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4441 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004442 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004443
4444 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4445 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4446 return ret;
4447 }
4448 } else {
4449 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4450 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4451 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004452 }
4453 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004454#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004455
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004457}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004461{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004462 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004465 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004467
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004468#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004469#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (ssl->handshake->group_list_heap_allocated) {
4471 mbedtls_free((void *) handshake->group_list);
4472 }
Brett Warrene0edc842021-08-17 09:53:13 +01004473 handshake->group_list = NULL;
4474#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004475#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004476
Ronald Crone68ab4f2022-10-05 12:46:29 +02004477#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004478#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (ssl->handshake->sig_algs_heap_allocated) {
4480 mbedtls_free((void *) handshake->sig_algs);
4481 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004482 handshake->sig_algs = NULL;
4483#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004484#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (ssl->handshake->certificate_request_context) {
4486 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004487 }
4488#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004489#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004490
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004491#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004492 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004493 ssl->conf->f_async_cancel(ssl);
4494 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004495 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004496
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004497#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4498
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004499#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004501#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004502#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004504#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004505
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004506#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004507 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004508 /*
4509 * Opaque keys are not stored in the handshake's data and it's the user
4510 * responsibility to destroy them. Clear ones, instead, are created by
4511 * the TLS library and should be destroyed at the same level
4512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4514 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004515 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004516 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004517#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004519 handshake->ecjpake_cache = NULL;
4520 handshake->ecjpake_cache_len = 0;
4521#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004522#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004523
Valerio Setti7aeec542023-07-05 18:57:21 +02004524#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004525 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004526 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004527 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004529#endif
4530
Ronald Cron73fe8df2022-10-05 14:31:43 +02004531#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004533 /* The maintenance of the external PSK key slot is the
4534 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if (ssl->handshake->psk_opaque_is_internal) {
4536 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004537 ssl->handshake->psk_opaque_is_internal = 0;
4538 }
4539 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4540 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004541#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004543#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4544 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004545 /*
4546 * Free only the linked list wrapper, not the keys themselves
4547 * since the belong to the SNI callback
4548 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004551
Gilles Peskineeccd8882020-03-10 12:19:08 +01004552#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4554 if (handshake->ecrs_peer_cert != NULL) {
4555 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4556 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004557 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004558#endif
4559
Hanno Becker75173122019-02-06 16:18:31 +00004560#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4561 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004563#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4564
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004565#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4567 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004568#endif /* MBEDTLS_SSL_CLI_C &&
4569 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004570
4571#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 mbedtls_ssl_flight_free(handshake->flight);
4573 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004574#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004575
Valerio Settiea59c432023-07-25 11:14:03 +02004576#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004577 if (handshake->xxdh_psa_privkey_is_external == 0) {
4578 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 }
Valerio Settiea59c432023-07-25 11:14:03 +02004580#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004581
Ronald Cron6f135e12021-12-08 16:57:54 +01004582#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 mbedtls_ssl_transform_free(handshake->transform_handshake);
4584 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004585#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4587 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004588#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004589#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004590
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004591
4592#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4593 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4594 * processes datagrams and the fact that a datagram is allowed to have
4595 * several records in it, it is possible that the I/O buffers are not
4596 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4598 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004599#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004600
Jerry Yuba9c7272021-10-30 11:54:10 +08004601 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 mbedtls_platform_zeroize(handshake,
4603 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004604}
4605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004607{
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004609 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004612#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004614#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004615
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004616#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004617#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4618 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004620#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004622#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004623
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004624#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4625 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004626 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004627#endif
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004630}
4631
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004632#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004633
4634#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4635#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4636#else
4637#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4638#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4639
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004640#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004641
4642#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4643#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4644#else
4645#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4646#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4647
4648#if defined(MBEDTLS_SSL_ALPN)
4649#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4650#else
4651#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4652#endif /* MBEDTLS_SSL_ALPN */
4653
4654#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4655#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4656#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4657#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4658
4659#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 ((uint32_t) ( \
4661 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4662 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4663 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4664 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4665 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4666 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4667 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4668 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004669
Chien Wong4e9683e2023-12-28 17:07:43 +08004670static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004671 MBEDTLS_VERSION_MAJOR,
4672 MBEDTLS_VERSION_MINOR,
4673 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4675 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4676 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4677 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4678 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004679};
4680
Paul Bakker5121ce52009-01-03 21:22:43 +00004681/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004682 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004683 *
4684 * The format of the serialized data is:
4685 * (in the presentation language of TLS, RFC 8446 section 3)
4686 *
4687 * // header
4688 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004689 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004690 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004691 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004692 * Note: When updating the format, remember to keep these
4693 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004694 *
4695 * // session sub-structure
4696 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4697 * // transform sub-structure
4698 * uint8 random[64]; // ServerHello.random+ClientHello.random
4699 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4700 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4701 * // fields from ssl_context
4702 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4703 * uint64 in_window_top; // DTLS: last validated record seq_num
4704 * uint64 in_window; // DTLS: bitmask for replay protection
4705 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4706 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4707 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4708 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4709 *
4710 * Note that many fields of the ssl_context or sub-structures are not
4711 * serialized, as they fall in one of the following categories:
4712 *
4713 * 1. forced value (eg in_left must be 0)
4714 * 2. pointer to dynamically-allocated memory (eg session, transform)
4715 * 3. value can be re-derived from other data (eg session keys from MS)
4716 * 4. value was temporary (eg content of input buffer)
4717 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004719int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4720 unsigned char *buf,
4721 size_t buf_len,
4722 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004723{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004724 unsigned char *p = buf;
4725 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004726 size_t session_len;
4727 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004728
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004729 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004730 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4731 * this function's documentation.
4732 *
4733 * These are due to assumptions/limitations in the implementation. Some of
4734 * them are likely to stay (no handshake in progress) some might go away
4735 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004736 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004737 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4739 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004741 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 if (ssl->handshake != NULL) {
4743 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004745 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004746 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (ssl->transform == NULL || ssl->session == NULL) {
4748 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004750 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004751 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (mbedtls_ssl_check_pending(ssl) != 0) {
4753 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004755 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->out_left != 0) {
4757 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004759 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004760 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4762 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004764 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004765 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4767 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004769 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004770 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4772 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4773 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004774 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004775 /* Renegotiation must not be enabled */
4776#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4778 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004780 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004781#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004782
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004783 /*
4784 * Version and format identifier
4785 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004787
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (used <= buf_len) {
4789 memcpy(p, ssl_serialized_context_header,
4790 sizeof(ssl_serialized_context_header));
4791 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004792 }
4793
4794 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004795 * Session (length + data)
4796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4798 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4799 return ret;
4800 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004801
4802 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 if (used <= buf_len) {
4804 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004805 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 ret = ssl_session_save(ssl->session, 1,
4808 p, session_len, &session_len);
4809 if (ret != 0) {
4810 return ret;
4811 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004812
4813 p += session_len;
4814 }
4815
4816 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004817 * Transform
4818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 used += sizeof(ssl->transform->randbytes);
4820 if (used <= buf_len) {
4821 memcpy(p, ssl->transform->randbytes,
4822 sizeof(ssl->transform->randbytes));
4823 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004824 }
4825
4826#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004827 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004829 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004831 p += ssl->transform->in_cid_len;
4832
4833 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004835 p += ssl->transform->out_cid_len;
4836 }
4837#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4838
4839 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004840 * Saved fields from top-level ssl_context structure
4841 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004842 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 if (used <= buf_len) {
4844 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004845 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004846 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004847
4848#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4849 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (used <= buf_len) {
4851 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004852 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004855 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004856 }
4857#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4858
4859#if defined(MBEDTLS_SSL_PROTO_DTLS)
4860 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004862 *p++ = ssl->disable_datagram_packing;
4863 }
4864#endif /* MBEDTLS_SSL_PROTO_DTLS */
4865
Jerry Yuae0b2e22021-10-08 15:21:19 +08004866 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if (used <= buf_len) {
4868 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004869 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004870 }
4871
4872#if defined(MBEDTLS_SSL_PROTO_DTLS)
4873 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (used <= buf_len) {
4875 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004876 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004877 }
4878#endif /* MBEDTLS_SSL_PROTO_DTLS */
4879
4880#if defined(MBEDTLS_SSL_ALPN)
4881 {
4882 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004884 : 0;
4885
4886 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004888 *p++ = alpn_len;
4889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (ssl->alpn_chosen != NULL) {
4891 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004892 p += alpn_len;
4893 }
4894 }
4895 }
4896#endif /* MBEDTLS_SSL_ALPN */
4897
4898 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004899 * Done
4900 */
4901 *olen = used;
4902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 if (used > buf_len) {
4904 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4905 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004910}
4911
4912/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004913 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004914 *
4915 * This internal version is wrapped by a public function that cleans up in
4916 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004917 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004918MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004919static int ssl_context_load(mbedtls_ssl_context *ssl,
4920 const unsigned char *buf,
4921 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004922{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004923 const unsigned char *p = buf;
4924 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004925 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004927#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004928 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004929#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004930
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004931 /*
4932 * The context should have been freshly setup or reset.
4933 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004934 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004935 * renegotiating, or if the user mistakenly loaded a session first.)
4936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4938 ssl->session != NULL) {
4939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004940 }
4941
4942 /*
4943 * We can't check that the config matches the initial one, but we can at
4944 * least check it matches the requirements for serializing.
4945 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004946 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004947#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004948 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004949#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004950 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4951 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4952 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4953 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004955 }
4956
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004958
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004959 /*
4960 * Check version identifier
4961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004964 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004965
4966 if (memcmp(p, ssl_serialized_context_header,
4967 sizeof(ssl_serialized_context_header)) != 0) {
4968 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4969 }
4970 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004971
4972 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004973 * Session
4974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if ((size_t) (end - p) < 4) {
4976 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4977 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004978
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004979 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004980 p += 4;
4981
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004982 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004983 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004984 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004985 ssl->session_in = ssl->session;
4986 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004987 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if ((size_t) (end - p) < session_len) {
4990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4991 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 ret = ssl_session_load(ssl->session, 1, p, session_len);
4994 if (ret != 0) {
4995 mbedtls_ssl_session_free(ssl->session);
4996 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004997 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004998
4999 p += session_len;
5000
5001 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005002 * Transform
5003 */
5004
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005005 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005006 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005007#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005008 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005009 ssl->transform_in = ssl->transform;
5010 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005011 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005012#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005013
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005014#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5016 if (prf_func == NULL) {
5017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5018 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005019
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005020 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5022 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5023 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 ret = ssl_tls12_populate_transform(ssl->transform,
5026 ssl->session->ciphersuite,
5027 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005028#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005030#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 prf_func,
5032 p, /* currently pointing to randbytes */
5033 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5034 ssl->conf->endpoint,
5035 ssl);
5036 if (ret != 0) {
5037 return ret;
5038 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005039#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005041
5042#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5043 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if ((size_t) (end - p) < 1) {
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5046 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005047
5048 ssl->transform->in_cid_len = *p++;
5049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5052 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005055 p += ssl->transform->in_cid_len;
5056
5057 ssl->transform->out_cid_len = *p++;
5058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5061 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005062
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005064 p += ssl->transform->out_cid_len;
5065#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5066
5067 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005068 * Saved fields from top-level ssl_context structure
5069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if ((size_t) (end - p) < 4) {
5071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5072 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005074 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005075 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005076
5077#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if ((size_t) (end - p) < 16) {
5079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5080 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005081
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005082 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005083 p += 8;
5084
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005085 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005086 p += 8;
5087#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5088
5089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if ((size_t) (end - p) < 1) {
5091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5092 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005093
5094 ssl->disable_datagram_packing = *p++;
5095#endif /* MBEDTLS_SSL_PROTO_DTLS */
5096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5099 }
5100 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5101 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005102
5103#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if ((size_t) (end - p) < 2) {
5105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5106 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005108 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005109 p += 2;
5110#endif /* MBEDTLS_SSL_PROTO_DTLS */
5111
5112#if defined(MBEDTLS_SSL_ALPN)
5113 {
5114 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005115 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if ((size_t) (end - p) < 1) {
5118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5119 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005120
5121 alpn_len = *p++;
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005124 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5126 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005127 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005128 ssl->alpn_chosen = *cur;
5129 break;
5130 }
5131 }
5132 }
5133
5134 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5137 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005138
5139 p += alpn_len;
5140 }
5141#endif /* MBEDTLS_SSL_ALPN */
5142
5143 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005144 * Forced fields from top-level ssl_context structure
5145 *
5146 * Most of them already set to the correct value by mbedtls_ssl_init() and
5147 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5148 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005149 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005150 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005151
Hanno Becker361b10d2019-08-30 10:42:49 +01005152 /* Adjust pointers for header fields of outgoing records to
5153 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005155
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005156#if defined(MBEDTLS_SSL_PROTO_DTLS)
5157 ssl->in_epoch = 1;
5158#endif
5159
5160 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5161 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005162 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5163 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (ssl->handshake != NULL) {
5165 mbedtls_ssl_handshake_free(ssl);
5166 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005167 ssl->handshake = NULL;
5168 }
5169
5170 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005171 * Done - should have consumed entire buffer
5172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (p != end) {
5174 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5175 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005176
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005178}
5179
5180/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005181 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005183int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5184 const unsigned char *buf,
5185 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005186{
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 if (ret != 0) {
5190 mbedtls_ssl_free(context);
5191 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005194}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005195#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005196
5197/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005198 * Free an SSL context
5199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005200void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005201{
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005203 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005209#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5210 size_t out_buf_len = ssl->out_buf_len;
5211#else
5212 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5213#endif
5214
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005215 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005216 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005217 }
5218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005220#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5221 size_t in_buf_len = ssl->in_buf_len;
5222#else
5223 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5224#endif
5225
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005226 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005227 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005228 }
5229
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (ssl->transform) {
5231 mbedtls_ssl_transform_free(ssl->transform);
5232 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005233 }
5234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 if (ssl->handshake) {
5236 mbedtls_ssl_handshake_free(ssl);
5237 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005238
5239#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5241 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005242#endif
5243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 mbedtls_ssl_session_free(ssl->session_negotiate);
5245 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005246 }
5247
Ronald Cron6f135e12021-12-08 16:57:54 +01005248#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 mbedtls_ssl_transform_free(ssl->transform_application);
5250 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005251#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 if (ssl->session) {
5254 mbedtls_ssl_session_free(ssl->session);
5255 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005256 }
5257
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005258#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005259 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005260#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005261
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005262#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005264#endif
5265
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005267
Paul Bakker86f04f42013-02-14 11:20:09 +01005268 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005270}
5271
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005272/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005273 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005275void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005276{
Gilles Peskine449bd832023-01-11 14:50:10 +01005277 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005278}
5279
Gilles Peskineae270bf2021-06-02 00:05:29 +02005280/* The selection should be the same as mbedtls_x509_crt_profile_default in
5281 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005282 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005283 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005284 * about this list.
5285 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005286static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005287#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005288 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005289#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005290#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005291 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005292#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005293#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005294 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005295#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005296#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005297 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005298#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005299#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005300 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005301#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005302#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005303 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005304#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005305#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005306 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005307#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005308#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005309 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005310#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005311#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005312 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5313 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5314 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5315 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5316 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5317#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005318 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005319};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005320
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005321static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005322 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5323 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5324 0
5325};
5326
Ronald Crone68ab4f2022-10-05 12:46:29 +02005327#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005328
Jerry Yu909df7b2022-01-22 11:56:27 +08005329/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005330 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005331 * rules SHOULD be upheld.
5332 * - No duplicate entries.
5333 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005334 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005335 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005336 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005337static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005338
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005339#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005340 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005341 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005342 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005343 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5344#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005345
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005346#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005347 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005348 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005349 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005350 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5351#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005352
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005353#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005354 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005355 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005356 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005357 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5358#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005359
Gabor Mezeic15ef932024-06-13 12:53:54 +02005360#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005361 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005362#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005363
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005364#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005365 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005366#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005367
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005368#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005369 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005370#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005371
Gabor Mezeic15ef932024-06-13 12:53:54 +02005372#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005373 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005374#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005375
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005376#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005377 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005378#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005379
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005380#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005381 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005382#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005383
Gabor Mezei15b95a62022-05-09 16:37:58 +02005384 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005385};
5386
5387/* NOTICE: see above */
5388#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5389static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005390
Gabor Mezeic15ef932024-06-13 12:53:54 +02005391#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005392#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005394#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005395#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5396 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005397#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005398#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005400#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005401#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005402
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005403#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005404#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005406#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005407#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5408 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005409#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005410#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005412#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005413#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005414
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005415#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005416#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005418#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005419#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5420 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005421#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005422#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005424#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005425#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005426
Gabor Mezei15b95a62022-05-09 16:37:58 +02005427 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005428};
5429#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005430
Jerry Yu909df7b2022-01-22 11:56:27 +08005431/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005432static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005433
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005434#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005435 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005436 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005437 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005438 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5439#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005440
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005441#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005442 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005443 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005444 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005445 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5446#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005447
Gabor Mezei15b95a62022-05-09 16:37:58 +02005448 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005449};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005450
Jerry Yu909df7b2022-01-22 11:56:27 +08005451/* NOTICE: see above */
5452#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5453static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005454
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005455#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005456#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005458#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005459#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005460
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005461#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005462#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005464#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005465#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005466
Gabor Mezei15b95a62022-05-09 16:37:58 +02005467 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005468};
Jerry Yu909df7b2022-01-22 11:56:27 +08005469#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5470
Ronald Crone68ab4f2022-10-05 12:46:29 +02005471#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005472
Chien Wong4e9683e2023-12-28 17:07:43 +08005473static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005474#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005475 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005476#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005477#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005478 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005479#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005480 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005481};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005482
Ronald Crone68ab4f2022-10-05 12:46:29 +02005483#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005484/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005485 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005486MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005487static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005488{
5489 size_t i, j;
5490 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005491
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5493 for (j = 0; j < i; j++) {
5494 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005495 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 }
5497 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5498 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5499 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005500 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005501 }
5502 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005504}
5505
Ronald Crone68ab4f2022-10-05 12:46:29 +02005506#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005507
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005508/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005509 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005511int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5512 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005513{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005514#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5516 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5517 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005518 }
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5521 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5522 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005523 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005524
5525#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5527 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5528 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005529 }
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5532 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5533 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005534 }
5535#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005536#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005537
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005538 /* Use the functions here so that they are covered in tests,
5539 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 mbedtls_ssl_conf_endpoint(conf, endpoint);
5541 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005542
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005543 /*
5544 * Things that are common to all presets
5545 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005546#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005548 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5549#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5550 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5551#endif
5552 }
5553#endif
5554
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005555#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5556 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5557#endif
5558
5559#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5560 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5561#endif
5562
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005563#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005564 conf->f_cookie_write = ssl_cookie_write_dummy;
5565 conf->f_cookie_check = ssl_cookie_check_dummy;
5566#endif
5567
5568#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5569 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5570#endif
5571
Janos Follath088ce432017-04-10 12:42:31 +01005572#if defined(MBEDTLS_SSL_SRV_C)
5573 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005574 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005575#endif
5576
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005577#if defined(MBEDTLS_SSL_PROTO_DTLS)
5578 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5579 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5580#endif
5581
5582#if defined(MBEDTLS_SSL_RENEGOTIATION)
5583 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 memset(conf->renego_period, 0x00, 2);
5585 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005586#endif
5587
Ronald Cron6f135e12021-12-08 16:57:54 +01005588#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005589
5590#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005591 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005592#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005593 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005594#endif
5595#endif /* MBEDTLS_SSL_EARLY_DATA */
5596
Jerry Yud0766ec2022-09-22 10:46:57 +08005597#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005598 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005600#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005601 /*
5602 * Allow all TLS 1.3 key exchange modes by default.
5603 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005604 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005605#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005608#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005609 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005610 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005611#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005613#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005615#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005616 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5617 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005618#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5619 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5620 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5621#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5622 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5623 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5624#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005626#endif
5627 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005628
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005629 /*
5630 * Preset-specific defaults
5631 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005633 /*
5634 * NSA Suite B
5635 */
5636 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005637
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005638 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005639
5640#if defined(MBEDTLS_X509_CRT_PARSE_C)
5641 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005642#endif
5643
Ronald Crone68ab4f2022-10-05 12:46:29 +02005644#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005645#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005647 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005649#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005651#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005652
Brett Warrene0edc842021-08-17 09:53:13 +01005653 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005654 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005655
5656 /*
5657 * Default
5658 */
5659 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005660
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005661 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005662
5663#if defined(MBEDTLS_X509_CRT_PARSE_C)
5664 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5665#endif
5666
Ronald Crone68ab4f2022-10-05 12:46:29 +02005667#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005668#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005670 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005672#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005674#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005675
Brett Warrene0edc842021-08-17 09:53:13 +01005676 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005677 }
5678
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005680}
5681
5682/*
5683 * Free mbedtls_ssl_config
5684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005685void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005686{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005687 if (conf == NULL) {
5688 return;
5689 }
5690
Ronald Cron73fe8df2022-10-05 14:31:43 +02005691#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005693 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5694 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005696 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005697 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005698 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005699 }
5700
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005702 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005703 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005704 conf->psk_identity_len = 0;
5705 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005706#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005707
5708#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005710#endif
5711
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005713}
5714
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005715#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005716 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005717/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005718 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005720unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005721{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005722#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5724 return MBEDTLS_SSL_SIG_RSA;
5725 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005726#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005727#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005728 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5729 return MBEDTLS_SSL_SIG_ECDSA;
5730 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005731#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005733}
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005736{
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005738 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005740 case MBEDTLS_PK_ECDSA:
5741 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005743 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005745 }
5746}
5747
Gilles Peskine449bd832023-01-11 14:50:10 +01005748mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005749{
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751#if defined(MBEDTLS_RSA_C)
5752 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005754#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005755#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005758#endif
5759 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005761 }
5762}
Valerio Settie9646ec2023-08-02 20:02:28 +02005763#endif /* MBEDTLS_PK_C &&
5764 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005765
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005766/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005767 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005768 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005769mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005770{
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005772#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005775#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005776#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005777 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005779#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005780#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005781 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005783#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005784#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005785 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005787#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005788#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005789 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005791#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005792#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005795#endif
5796 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005798 }
5799}
5800
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005801/*
5802 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005804unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005805{
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005807#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005808 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005810#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005811#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005812 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005814#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005815#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005816 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005818#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005819#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005820 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005822#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005823#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005824 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005826#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005827#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005828 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005830#endif
5831 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005833 }
5834}
5835
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005836/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005837 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005838 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005839 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005840int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005841{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005842 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005843
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 if (group_list == NULL) {
5845 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005846 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 for (; *group_list != 0; group_list++) {
5849 if (*group_list == tls_id) {
5850 return 0;
5851 }
5852 }
5853
5854 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005855}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005856
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005857#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005858/*
5859 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5860 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005861int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005862{
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005866 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005870}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005871#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005872
Valerio Setti18c9fed2022-12-30 17:44:24 +01005873static const struct {
5874 uint16_t tls_id;
5875 mbedtls_ecp_group_id ecp_group_id;
5876 psa_ecc_family_t psa_family;
5877 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005878} tls_id_match_table[] =
5879{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005880#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005881 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005882#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005883#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005884 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005885#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005886#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005887 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005888#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005889#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005890 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005891#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005892#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005893 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005894#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005895#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005896 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005897#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005898#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005899 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005900#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005901#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005902 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005903#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005904#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005905 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005906#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005907#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005908 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005909#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005910#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005911 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005912#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005913#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005914 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005915#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005916 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005917};
5918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005920 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005922{
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5924 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005925 if (type != NULL) {
5926 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 }
5928 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005929 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005931 return PSA_SUCCESS;
5932 }
5933 }
5934
5935 return PSA_ERROR_NOT_SUPPORTED;
5936}
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005939{
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5941 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005942 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005943 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005944 }
5945
5946 return MBEDTLS_ECP_DP_NONE;
5947}
5948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005950{
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5952 i++) {
5953 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005954 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005956 }
5957
5958 return 0;
5959}
5960
Valerio Setti67419f02023-01-04 16:12:42 +01005961#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005962static const struct {
5963 uint16_t tls_id;
5964 const char *name;
5965} tls_id_curve_name_table[] =
5966{
Valerio Setti54e23792023-07-07 10:49:27 +02005967 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5968 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5969 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5970 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5971 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5972 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5973 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5974 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5975 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5976 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5977 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5978 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5979 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005980 { 0, NULL },
5981};
5982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005984{
Valerio Settiacd32c02023-06-29 18:06:29 +02005985 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5986 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5987 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005989 }
5990
5991 return NULL;
5992}
Valerio Setti67419f02023-01-04 16:12:42 +01005993#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005994
Gilles Peskine449bd832023-01-11 14:50:10 +01005995int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5996 const mbedtls_md_type_t md,
5997 unsigned char *dst,
5998 size_t dst_len,
5999 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006000{
Ronald Cronf6893e12022-01-07 22:09:01 +01006001 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6002 psa_hash_operation_t *hash_operation_to_clone;
6003 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6004
Jerry Yu148165c2021-09-24 23:20:59 +08006005 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006008#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 case MBEDTLS_MD_SHA384:
6010 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6011 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006012#endif
6013
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006014#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 case MBEDTLS_MD_SHA256:
6016 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6017 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006018#endif
6019
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 default:
6021 goto exit;
6022 }
6023
6024 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6025 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006026 goto exit;
6027 }
6028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6030 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006031 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006033
6034exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006035#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006036 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006037 (void) ssl;
6038#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006039 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006040}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006041
Ronald Crone68ab4f2022-10-05 12:46:29 +02006042#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006043/* mbedtls_ssl_parse_sig_alg_ext()
6044 *
6045 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6046 * value (TLS 1.3 RFC8446):
6047 * enum {
6048 * ....
6049 * ecdsa_secp256r1_sha256( 0x0403 ),
6050 * ecdsa_secp384r1_sha384( 0x0503 ),
6051 * ecdsa_secp521r1_sha512( 0x0603 ),
6052 * ....
6053 * } SignatureScheme;
6054 *
6055 * struct {
6056 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6057 * } SignatureSchemeList;
6058 *
6059 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6060 * value (TLS 1.2 RFC5246):
6061 * enum {
6062 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6063 * sha512(6), (255)
6064 * } HashAlgorithm;
6065 *
6066 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6067 * SignatureAlgorithm;
6068 *
6069 * struct {
6070 * HashAlgorithm hash;
6071 * SignatureAlgorithm signature;
6072 * } SignatureAndHashAlgorithm;
6073 *
6074 * SignatureAndHashAlgorithm
6075 * supported_signature_algorithms<2..2^16-2>;
6076 *
6077 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6078 * generalization of the TLS 1.2 signature algorithm extension.
6079 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6080 * `SignatureScheme` field of TLS 1.3
6081 *
6082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6084 const unsigned char *buf,
6085 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006086{
6087 const unsigned char *p = buf;
6088 size_t supported_sig_algs_len = 0;
6089 const unsigned char *supported_sig_algs_end;
6090 uint16_t sig_alg;
6091 uint32_t common_idx = 0;
6092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6094 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006095 p += 2;
6096
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 memset(ssl->handshake->received_sig_algs, 0,
6098 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006101 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 while (p < supported_sig_algs_end) {
6103 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6104 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006105 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6107 sig_alg,
6108 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006109#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6111 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6112 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006113 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006114 }
6115#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6118 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006121 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6122 common_idx += 1;
6123 }
6124 }
6125 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (p != end) {
6127 MBEDTLS_SSL_DEBUG_MSG(1,
6128 ("Signature algorithms extension length misaligned"));
6129 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6130 MBEDTLS_ERR_SSL_DECODE_ERROR);
6131 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006132 }
6133
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 if (common_idx == 0) {
6135 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6136 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6137 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6138 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006139 }
6140
Gabor Mezei15b95a62022-05-09 16:37:58 +02006141 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006143}
6144
Ronald Crone68ab4f2022-10-05 12:46:29 +02006145#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006146
Jerry Yudc7bd172022-02-17 13:44:15 +08006147#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6148
Jerry Yudc7bd172022-02-17 13:44:15 +08006149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6151 mbedtls_svc_key_id_t key,
6152 psa_algorithm_t alg,
6153 const unsigned char *raw_psk, size_t raw_psk_length,
6154 const unsigned char *seed, size_t seed_length,
6155 const unsigned char *label, size_t label_length,
6156 const unsigned char *other_secret,
6157 size_t other_secret_length,
6158 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006159{
6160 psa_status_t status;
6161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 status = psa_key_derivation_setup(derivation, alg);
6163 if (status != PSA_SUCCESS) {
6164 return status;
6165 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006166
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6168 status = psa_key_derivation_input_bytes(derivation,
6169 PSA_KEY_DERIVATION_INPUT_SEED,
6170 seed, seed_length);
6171 if (status != PSA_SUCCESS) {
6172 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006173 }
6174
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 if (other_secret != NULL) {
6176 status = psa_key_derivation_input_bytes(derivation,
6177 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6178 other_secret, other_secret_length);
6179 if (status != PSA_SUCCESS) {
6180 return status;
6181 }
6182 }
6183
6184 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006185 status = psa_key_derivation_input_bytes(
6186 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 raw_psk, raw_psk_length);
6188 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 if (status != PSA_SUCCESS) {
6193 return status;
6194 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006195
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 status = psa_key_derivation_input_bytes(derivation,
6197 PSA_KEY_DERIVATION_INPUT_LABEL,
6198 label, label_length);
6199 if (status != PSA_SUCCESS) {
6200 return status;
6201 }
6202 } else {
6203 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006204 }
6205
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 status = psa_key_derivation_set_capacity(derivation, capacity);
6207 if (status != PSA_SUCCESS) {
6208 return status;
6209 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006212}
6213
Andrzej Kurek57d10632022-10-24 10:32:01 -04006214#if defined(PSA_WANT_ALG_SHA_384) || \
6215 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006217static int tls_prf_generic(mbedtls_md_type_t md_type,
6218 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006219 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 const unsigned char *random, size_t rlen,
6221 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006222{
6223 psa_status_t status;
6224 psa_algorithm_t alg;
6225 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6226 psa_key_derivation_operation_t derivation =
6227 PSA_KEY_DERIVATION_OPERATION_INIT;
6228
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006230 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006232 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
6235 /* Normally a "secret" should be long enough to be impossible to
6236 * find by brute force, and in particular should not be empty. But
6237 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6238 * and for this use case it makes sense to have a 0-length "secret".
6239 * Since the key API doesn't allow importing a key of length 0,
6240 * keep master_key=0, which setup_psa_key_derivation() understands
6241 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006243 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6245 psa_set_key_algorithm(&key_attributes, alg);
6246 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6249 if (status != PSA_SUCCESS) {
6250 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6251 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006252 }
6253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 status = setup_psa_key_derivation(&derivation,
6255 master_key, alg,
6256 NULL, 0,
6257 random, rlen,
6258 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006259 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 NULL, 0,
6261 dlen);
6262 if (status != PSA_SUCCESS) {
6263 psa_key_derivation_abort(&derivation);
6264 psa_destroy_key(master_key);
6265 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006266 }
6267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6269 if (status != PSA_SUCCESS) {
6270 psa_key_derivation_abort(&derivation);
6271 psa_destroy_key(master_key);
6272 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006273 }
6274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 status = psa_key_derivation_abort(&derivation);
6276 if (status != PSA_SUCCESS) {
6277 psa_destroy_key(master_key);
6278 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006279 }
6280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (!mbedtls_svc_key_id_is_null(master_key)) {
6282 status = psa_destroy_key(master_key);
6283 }
6284 if (status != PSA_SUCCESS) {
6285 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6286 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006289}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006290#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006291
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006292#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006293MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006294static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6295 const char *label,
6296 const unsigned char *random, size_t rlen,
6297 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006298{
Gilles Peskine449bd832023-01-11 14:50:10 +01006299 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006300 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006301}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006302#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006303
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006304#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006305MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006306static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6307 const char *label,
6308 const unsigned char *random, size_t rlen,
6309 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006310{
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006312 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006313}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006314#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006315
Jerry Yuf009d862022-02-17 14:01:37 +08006316/*
6317 * Set appropriate PRF function and other SSL / TLS1.2 functions
6318 *
6319 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006320 * - hash associated with the ciphersuite (only used by TLS 1.2)
6321 *
6322 * Outputs:
6323 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6324 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006326static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6327 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006328{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006329#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006331 handshake->tls_prf = tls_prf_sha384;
6332 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6333 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006335#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006336#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006337 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006338 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006339 handshake->tls_prf = tls_prf_sha256;
6340 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6341 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6342 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006343#else
Jerry Yuf009d862022-02-17 14:01:37 +08006344 {
Jerry Yuf009d862022-02-17 14:01:37 +08006345 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006346 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006348 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006349#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006350
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006352}
Jerry Yud6ab2352022-02-17 14:03:43 +08006353
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006354/*
6355 * Compute master secret if needed
6356 *
6357 * Parameters:
6358 * [in/out] handshake
6359 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6360 * (PSA-PSK) ciphersuite_info, psk_opaque
6361 * [out] premaster (cleared)
6362 * [out] master
6363 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6364 * debug: conf->f_dbg, conf->p_dbg
6365 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006366 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006367 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006369static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6370 unsigned char *master,
6371 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006372{
6373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6374
6375 /* cf. RFC 5246, Section 8.1:
6376 * "The master secret is always exactly 48 bytes in length." */
6377 size_t const master_secret_len = 48;
6378
6379#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6380 unsigned char session_hash[48];
6381#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6382
6383 /* The label for the KDF used for key expansion.
6384 * This is either "master secret" or "extended master secret"
6385 * depending on whether the Extended Master Secret extension
6386 * is used. */
6387 char const *lbl = "master secret";
6388
Przemek Stekielae4ed302022-04-05 17:15:55 +02006389 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006390 * - If the Extended Master Secret extension is not used,
6391 * this is ClientHello.Random + ServerHello.Random
6392 * (see Sect. 8.1 in RFC 5246).
6393 * - If the Extended Master Secret extension is used,
6394 * this is the transcript of the handshake so far.
6395 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006396 unsigned char const *seed = handshake->randbytes;
6397 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398
6399#if !defined(MBEDTLS_DEBUG_C) && \
6400 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006401 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006402 ssl = NULL; /* make sure we don't use it except for those cases */
6403 (void) ssl;
6404#endif
6405
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 if (handshake->resume != 0) {
6407 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6408 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 }
6410
6411#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006414 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006415 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6416 if (ret != 0) {
6417 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6418 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6421 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006423#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006425#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427 /* Perform PSK-to-MS expansion in a single step. */
6428 psa_status_t status;
6429 psa_algorithm_t alg;
6430 mbedtls_svc_key_id_t psk;
6431 psa_key_derivation_operation_t derivation =
6432 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006433 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006440 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006442 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006444
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006445 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006449 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006450 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006451 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006452 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006453 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6454 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6455 other_secret = handshake->premaster + 2;
6456 break;
6457 default:
6458 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006459 }
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 status = setup_psa_key_derivation(&derivation, psk, alg,
6462 ssl->conf->psk, ssl->conf->psk_len,
6463 seed, seed_len,
6464 (unsigned char const *) lbl,
6465 (size_t) strlen(lbl),
6466 other_secret, other_secret_len,
6467 master_secret_len);
6468 if (status != PSA_SUCCESS) {
6469 psa_key_derivation_abort(&derivation);
6470 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006471 }
6472
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 status = psa_key_derivation_output_bytes(&derivation,
6474 master,
6475 master_secret_len);
6476 if (status != PSA_SUCCESS) {
6477 psa_key_derivation_abort(&derivation);
6478 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006479 }
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 status = psa_key_derivation_abort(&derivation);
6482 if (status != PSA_SUCCESS) {
6483 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6484 }
6485 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006486#endif
6487 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006488#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006490 psa_status_t status;
6491 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6492 psa_key_derivation_operation_t derivation =
6493 PSA_KEY_DERIVATION_OPERATION_INIT;
6494
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006496
6497 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6498
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 status = psa_key_derivation_setup(&derivation, alg);
6500 if (status != PSA_SUCCESS) {
6501 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006502 }
6503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 status = psa_key_derivation_set_capacity(&derivation,
6505 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6506 if (status != PSA_SUCCESS) {
6507 psa_key_derivation_abort(&derivation);
6508 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006509 }
6510
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6512 &derivation);
6513 if (status != PSA_SUCCESS) {
6514 psa_key_derivation_abort(&derivation);
6515 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006516 }
6517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 status = psa_key_derivation_output_bytes(&derivation,
6519 handshake->premaster,
6520 handshake->pmslen);
6521 if (status != PSA_SUCCESS) {
6522 psa_key_derivation_abort(&derivation);
6523 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6524 }
6525
6526 status = psa_key_derivation_abort(&derivation);
6527 if (status != PSA_SUCCESS) {
6528 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006529 }
6530 }
6531#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6533 lbl, seed, seed_len,
6534 master,
6535 master_secret_len);
6536 if (ret != 0) {
6537 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6538 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539 }
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6542 handshake->premaster,
6543 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 mbedtls_platform_zeroize(handshake->premaster,
6546 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006547 }
6548
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006550}
6551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006553{
6554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6555 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6556 ssl->handshake->ciphersuite_info;
6557
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006559
6560 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006562 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (ret != 0) {
6564 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6565 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006566 }
6567
6568 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 ret = ssl_compute_master(ssl->handshake,
6570 ssl->session_negotiate->master,
6571 ssl);
6572 if (ret != 0) {
6573 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6574 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006575 }
6576
6577 /* Swap the client and server random values:
6578 * - MS derivation wanted client+server (RFC 5246 8.1)
6579 * - key derivation wants server+client (RFC 5246 6.3) */
6580 {
6581 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 memcpy(tmp, ssl->handshake->randbytes, 64);
6583 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6584 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6585 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006586 }
6587
6588 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6590 ssl->session_negotiate->ciphersuite,
6591 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006592#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006594#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 ssl->handshake->tls_prf,
6596 ssl->handshake->randbytes,
6597 ssl->tls_version,
6598 ssl->conf->endpoint,
6599 ssl);
6600 if (ret != 0) {
6601 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6602 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006603 }
6604
6605 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6607 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006612}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006615{
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006617#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618 case MBEDTLS_SSL_HASH_SHA384:
6619 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6620 break;
6621#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006622#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006623 case MBEDTLS_SSL_HASH_SHA256:
6624 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6625 break;
6626#endif
6627 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006629 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006630#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006631 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006632 (void) ssl;
6633#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006635}
6636
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006637static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6638 const psa_hash_operation_t *hs_op,
6639 size_t buffer_size,
6640 unsigned char *hash,
6641 size_t *hlen)
6642{
6643 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006644 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006645
6646#if !defined(MBEDTLS_DEBUG_C)
6647 (void) ssl;
6648#endif
6649 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006650 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006651 if (status != PSA_SUCCESS) {
6652 goto exit;
6653 }
6654
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006655 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006656 if (status != PSA_SUCCESS) {
6657 goto exit;
6658 }
6659
6660 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6661 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6662
6663exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006664 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006665 return mbedtls_md_error_from_psa(status);
6666}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006667
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006668#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006669int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6670 unsigned char *hash,
6671 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006672{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006673 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6674 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006675}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006676#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006677
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006678#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006679int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6680 unsigned char *hash,
6681 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006682{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006683 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6684 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006685}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006686#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006687
Jerry Yuc2c673d2022-02-17 14:20:39 +08006688#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006689MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006690static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006691
6692#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006693int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006694{
6695 /* If renegotiation is not enforced, retransmit until we would reach max
6696 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006698 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6699 unsigned char doublings = 1;
6700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006702 ++doublings;
6703 ratio >>= 1;
6704 }
6705
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 if (++ssl->renego_records_seen > doublings) {
6707 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6708 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006709 }
6710 }
6711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006713}
6714#endif
6715#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006716
Jerry Yud9526692022-02-17 14:23:47 +08006717/*
6718 * Handshake functions
6719 */
6720#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6721/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006722int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006723{
6724 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6725 ssl->handshake->ciphersuite_info;
6726
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6730 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006731 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006733 }
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6736 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006737}
6738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006740{
6741 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6742 ssl->handshake->ciphersuite_info;
6743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6747 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006748 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006750 }
6751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6753 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006754}
6755
6756#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6757/* Some certificate support -> implement write and parse */
6758
Gilles Peskine449bd832023-01-11 14:50:10 +01006759int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006760{
6761 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6762 size_t i, n;
6763 const mbedtls_x509_crt *crt;
6764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6765 ssl->handshake->ciphersuite_info;
6766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006768
Gilles Peskine449bd832023-01-11 14:50:10 +01006769 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6770 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006771 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006773 }
6774
6775#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6777 if (ssl->handshake->client_auth == 0) {
6778 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006779 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006781 }
6782 }
6783#endif /* MBEDTLS_SSL_CLI_C */
6784#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6786 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006787 /* Should never happen because we shouldn't have picked the
6788 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006790 }
6791 }
6792#endif
6793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006795
6796 /*
6797 * 0 . 0 handshake type
6798 * 1 . 3 handshake length
6799 * 4 . 6 length of all certs
6800 * 7 . 9 length of cert. 1
6801 * 10 . n-1 peer certificate
6802 * n . n+2 length of cert. 2
6803 * n+3 . ... upper level cert, etc.
6804 */
6805 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006809 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6811 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6812 " > %" MBEDTLS_PRINTF_SIZET,
6813 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6814 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006815 }
6816
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6818 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6819 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006822 i += n; crt = crt->next;
6823 }
6824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6826 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6827 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006828
6829 ssl->out_msglen = i;
6830 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6831 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6832
Gilles Peskinef670ba52025-03-07 15:09:32 +01006833 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6836 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6837 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006838 }
6839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006843}
6844
6845#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6846
6847#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006848MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006849static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6850 unsigned char *crt_buf,
6851 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006852{
6853 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 if (peer_crt == NULL) {
6856 return -1;
6857 }
Jerry Yud9526692022-02-17 14:23:47 +08006858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 if (peer_crt->raw.len != crt_buf_len) {
6860 return -1;
6861 }
Jerry Yud9526692022-02-17 14:23:47 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006864}
6865#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006866MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006867static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6868 unsigned char *crt_buf,
6869 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006870{
6871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6872 unsigned char const * const peer_cert_digest =
6873 ssl->session->peer_cert_digest;
6874 mbedtls_md_type_t const peer_cert_digest_type =
6875 ssl->session->peer_cert_digest_type;
6876 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006878 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6879 size_t digest_len;
6880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (peer_cert_digest == NULL || digest_info == NULL) {
6882 return -1;
6883 }
Jerry Yud9526692022-02-17 14:23:47 +08006884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 digest_len = mbedtls_md_get_size(digest_info);
6886 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6887 return -1;
6888 }
Jerry Yud9526692022-02-17 14:23:47 +08006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6891 if (ret != 0) {
6892 return -1;
6893 }
Jerry Yud9526692022-02-17 14:23:47 +08006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006896}
6897#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6898#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6899
6900/*
6901 * Once the certificate message is read, parse it into a cert chain and
6902 * perform basic checks, but leave actual verification to the caller
6903 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006904MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006905static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6906 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006907{
6908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6909#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006911#endif
6912 size_t i, n;
6913 uint8_t alert;
6914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6916 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6917 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6918 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6919 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006920 }
6921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6923 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6924 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6925 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006926 }
6927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6929 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6930 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6931 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6932 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006933 }
6934
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006936
6937 /*
6938 * Same message structure as in mbedtls_ssl_write_certificate()
6939 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006940 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006941
Gilles Peskine449bd832023-01-11 14:50:10 +01006942 if (ssl->in_msg[i] != 0 ||
6943 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6944 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6945 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6946 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6947 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006948 }
6949
6950 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6951 i += 3;
6952
6953 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006955 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (i + 3 > ssl->in_hslen) {
6957 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6958 mbedtls_ssl_send_alert_message(ssl,
6959 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6960 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6961 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006962 }
6963 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6964 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (ssl->in_msg[i] != 0) {
6966 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6967 mbedtls_ssl_send_alert_message(ssl,
6968 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6969 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6970 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006971 }
6972
6973 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006974 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006975 i += 3;
6976
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (n < 128 || i + n > ssl->in_hslen) {
6978 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6979 mbedtls_ssl_send_alert_message(ssl,
6980 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6981 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6982 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006983 }
6984
6985 /* Check if we're handling the first CRT in the chain. */
6986#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006988 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006990 /* During client-side renegotiation, check that the server's
6991 * end-CRTs hasn't changed compared to the initial handshake,
6992 * mitigating the triple handshake attack. On success, reuse
6993 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6995 if (ssl_check_peer_crt_unchanged(ssl,
6996 &ssl->in_msg[i],
6997 n) != 0) {
6998 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6999 mbedtls_ssl_send_alert_message(ssl,
7000 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7001 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7002 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007003 }
7004
7005 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007007 }
7008#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7009
7010 /* Parse the next certificate in the chain. */
7011#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007013#else
7014 /* If we don't need to store the CRT chain permanently, parse
7015 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007017#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007019 case 0: /*ok*/
Gilles Peskinea7e14dc2024-09-16 13:10:11 +02007020 case MBEDTLS_ERR_OID_NOT_FOUND:
Jerry Yud9526692022-02-17 14:23:47 +08007021 /* Ignore certificate with an unknown algorithm: maybe a
7022 prior certificate was already trusted. */
7023 break;
7024
7025 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7026 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7027 goto crt_parse_der_failed;
7028
7029 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7030 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7031 goto crt_parse_der_failed;
7032
7033 default:
7034 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007035crt_parse_der_failed:
7036 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7037 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7038 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007039 }
7040
7041 i += n;
7042 }
7043
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7045 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007046}
7047
7048#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007049MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007050static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007051{
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7053 return -1;
7054 }
Jerry Yud9526692022-02-17 14:23:47 +08007055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007057 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7058 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7060 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7061 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007062 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007064}
7065#endif /* MBEDTLS_SSL_SRV_C */
7066
7067/* Check if a certificate message is expected.
7068 * Return either
7069 * - SSL_CERTIFICATE_EXPECTED, or
7070 * - SSL_CERTIFICATE_SKIP
7071 * indicating whether a Certificate message is expected or not.
7072 */
7073#define SSL_CERTIFICATE_EXPECTED 0
7074#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007075MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007076static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7077 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007078{
7079 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7080 ssl->handshake->ciphersuite_info;
7081
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7083 return SSL_CERTIFICATE_SKIP;
7084 }
Jerry Yud9526692022-02-17 14:23:47 +08007085
7086#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007089 ssl->session_negotiate->verify_result =
7090 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007092 }
7093 }
7094#else
7095 ((void) authmode);
7096#endif /* MBEDTLS_SSL_SRV_C */
7097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007099}
7100
Jerry Yud9526692022-02-17 14:23:47 +08007101#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007103static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7104 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007105{
7106 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7107 /* Remember digest of the peer's end-CRT. */
7108 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7110 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7111 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7112 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7113 mbedtls_ssl_send_alert_message(ssl,
7114 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7115 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007118 }
7119
Gilles Peskine449bd832023-01-11 14:50:10 +01007120 ret = mbedtls_md(mbedtls_md_info_from_type(
7121 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7122 start, len,
7123 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007124
7125 ssl->session_negotiate->peer_cert_digest_type =
7126 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7127 ssl->session_negotiate->peer_cert_digest_len =
7128 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007131}
7132
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007133MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007134static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7135 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007136{
7137 unsigned char *end = start + len;
7138 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7139
7140 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7142 ret = mbedtls_pk_parse_subpubkey(&start, end,
7143 &ssl->handshake->peer_pubkey);
7144 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007145 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007147 }
7148
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007150}
7151#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7152
Gilles Peskine449bd832023-01-11 14:50:10 +01007153int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007154{
7155 int ret = 0;
7156 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007157 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007158#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7159 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7160 ? ssl->handshake->sni_authmode
7161 : ssl->conf->authmode;
7162#else
7163 const int authmode = ssl->conf->authmode;
7164#endif
7165 void *rs_ctx = NULL;
7166 mbedtls_x509_crt *chain = NULL;
7167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007169
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7171 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7172 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007173 goto exit;
7174 }
7175
7176#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 if (ssl->handshake->ecrs_enabled &&
7178 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007179 chain = ssl->handshake->ecrs_peer_cert;
7180 ssl->handshake->ecrs_peer_cert = NULL;
7181 goto crt_verify;
7182 }
7183#endif
7184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007186 /* mbedtls_ssl_read_record may have sent an alert already. We
7187 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007189 goto exit;
7190 }
7191
7192#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007194 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7195
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007197 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 }
Jerry Yud9526692022-02-17 14:23:47 +08007199
7200 goto exit;
7201 }
7202#endif /* MBEDTLS_SSL_SRV_C */
7203
7204 /* Clear existing peer CRT structure in case we tried to
7205 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7209 if (chain == NULL) {
7210 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7211 sizeof(mbedtls_x509_crt)));
7212 mbedtls_ssl_send_alert_message(ssl,
7213 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7214 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007215
7216 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7217 goto exit;
7218 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007220
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 ret = ssl_parse_certificate_chain(ssl, chain);
7222 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 }
Jerry Yud9526692022-02-17 14:23:47 +08007225
7226#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007228 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 }
Jerry Yud9526692022-02-17 14:23:47 +08007230
7231crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007233 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007234 }
Jerry Yud9526692022-02-17 14:23:47 +08007235#endif
7236
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007237 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7238 ssl->handshake->ciphersuite_info,
7239 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 }
Jerry Yud9526692022-02-17 14:23:47 +08007243
7244#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7245 {
7246 unsigned char *crt_start, *pk_start;
7247 size_t crt_len, pk_len;
7248
7249 /* We parse the CRT chain without copying, so
7250 * these pointers point into the input buffer,
7251 * and are hence still valid after freeing the
7252 * CRT chain. */
7253
7254 crt_start = chain->raw.p;
7255 crt_len = chain->raw.len;
7256
7257 pk_start = chain->pk_raw.p;
7258 pk_len = chain->pk_raw.len;
7259
7260 /* Free the CRT structures before computing
7261 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 mbedtls_x509_crt_free(chain);
7263 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007264 chain = NULL;
7265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7267 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 }
Jerry Yud9526692022-02-17 14:23:47 +08007270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7272 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 }
Jerry Yud9526692022-02-17 14:23:47 +08007275 }
7276#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7277 /* Pass ownership to session structure. */
7278 ssl->session_negotiate->peer_cert = chain;
7279 chain = NULL;
7280#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7281
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007283
7284exit:
7285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007287 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 }
Jerry Yud9526692022-02-17 14:23:47 +08007289
7290#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007292 ssl->handshake->ecrs_peer_cert = chain;
7293 chain = NULL;
7294 }
7295#endif
7296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (chain != NULL) {
7298 mbedtls_x509_crt_free(chain);
7299 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007300 }
7301
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007303}
7304#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7305
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007306static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7307 unsigned char *padbuf, size_t hlen,
7308 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007309{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007310 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007311 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007312 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007313 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007314 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007315 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007316
7317 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007319 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007323 ? "client finished"
7324 : "server finished";
7325
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007326 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007327
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007328 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007330 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007331 }
7332
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007333 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007335 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007336 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007337 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007338
7339 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7340
Jerry Yu615bd6f2022-02-17 14:25:15 +08007341 /*
7342 * TLSv1.2:
7343 * hash = PRF( master, finished_label,
7344 * Hash( handshake ) )[0.11]
7345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007347 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007348
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007350
Paul Elliottecb95be2023-08-11 16:41:04 +01007351 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007352
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007353 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007354
7355exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007356 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007357 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007358}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007359
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007360#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007361static int ssl_calc_finished_tls_sha256(
7362 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7363{
7364 unsigned char padbuf[32];
7365 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007366 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007367 padbuf, sizeof(padbuf),
7368 buf, from);
7369}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007370#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007371
Jerry Yub7ba49e2022-02-17 14:25:53 +08007372
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007373#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007374static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007376{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007377 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007378 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007379 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007380 padbuf, sizeof(padbuf),
7381 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007382}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007383#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007386{
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007388
7389 /*
7390 * Free our handshake params
7391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 mbedtls_ssl_handshake_free(ssl);
7393 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007394 ssl->handshake = NULL;
7395
7396 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007397 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007398 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (ssl->transform) {
7400 mbedtls_ssl_transform_free(ssl->transform);
7401 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007402 }
7403 ssl->transform = ssl->transform_negotiate;
7404 ssl->transform_negotiate = NULL;
7405
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007407}
7408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007410{
7411 int resume = ssl->handshake->resume;
7412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007414
7415#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007417 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7418 ssl->renego_records_seen = 0;
7419 }
7420#endif
7421
7422 /*
7423 * Free the previous session and switch in the current one
7424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007426#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7427 /* RFC 7366 3.1: keep the EtM state */
7428 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007430#endif
7431
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 mbedtls_ssl_session_free(ssl->session);
7433 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007434 }
7435 ssl->session = ssl->session_negotiate;
7436 ssl->session_negotiate = NULL;
7437
7438 /*
7439 * Add cache entry
7440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007442 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 resume == 0) {
7444 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7445 ssl->session->id,
7446 ssl->session->id_len,
7447 ssl->session) != 0) {
7448 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7449 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007450 }
7451
7452#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7454 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007455 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007457
7458 /* Keep last flight around in case we need to resend it:
7459 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7461 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007462#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007464
Gilles Peskinef670ba52025-03-07 15:09:32 +01007465 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007468}
7469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007471{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007472 int ret;
7473 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007478
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007479 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7480 if (ret != 0) {
7481 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007482 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007483 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007484
7485 /*
7486 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7487 * may define some other value. Currently (early 2016), no defined
7488 * ciphersuite does this (and this is unlikely to change as activity has
7489 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7490 */
7491 hash_len = 12;
7492
7493#if defined(MBEDTLS_SSL_RENEGOTIATION)
7494 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007495 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007496#endif
7497
7498 ssl->out_msglen = 4 + hash_len;
7499 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7500 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7501
7502 /*
7503 * In case of session resuming, invert the client and server
7504 * ChangeCipherSpec messages order.
7505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007507#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007509 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007511#endif
7512#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007514 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007516#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007518 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007520
7521 /*
7522 * Switch to our negotiated transform and session parameters for outbound
7523 * data.
7524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007526
7527#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007529 unsigned char i;
7530
7531 /* Remember current epoch settings for resending */
7532 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7534 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007535
7536 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007538
7539
7540 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 for (i = 2; i > 0; i--) {
7542 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007543 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 }
7545 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007546
7547 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if (i == 0) {
7549 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7550 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007553#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007555
7556 ssl->transform_out = ssl->transform_negotiate;
7557 ssl->session_out = ssl->session_negotiate;
7558
7559#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7561 mbedtls_ssl_send_flight_completed(ssl);
7562 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007563#endif
7564
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7566 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7567 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007568 }
7569
7570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7572 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7573 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7574 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007575 }
7576#endif
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007581}
7582
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007583#define SSL_MAX_HASH_LEN 12
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007586{
7587 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7588 unsigned int hash_len = 12;
7589 unsigned char buf[SSL_MAX_HASH_LEN];
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007592
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007593 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7594 if (ret != 0) {
7595 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007596 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007597 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7600 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007601 goto exit;
7602 }
7603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7605 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7606 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7607 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007608 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7609 goto exit;
7610 }
7611
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7613 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7614 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007615 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7616 goto exit;
7617 }
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7620 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7621 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7622 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007623 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7624 goto exit;
7625 }
7626
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7628 buf, hash_len) != 0) {
7629 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7630 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7631 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007632 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7633 goto exit;
7634 }
7635
7636#if defined(MBEDTLS_SSL_RENEGOTIATION)
7637 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007639#endif
7640
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007642#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007644 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007646#endif
7647#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007649 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007651#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007653 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007655
7656#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7658 mbedtls_ssl_recv_flight_completed(ssl);
7659 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007660#endif
7661
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007663
7664exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 mbedtls_platform_zeroize(buf, hash_len);
7666 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007667}
7668
Jerry Yu392112c2022-02-17 14:34:10 +08007669#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7670/*
7671 * Helper to get TLS 1.2 PRF from ciphersuite
7672 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7673 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007674static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007675{
Jerry Yu392112c2022-02-17 14:34:10 +08007676 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007678#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7680 return tls_prf_sha384;
7681 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007682#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007683#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007684 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7686 return tls_prf_sha256;
7687 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007688 }
7689#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007690#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007691 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007692 (void) ciphersuite_info;
7693#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007696}
7697#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007698
Gilles Peskine449bd832023-01-11 14:50:10 +01007699static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007700{
7701 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007702#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (tls_prf == tls_prf_sha384) {
7704 return MBEDTLS_SSL_TLS_PRF_SHA384;
7705 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007706#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007707#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 if (tls_prf == tls_prf_sha256) {
7709 return MBEDTLS_SSL_TLS_PRF_SHA256;
7710 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007711#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007713}
7714
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007715/*
7716 * Populate a transform structure with session keys and all the other
7717 * necessary information.
7718 *
7719 * Parameters:
7720 * - [in/out]: transform: structure to populate
7721 * [in] must be just initialised with mbedtls_ssl_transform_init()
7722 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7723 * - [in] ciphersuite
7724 * - [in] master
7725 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007726 * - [in] tls_prf: pointer to PRF to use for key derivation
7727 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007728 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007729 * - [in] endpoint: client or server
7730 * - [in] ssl: used for:
7731 * - ssl->conf->{f,p}_export_keys
7732 * [in] optionally used for:
7733 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7734 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007735MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007736static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7737 int ciphersuite,
7738 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007739#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007741#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 ssl_tls_prf_t tls_prf,
7743 const unsigned char randbytes[64],
7744 mbedtls_ssl_protocol_version tls_version,
7745 unsigned endpoint,
7746 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007747{
7748 int ret = 0;
7749 unsigned char keyblk[256];
7750 unsigned char *key1;
7751 unsigned char *key2;
7752 unsigned char *mac_enc;
7753 unsigned char *mac_dec;
7754 size_t mac_key_len = 0;
7755 size_t iv_copy_len;
7756 size_t keylen;
7757 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007758 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007759
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007760 psa_key_type_t key_type;
7761 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7762 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007763 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007764 size_t key_bits;
7765 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007766
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007767 /*
7768 * Some data just needs copying into the structure
7769 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007770#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007771 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007772#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007773 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007774
Max Fillinger2fe35f62024-10-25 00:52:24 +02007775#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007777#endif
7778
7779#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007781 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7782 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007784 }
7785#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7786
7787 /*
7788 * Get various info structures
7789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7791 if (ciphersuite_info == NULL) {
7792 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7793 ciphersuite));
7794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007795 }
7796
Neil Armstrongab555e02022-04-04 11:07:59 +02007797 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007798#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007800#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007802
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007804 transform->taglen =
7805 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007807
Dave Rodgman2eab4622023-10-05 13:30:37 +01007808 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 transform->taglen,
7810 &alg,
7811 &key_type,
7812 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007813 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007815 goto end;
7816 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007817
Dave Rodgman2eab4622023-10-05 13:30:37 +01007818 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007820 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 (unsigned) ciphersuite_info->mac));
7822 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007823 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007824
7825#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7826 /* Copy own and peer's CID if the use of the CID
7827 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7829 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007830
7831 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7833 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7834 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007835
7836 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7838 ssl->handshake->peer_cid_len);
7839 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7840 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007841 }
7842#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7843
7844 /*
7845 * Compute key block using the PRF
7846 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7848 if (ret != 0) {
7849 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7850 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851 }
7852
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7854 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7855 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7856 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7857 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007858
7859 /*
7860 * Determine the appropriate key, IV and MAC length.
7861 */
7862
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007863 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007864
Valerio Settie5707042023-10-11 11:54:42 +02007865#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007867 size_t explicit_ivlen;
7868
7869 transform->maclen = 0;
7870 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007871
7872 /* All modes haves 96-bit IVs, but the length of the static parts vary
7873 * with mode and version:
7874 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7875 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7876 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7877 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7878 * sequence number).
7879 */
7880 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007881
7882 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007884
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007886 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007888 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007890
7891 /* Minimum length of encrypted record */
7892 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7893 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 } else
Valerio Settie5707042023-10-11 11:54:42 +02007895#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007896#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007898 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007901
Neil Armstronge4512952022-03-08 09:08:22 +01007902 /* Get MAC length */
7903 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007904 transform->maclen = mac_key_len;
7905
7906 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908
7909 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007911 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007913 /*
7914 * GenericBlockCipher:
7915 * 1. if EtM is in use: one block plus MAC
7916 * otherwise: * first multiple of blocklen greater than maclen
7917 * 2. IV
7918 */
7919#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007921 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 + block_size;
7923 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924#endif
7925 {
7926 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 + block_size
7928 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007929 }
7930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007932 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 } else {
7934 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007935 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7936 goto end;
7937 }
7938 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007940#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7941 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7943 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007944 }
7945
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7947 (unsigned) keylen,
7948 (unsigned) transform->minlen,
7949 (unsigned) transform->ivlen,
7950 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007951
7952 /*
7953 * Finally setup the cipher contexts, IVs and MAC secrets.
7954 */
7955#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007957 key1 = keyblk + mac_key_len * 2;
7958 key2 = keyblk + mac_key_len * 2 + keylen;
7959
7960 mac_enc = keyblk;
7961 mac_dec = keyblk + mac_key_len;
7962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 iv_copy_len = (transform->fixed_ivlen) ?
7964 transform->fixed_ivlen : transform->ivlen;
7965 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7966 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7967 iv_copy_len);
7968 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007969#endif /* MBEDTLS_SSL_CLI_C */
7970#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007972 key1 = keyblk + mac_key_len * 2 + keylen;
7973 key2 = keyblk + mac_key_len * 2;
7974
7975 mac_enc = keyblk + mac_key_len;
7976 mac_dec = keyblk;
7977
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 iv_copy_len = (transform->fixed_ivlen) ?
7979 transform->fixed_ivlen : transform->ivlen;
7980 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7981 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7982 iv_copy_len);
7983 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007984#endif /* MBEDTLS_SSL_SRV_C */
7985 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007987 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7988 goto end;
7989 }
7990
Paul Elliott4fb19552023-10-18 12:15:30 +01007991 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 ssl->f_export_keys(ssl->p_export_keys,
7993 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7994 master, 48,
7995 randbytes + 32,
7996 randbytes,
7997 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998 }
7999
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008000 transform->psa_alg = alg;
8001
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8003 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8004 psa_set_key_algorithm(&attributes, alg);
8005 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008006
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 if ((status = psa_import_key(&attributes,
8008 key1,
8009 PSA_BITS_TO_BYTES(key_bits),
8010 &transform->psa_key_enc)) != PSA_SUCCESS) {
8011 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008012 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008014 goto end;
8015 }
8016
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if ((status = psa_import_key(&attributes,
8020 key2,
8021 PSA_BITS_TO_BYTES(key_bits),
8022 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008023 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008025 goto end;
8026 }
8027 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008028
Neil Armstrong29c0c042022-03-17 17:47:28 +01008029#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8030 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8031 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8036 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8037 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008038
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 if ((status = psa_import_key(&attributes,
8040 mac_enc, mac_key_len,
8041 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008042 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008044 goto end;
8045 }
8046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8048 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008049#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008051#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008053 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8055 PSA_KEY_USAGE_VERIFY_HASH);
8056 } else {
8057 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8058 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008059
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 if ((status = psa_import_key(&attributes,
8061 mac_dec, mac_key_len,
8062 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008063 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008065 goto end;
8066 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008067 }
8068#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8069
8070 ((void) mac_dec);
8071 ((void) mac_enc);
8072
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008073end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8075 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008076}
8077
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008078#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008079int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 psa_pake_operation_t *pake_ctx,
8081 const unsigned char *buf,
8082 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008083{
8084 psa_status_t status;
8085 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008086 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008087 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8088 * At round two perform a single cycle
8089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 for (; remaining_steps > 0; remaining_steps--) {
8093 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008094 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008096 /* Length is stored at the first byte */
8097 size_t length = buf[input_offset];
8098 input_offset += 1;
8099
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008101 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8102 }
8103
Gilles Peskine449bd832023-01-11 14:50:10 +01008104 status = psa_pake_input(pake_ctx, step,
8105 buf + input_offset, length);
8106 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008107 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008108 }
8109
8110 input_offset += length;
8111 }
8112 }
8113
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008115 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008117
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008119}
8120
Valerio Setti6b3dab02022-11-17 17:14:54 +01008121int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 psa_pake_operation_t *pake_ctx,
8123 unsigned char *buf,
8124 size_t len, size_t *olen,
8125 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008126{
8127 psa_status_t status;
8128 size_t output_offset = 0;
8129 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008130 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008131 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8132 * At round two perform a single cycle
8133 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008135
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 for (; remaining_steps > 0; remaining_steps--) {
8137 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8138 step <= PSA_PAKE_STEP_ZK_PROOF;
8139 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008140 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008141 * For each step, prepend 1 byte with the length of the data as
8142 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 status = psa_pake_output(pake_ctx, step,
8145 buf + output_offset + 1,
8146 len - output_offset - 1,
8147 &output_len);
8148 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008149 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008150 }
8151
Valerio Setti99d88c12022-11-22 16:03:43 +01008152 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008153
8154 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008155 }
8156 }
8157
8158 *olen = output_offset;
8159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008161}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008162#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8165 unsigned char *hash, size_t *hashlen,
8166 unsigned char *data, size_t data_len,
8167 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008168{
8169 psa_status_t status;
8170 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008171 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008174
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 if ((status = psa_hash_setup(&hash_operation,
8176 hash_alg)) != PSA_SUCCESS) {
8177 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008178 goto exit;
8179 }
8180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8182 64)) != PSA_SUCCESS) {
8183 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008184 goto exit;
8185 }
8186
Gilles Peskine449bd832023-01-11 14:50:10 +01008187 if ((status = psa_hash_update(&hash_operation,
8188 data, data_len)) != PSA_SUCCESS) {
8189 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008190 goto exit;
8191 }
8192
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8194 hashlen)) != PSA_SUCCESS) {
8195 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8196 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008197 }
8198
8199exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if (status != PSA_SUCCESS) {
8201 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8202 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8203 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008204 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008206 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8207 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008209 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008211 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008213 }
8214 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008216}
8217
Jerry Yuee40f9d2022-02-17 14:55:16 +08008218
Jerry Yud9d91da2022-02-17 14:57:06 +08008219#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8220
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008221/* Find the preferred hash for a given signature algorithm. */
8222unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 mbedtls_ssl_context *ssl,
8224 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008225{
Gabor Mezei078e8032022-04-27 21:17:56 +02008226 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008227 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008228
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8230 return MBEDTLS_SSL_HASH_NONE;
8231 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008232
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008234 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8236 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008237 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8239 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008240
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008241 mbedtls_md_type_t md_alg =
8242 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8243 if (md_alg == MBEDTLS_MD_NONE) {
8244 continue;
8245 }
8246
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008249 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008250 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008251
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8253 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8254 PSA_ALG_ECDSA(psa_hash_alg),
8255 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008256 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008258
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8260 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8261 PSA_ALG_RSA_PKCS1V15_SIGN(
8262 psa_hash_alg),
8263 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008264 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008266 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008267
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008269 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008270 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008271
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008273}
8274
8275#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8276
Jerry Yudc7bd172022-02-17 13:44:15 +08008277#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8278
XiaokangQian75d40ef2022-04-20 11:05:24 +00008279int mbedtls_ssl_validate_ciphersuite(
8280 const mbedtls_ssl_context *ssl,
8281 const mbedtls_ssl_ciphersuite_t *suite_info,
8282 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008284{
8285 (void) ssl;
8286
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 if (suite_info == NULL) {
8288 return -1;
8289 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008290
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if ((suite_info->min_tls_version > max_tls_version) ||
8292 (suite_info->max_tls_version < min_tls_version)) {
8293 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008294 }
8295
XiaokangQian060d8672022-04-21 09:24:56 +00008296#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008297#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008299 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008301 }
8302#endif
8303
8304 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8305#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8307 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8308 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008309 }
8310#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8311#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8312
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008314}
8315
Ronald Crone68ab4f2022-10-05 12:46:29 +02008316#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008317/*
8318 * Function for writing a signature algorithm extension.
8319 *
8320 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8321 * value (TLS 1.3 RFC8446):
8322 * enum {
8323 * ....
8324 * ecdsa_secp256r1_sha256( 0x0403 ),
8325 * ecdsa_secp384r1_sha384( 0x0503 ),
8326 * ecdsa_secp521r1_sha512( 0x0603 ),
8327 * ....
8328 * } SignatureScheme;
8329 *
8330 * struct {
8331 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8332 * } SignatureSchemeList;
8333 *
8334 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8335 * value (TLS 1.2 RFC5246):
8336 * enum {
8337 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8338 * sha512(6), (255)
8339 * } HashAlgorithm;
8340 *
8341 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8342 * SignatureAlgorithm;
8343 *
8344 * struct {
8345 * HashAlgorithm hash;
8346 * SignatureAlgorithm signature;
8347 * } SignatureAndHashAlgorithm;
8348 *
8349 * SignatureAndHashAlgorithm
8350 * supported_signature_algorithms<2..2^16-2>;
8351 *
8352 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8353 * generalization of the TLS 1.2 signature algorithm extension.
8354 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8355 * `SignatureScheme` field of TLS 1.3
8356 *
8357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008358int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8359 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008360{
8361 unsigned char *p = buf;
8362 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8363 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8364
8365 *out_len = 0;
8366
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008368
8369 /* Check if we have space for header and length field:
8370 * - extension_type (2 bytes)
8371 * - extension_data_length (2 bytes)
8372 * - supported_signature_algorithms_length (2 bytes)
8373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008374 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008375 p += 6;
8376
8377 /*
8378 * Write supported_signature_algorithms
8379 */
8380 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8382 if (sig_alg == NULL) {
8383 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8384 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008385
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8387 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8388 *sig_alg,
8389 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8390 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008391 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 }
8393 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8394 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008395 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008396 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8397 *sig_alg,
8398 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008399 }
8400
8401 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008402 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 if (supported_sig_alg_len == 0) {
8404 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8405 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008406 }
8407
Gilles Peskine449bd832023-01-11 14:50:10 +01008408 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8409 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8410 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008411
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008412 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008413
8414#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008416#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008417
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008419}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008420#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008421
XiaokangQian40a35232022-05-07 09:02:40 +00008422#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008423/*
8424 * mbedtls_ssl_parse_server_name_ext
8425 *
8426 * Structure of server_name extension:
8427 *
8428 * enum {
8429 * host_name(0), (255)
8430 * } NameType;
8431 * opaque HostName<1..2^16-1>;
8432 *
8433 * struct {
8434 * NameType name_type;
8435 * select (name_type) {
8436 * case host_name: HostName;
8437 * } name;
8438 * } ServerName;
8439 * struct {
8440 * ServerName server_name_list<1..2^16-1>
8441 * } ServerNameList;
8442 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008444int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8445 const unsigned char *buf,
8446 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008447{
8448 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8449 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008450 size_t server_name_list_len, hostname_len;
8451 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008452
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008454
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8456 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008457 p += 2;
8458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008460 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 while (p < server_name_list_end) {
8462 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8463 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8464 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8465 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008466
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008468 /* sni_name is intended to be used only during the parsing of the
8469 * ClientHello message (it is reset to NULL before the end of
8470 * the message parsing). Thus it is ok to just point to the
8471 * reception buffer and not make a copy of it.
8472 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008473 ssl->handshake->sni_name = p + 3;
8474 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 if (ssl->conf->f_sni == NULL) {
8476 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008477 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8479 ssl, p + 3, hostname_len);
8480 if (ret != 0) {
8481 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8482 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8483 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8484 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8485 }
8486 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008487 }
8488
8489 p += hostname_len + 3;
8490 }
8491
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008493}
8494#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8495
XiaokangQianacb39922022-06-17 10:18:48 +00008496#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008497MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008498int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8499 const unsigned char *buf,
8500 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008501{
8502 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008503 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008504 const unsigned char *protocol_name_list;
8505 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008506 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008507
8508 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008509 if (ssl->conf->alpn_list == NULL) {
8510 return 0;
8511 }
XiaokangQianacb39922022-06-17 10:18:48 +00008512
8513 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008514 * RFC7301, section 3.1
8515 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008516 *
XiaokangQianc7403452022-06-23 03:24:12 +00008517 * struct {
8518 * ProtocolName protocol_name_list<2..2^16-1>
8519 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008520 */
8521
XiaokangQianc7403452022-06-23 03:24:12 +00008522 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008523 * protocol_name_list_len 2 bytes
8524 * protocol_name_len 1 bytes
8525 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008528
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008530 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008532 protocol_name_list = p;
8533 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008534
8535 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008537 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8539 protocol_name_len);
8540 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008541 MBEDTLS_SSL_PEND_FATAL_ALERT(
8542 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008543 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8544 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008545 }
8546
8547 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008548 }
8549
8550 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008551 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008553 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008555 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if (protocol_name_len == alpn_len &&
8557 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008558 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008560 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008561
8562 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008563 }
8564 }
8565
XiaokangQian95d5f542022-06-24 02:29:26 +00008566 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008567 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008568 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8569 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8570 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008571}
8572
Gilles Peskine449bd832023-01-11 14:50:10 +01008573int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8574 unsigned char *buf,
8575 unsigned char *end,
8576 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008577{
8578 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008579 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008580 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 if (ssl->alpn_chosen == NULL) {
8583 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008584 }
8585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 protocol_name_len = strlen(ssl->alpn_chosen);
8587 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008588
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008590 /*
8591 * 0 . 1 ext identifier
8592 * 2 . 3 ext length
8593 * 4 . 5 protocol list length
8594 * 6 . 6 protocol name length
8595 * 7 . 7+n protocol name
8596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008598
XiaokangQian95d5f542022-06-24 02:29:26 +00008599 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008600
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8602 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008603 /* Note: the length of the chosen protocol has been checked to be less
8604 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8605 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008607
Gilles Peskine449bd832023-01-11 14:50:10 +01008608 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008609
8610#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008612#endif
8613
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008615}
8616#endif /* MBEDTLS_SSL_ALPN */
8617
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008618#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008619 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008620 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008621 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008622int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8623 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008624{
8625 /* Initialize to suppress unnecessary compiler warning */
8626 size_t hostname_len = 0;
8627
8628 /* Check if new hostname is valid before
8629 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 if (hostname != NULL) {
8631 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008632
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8635 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008636 }
8637
8638 /* Now it's clear that we will overwrite the old hostname,
8639 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008641 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008643 }
8644
8645 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008647 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 } else {
8649 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8650 if (session->hostname == NULL) {
8651 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8652 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008653
Gilles Peskine449bd832023-01-11 14:50:10 +01008654 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008655 }
8656
Gilles Peskine449bd832023-01-11 14:50:10 +01008657 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008658}
Xiaokang Qian03409292022-10-12 02:49:52 +00008659#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8660 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008661 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008662 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008663
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008664#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8665 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008666int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8667 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008668{
8669 size_t alpn_len = 0;
8670
8671 if (alpn != NULL) {
8672 alpn_len = strlen(alpn);
8673
8674 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8676 }
8677 }
8678
8679 if (session->ticket_alpn != NULL) {
8680 mbedtls_zeroize_and_free(session->ticket_alpn,
8681 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008682 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008683 }
8684
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008685 if (alpn != NULL) {
8686 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008687 if (session->ticket_alpn == NULL) {
8688 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8689 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008690 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008691 }
8692
8693 return 0;
8694}
8695#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008696
8697/*
8698 * The following functions are used by 1.2 and 1.3, client and server.
8699 */
8700#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8701int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8702 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8703 int recv_endpoint,
8704 mbedtls_ssl_protocol_version tls_version,
8705 uint32_t *flags)
8706{
8707 int ret = 0;
8708 unsigned int usage = 0;
8709 const char *ext_oid;
8710 size_t ext_len;
8711
8712 /*
8713 * keyUsage
8714 */
8715
8716 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8717 * to check what a compliant client will think while choosing which cert
8718 * to send to the client. */
8719#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8720 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8721 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8722 /* TLS 1.2 server part of the key exchange */
8723 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008724 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8725 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8726 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8727 break;
8728
8729 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8730 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8731 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8732 break;
8733
8734 /* Don't use default: we want warnings when adding new values */
8735 case MBEDTLS_KEY_EXCHANGE_NONE:
8736 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008737 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8738 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8739 usage = 0;
8740 }
8741 } else
8742#endif
8743 {
8744 /* This is either TLS 1.3 authentication, which always uses signatures,
8745 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8746 * options we implement, both using signatures. */
8747 (void) tls_version;
8748 (void) ciphersuite;
8749 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8750 }
8751
8752 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8753 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8754 ret = -1;
8755 }
8756
8757 /*
8758 * extKeyUsage
8759 */
8760
8761 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8762 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8763 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8764 } else {
8765 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8766 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8767 }
8768
8769 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8770 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8771 ret = -1;
8772 }
8773
8774 return ret;
8775}
8776
Gilles Peskine4ac40082025-02-20 18:13:58 +01008777static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8778 const char **hostname)
8779{
8780 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8781 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008782 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8783 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8784 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8785 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008786 }
8787
8788 *hostname = ssl->hostname;
8789 if (*hostname == NULL) {
8790 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8791 }
8792
8793 return 0;
8794}
8795
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008796int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8797 int authmode,
8798 mbedtls_x509_crt *chain,
8799 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8800 void *rs_ctx)
8801{
8802 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8803 return 0;
8804 }
8805
8806 /*
8807 * Primary check: use the appropriate X.509 verification function
8808 */
8809 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8810 void *p_vrfy;
8811 if (ssl->f_vrfy != NULL) {
8812 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8813 f_vrfy = ssl->f_vrfy;
8814 p_vrfy = ssl->p_vrfy;
8815 } else {
8816 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8817 f_vrfy = ssl->conf->f_vrfy;
8818 p_vrfy = ssl->conf->p_vrfy;
8819 }
8820
Gilles Peskine4ac40082025-02-20 18:13:58 +01008821 const char *hostname = "";
8822 int ret = get_hostname_for_verification(ssl, &hostname);
8823 if (ret != 0) {
8824 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8825 return ret;
8826 }
8827
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008828 int have_ca_chain_or_callback = 0;
8829#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8830 if (ssl->conf->f_ca_cb != NULL) {
8831 ((void) rs_ctx);
8832 have_ca_chain_or_callback = 1;
8833
8834 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8835 ret = mbedtls_x509_crt_verify_with_ca_cb(
8836 chain,
8837 ssl->conf->f_ca_cb,
8838 ssl->conf->p_ca_cb,
8839 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008840 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008841 &ssl->session_negotiate->verify_result,
8842 f_vrfy, p_vrfy);
8843 } else
8844#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8845 {
8846 mbedtls_x509_crt *ca_chain;
8847 mbedtls_x509_crl *ca_crl;
8848#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8849 if (ssl->handshake->sni_ca_chain != NULL) {
8850 ca_chain = ssl->handshake->sni_ca_chain;
8851 ca_crl = ssl->handshake->sni_ca_crl;
8852 } else
8853#endif
8854 {
8855 ca_chain = ssl->conf->ca_chain;
8856 ca_crl = ssl->conf->ca_crl;
8857 }
8858
8859 if (ca_chain != NULL) {
8860 have_ca_chain_or_callback = 1;
8861 }
8862
8863 ret = mbedtls_x509_crt_verify_restartable(
8864 chain,
8865 ca_chain, ca_crl,
8866 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008867 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008868 &ssl->session_negotiate->verify_result,
8869 f_vrfy, p_vrfy, rs_ctx);
8870 }
8871
8872 if (ret != 0) {
8873 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8874 }
8875
8876#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8877 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8878 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8879 }
8880#endif
8881
8882 /*
8883 * Secondary checks: always done, but change 'ret' only if it was 0
8884 */
8885
8886 /* With TLS 1.2 and ECC certs, check that the curve used by the
8887 * certificate is on our list of acceptable curves.
8888 *
8889 * With TLS 1.3 this is not needed because the curve is part of the
8890 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8891 * we validate the signature made with the key associated to this cert.
8892 */
8893#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8894 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8895 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8896 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8897 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8898 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8899 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8900 if (ret == 0) {
8901 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8902 }
8903 }
8904 }
8905#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8906
8907 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8908 if (mbedtls_ssl_check_cert_usage(chain,
8909 ciphersuite_info,
8910 ssl->conf->endpoint,
8911 ssl->tls_version,
8912 &ssl->session_negotiate->verify_result) != 0) {
8913 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8914 if (ret == 0) {
8915 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8916 }
8917 }
8918
8919 /* With authmode optional, we want to keep going if the certificate was
8920 * unacceptable, but still fail on other errors (out of memory etc),
8921 * including fatal errors from the f_vrfy callback.
8922 *
8923 * The only acceptable errors are:
8924 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8925 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8926 * Anything else is a fatal error. */
8927 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8928 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8929 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8930 ret = 0;
8931 }
8932
8933 /* Return a specific error as this is a user error: inconsistent
8934 * configuration - can't verify without trust anchors. */
8935 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8936 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8937 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8938 }
8939
8940 if (ret != 0) {
8941 uint8_t alert;
8942
8943 /* The certificate may have been rejected for several reasons.
8944 Pick one and send the corresponding alert. Which alert to send
8945 may be a subject of debate in some cases. */
8946 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8947 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8948 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8949 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8950 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8951 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8952 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8953 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8954 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8955 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8956 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8957 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8958 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8959 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8960 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8961 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8962 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8963 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8964 } else {
8965 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8966 }
8967 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8968 alert);
8969 }
8970
8971#if defined(MBEDTLS_DEBUG_C)
8972 if (ssl->session_negotiate->verify_result != 0) {
8973 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8974 (unsigned int) ssl->session_negotiate->verify_result));
8975 } else {
8976 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8977 }
8978#endif /* MBEDTLS_DEBUG_C */
8979
8980 return ret;
8981}
8982#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8983
Max Fillinger2fe35f62024-10-25 00:52:24 +02008984#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008985
Max Fillinger29beade2024-09-21 11:06:28 +02008986#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008987static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8988 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008989 uint8_t *out,
8990 const size_t key_len,
8991 const char *label,
8992 const size_t label_len,
8993 const unsigned char *context,
8994 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008995 const int use_context)
8996{
8997 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008998 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008999
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009000 /* The input to the PRF is client_random, then server_random.
9001 * If a context is provided, this is then followed by the context length
9002 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02009003 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
9004 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009005 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02009006 if (context_len > UINT16_MAX) {
9007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9008 }
9009
9010 /* This does not overflow a 32-bit size_t because the current value of
9011 * prf_input_len is 64 (length of client_random + server_random) and
9012 * context_len fits into two bytes (checked above). */
9013 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009014 }
Max Fillinger155cea02024-10-23 16:32:54 +02009015
9016 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
9017 if (prf_input == NULL) {
9018 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9019 }
9020
9021 memcpy(prf_input,
9022 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
9023 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
9024 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
9025 ssl->transform->randbytes,
9026 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
9027 if (use_context) {
9028 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
9029 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
9030 }
9031 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02009032 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009033 prf_input, prf_input_len,
9034 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009035 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009036 return ret;
9037}
Max Fillinger281fb792024-10-23 18:35:09 +02009038#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009039
Max Fillinger29beade2024-09-21 11:06:28 +02009040#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009041static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
9042 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02009043 uint8_t *out,
9044 const size_t key_len,
9045 const char *label,
9046 const size_t label_len,
9047 const unsigned char *context,
9048 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009049{
9050 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9051 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9052 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9053
Max Fillinger9c5bae52024-11-21 12:33:46 +01009054 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009055 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009056 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009057 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01009058 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009059 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01009060 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9062 }
9063
9064 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009065 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009066 context, context_len, out, key_len);
9067}
Max Fillinger281fb792024-10-23 18:35:09 +02009068#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009069
9070int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009071 uint8_t *out, const size_t key_len,
9072 const char *label, const size_t label_len,
9073 const unsigned char *context, const size_t context_len,
9074 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009075{
9076 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01009077 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9079 }
9080
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009081 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9082 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9083 }
9084
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009085 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9086 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9087 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9088
9089 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009091 case MBEDTLS_SSL_VERSION_TLS1_2:
9092 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9093 label, label_len,
9094 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009095#endif
9096#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009097 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009098 return mbedtls_ssl_tls13_export_keying_material(ssl,
9099 hash_alg,
9100 out,
9101 key_len,
9102 label,
9103 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009104 use_context ? context : NULL,
9105 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009106#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009107 default:
9108 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9109 }
9110}
9111
Max Fillinger2fe35f62024-10-25 00:52:24 +02009112#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009114#endif /* MBEDTLS_SSL_TLS_C */