blob: 46197c95ca702c812f2535d5e8c4735e65cdbff8 [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
1413 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001414 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001415
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001417
1418 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419#if defined(MBEDTLS_SSL_RENEGOTIATION)
1420 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001421 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001422
1423 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1425 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001426#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001428
Hanno Beckerb0302c42021-08-03 09:39:42 +01001429 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001430 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 if (ssl->session) {
1432 mbedtls_ssl_session_free(ssl->session);
1433 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001434 ssl->session = NULL;
1435 }
1436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001438 ssl->alpn_chosen = NULL;
1439#endif
1440
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001441#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001442 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001443#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 if (free_cli_id) {
1447 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001448 ssl->cli_id = NULL;
1449 ssl->cli_id_len = 0;
1450 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001451#endif
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if ((ret = ssl_handshake_init(ssl)) != 0) {
1454 return ret;
1455 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458}
1459
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001460/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
1463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001464int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001465{
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001467}
1468
1469/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001470 * SSL set accessors
1471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001473{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001474 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001475}
1476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001478{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001479 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001480}
1481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001483void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001484{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001485 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001486}
1487#endif
1488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001490{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001491 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001492}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1497 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001498{
1499 ssl->disable_datagram_packing = !allow_packing;
1500}
1501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1503 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001504{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001505 conf->hs_timeout_min = min;
1506 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001507}
1508#endif
1509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001511{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001513}
1514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1517 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1518 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001519{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001520 conf->f_vrfy = f_vrfy;
1521 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001522}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1526 void (*f_dbg)(void *, int, const char *, int, const char *),
1527 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001528{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001529 conf->f_dbg = f_dbg;
1530 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001531}
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1534 void *p_bio,
1535 mbedtls_ssl_send_t *f_send,
1536 mbedtls_ssl_recv_t *f_recv,
1537 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001538{
1539 ssl->p_bio = p_bio;
1540 ssl->f_send = f_send;
1541 ssl->f_recv = f_recv;
1542 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001543}
1544
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001546void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001547{
1548 ssl->mtu = mtu;
1549}
1550#endif
1551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001553{
1554 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001555}
1556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1558 void *p_timer,
1559 mbedtls_ssl_set_timer_t *f_set_timer,
1560 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001561{
1562 ssl->p_timer = p_timer;
1563 ssl->f_set_timer = f_set_timer;
1564 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001565
1566 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001568}
1569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1572 void *p_cache,
1573 mbedtls_ssl_cache_get_t *f_get_cache,
1574 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001575{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001576 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001577 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001578 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001579}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001584{
Janos Follath865b3eb2019-12-16 11:46:15 +00001585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001588 session == NULL ||
1589 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001592 }
1593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (ssl->handshake->resume == 1) {
1595 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1596 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001597
Jerry Yu21092062022-10-10 21:21:31 +08001598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001600#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001601 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001605 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1607 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1608 session->ciphersuite));
1609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001610 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001611#else
1612 /*
1613 * If session tickets are not enabled, it is not possible to resume a
1614 * TLS 1.3 session, thus do not make any change to the SSL context in
1615 * the first place.
1616 */
1617 return 0;
1618#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001619 }
Jerry Yu21092062022-10-10 21:21:31 +08001620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1623 session)) != 0) {
1624 return ret;
1625 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001626
Paul Bakker0a597072012-09-25 21:55:46 +00001627 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001630}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1634 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001635{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001636 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001637}
1638
Ronald Cron6f135e12021-12-08 16:57:54 +01001639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1641 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001642{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001643 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001644}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001645
1646#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001647void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1648 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001649{
1650 conf->early_data_enabled = early_data_enabled;
1651}
Jerry Yucc4e0072022-11-22 17:22:22 +08001652
1653#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001654void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001656{
Jerry Yu39da9852022-12-06 16:58:36 +08001657 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001658}
1659#endif /* MBEDTLS_SSL_SRV_C */
1660
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001661#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001662#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1666 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001667{
1668 conf->cert_profile = profile;
1669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001672{
1673 mbedtls_ssl_key_cert *cur = key_cert, *next;
1674
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001676 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001678 cur = next;
1679 }
1680}
1681
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001682/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001684static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1685 mbedtls_x509_crt *cert,
1686 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001687{
niisato8ee24222018-06-25 19:05:48 +09001688 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001691 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001693 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001695 }
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1698 if (new_cert == NULL) {
1699 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1700 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001701
niisato8ee24222018-06-25 19:05:48 +09001702 new_cert->cert = cert;
1703 new_cert->key = key;
1704 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001705
Glenn Strauss36872db2022-01-22 05:06:31 -05001706 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001708 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001710 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001712 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 }
niisato8ee24222018-06-25 19:05:48 +09001714 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001715 }
1716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001718}
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001721 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001723{
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001725}
1726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001728 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001731 conf->ca_chain = ca_chain;
1732 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001733
1734#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1735 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1736 * cannot be used together. */
1737 conf->f_ca_cb = NULL;
1738 conf->p_ca_cb = NULL;
1739#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001740}
Hanno Becker5adaad92019-03-27 16:54:37 +00001741
1742#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001743void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1744 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1745 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001746{
1747 conf->f_ca_cb = f_ca_cb;
1748 conf->p_ca_cb = p_ca_cb;
1749
1750 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1751 * cannot be used together. */
1752 conf->ca_chain = NULL;
1753 conf->ca_crl = NULL;
1754}
1755#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001757
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001758#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001759const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1760 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001761{
1762 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001764}
1765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1767 mbedtls_x509_crt *own_cert,
1768 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001769{
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1771 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001772}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1775 mbedtls_x509_crt *ca_chain,
1776 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001777{
1778 ssl->handshake->sni_ca_chain = ca_chain;
1779 ssl->handshake->sni_ca_crl = ca_crl;
1780}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001781
Glenn Strauss999ef702022-03-11 01:37:23 -05001782#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1784 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001785{
1786 ssl->handshake->dn_hints = crt;
1787}
1788#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1791 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001792{
1793 ssl->handshake->sni_authmode = authmode;
1794}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001795#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1796
Hanno Becker8927c832019-04-03 12:52:50 +01001797#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001798void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1799 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1800 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001801{
1802 ssl->f_vrfy = f_vrfy;
1803 ssl->p_vrfy = p_vrfy;
1804}
1805#endif
1806
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001807#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001808
Przemek Stekielfde11282023-03-13 16:06:09 +01001809static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1810static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1811
Valerio Setti016f6822022-12-09 14:17:50 +01001812static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 mbedtls_ssl_context *ssl,
1814 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001815{
1816 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001817 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001818 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001819 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001820 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001821 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1823 psa_pake_cs_set_primitive(&cipher_suite,
1824 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1825 PSA_ECC_FAMILY_SECP_R1,
1826 256));
1827 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1830 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001831 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001835 user = jpake_server_id;
1836 user_len = sizeof(jpake_server_id);
1837 peer = jpake_client_id;
1838 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001840 user = jpake_client_id;
1841 user_len = sizeof(jpake_client_id);
1842 peer = jpake_server_id;
1843 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001845
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001846 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1847 if (status != PSA_SUCCESS) {
1848 return status;
1849 }
1850
1851 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001853 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 }
Valerio Setti016f6822022-12-09 14:17:50 +01001855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1857 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001858 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 }
Valerio Setti016f6822022-12-09 14:17:50 +01001860
1861 ssl->handshake->psa_pake_ctx_is_ok = 1;
1862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1867 const unsigned char *pw,
1868 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001869{
1870 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1871 psa_status_t status;
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (ssl->handshake == NULL || ssl->conf == NULL) {
1874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001875 }
1876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 /* Empty password is not valid */
1878 if ((pw == NULL) || (pw_len == 0)) {
1879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1880 }
1881
1882 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1883 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1884 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1885
1886 status = psa_import_key(&attributes, pw, pw_len,
1887 &ssl->handshake->psa_pake_password);
1888 if (status != PSA_SUCCESS) {
1889 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1890 }
1891
1892 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1893 ssl->handshake->psa_pake_password);
1894 if (status != PSA_SUCCESS) {
1895 psa_destroy_key(ssl->handshake->psa_pake_password);
1896 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1897 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1898 }
1899
1900 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001901}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1904 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001905{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001906 psa_status_t status;
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (ssl->handshake == NULL || ssl->conf == NULL) {
1909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001910 }
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (mbedtls_svc_key_id_is_null(pwd)) {
1913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1914 }
1915
1916 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1917 if (status != PSA_SUCCESS) {
1918 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1919 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1920 }
1921
1922 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001923}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001924#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001925
Ronald Cron73fe8df2022-10-05 14:31:43 +02001926#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001927int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001928{
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (conf->psk_identity == NULL ||
1930 conf->psk_identity_len == 0) {
1931 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001932 }
1933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1935 return 1;
1936 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (conf->psk != NULL && conf->psk_len != 0) {
1939 return 1;
1940 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001943}
1944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001946{
1947 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001949 /* The maintenance of the PSK key slot is the
1950 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001951 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001952 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001954 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001955 conf->psk = NULL;
1956 conf->psk_len = 0;
1957 }
1958
1959 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (conf->psk_identity != NULL) {
1961 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001962 conf->psk_identity = NULL;
1963 conf->psk_identity_len = 0;
1964 }
1965}
1966
Hanno Becker7390c712018-11-15 13:33:04 +00001967/* This function assumes that PSK identity in the SSL config is unset.
1968 * It checks that the provided identity is well-formed and attempts
1969 * to make a copy of it in the SSL config.
1970 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001971MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001972static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1973 unsigned char const *psk_identity,
1974 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001975{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001976 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001978 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 (psk_identity_len >> 16) != 0 ||
1980 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001982 }
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1985 if (conf->psk_identity == NULL) {
1986 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1987 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001988
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001989 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001993}
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1996 const unsigned char *psk, size_t psk_len,
1997 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001998{
Janos Follath865b3eb2019-12-16 11:46:15 +00001999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002000
2001 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2003 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2004 }
Hanno Becker7390c712018-11-15 13:33:04 +00002005
2006 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 if (psk == NULL) {
2008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2009 }
2010 if (psk_len == 0) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2012 }
2013 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2015 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2018 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2019 }
Hanno Becker7390c712018-11-15 13:33:04 +00002020 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002022
2023 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2025 if (ret != 0) {
2026 ssl_conf_remove_psk(conf);
2027 }
Hanno Becker7390c712018-11-15 13:33:04 +00002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002030}
2031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002033{
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002035 /* The maintenance of the external PSK key slot is the
2036 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake->psk_opaque_is_internal) {
2038 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002039 ssl->handshake->psk_opaque_is_internal = 0;
2040 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002041 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002042 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002043}
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2046 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002047{
Neil Armstrong501c9322022-05-03 09:35:09 +02002048 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002049 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002050 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002051 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (psk == NULL || ssl->handshake == NULL) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2059 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002062
Jerry Yuccc68a42022-07-26 16:39:20 +08002063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2065 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2066 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2067 } else {
2068 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2069 }
2070 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002071 }
2072#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002073
Jerry Yu568ec252022-07-22 21:27:34 +08002074#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2076 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2077 psa_set_key_usage_flags(&key_attributes,
2078 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002079 }
2080#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 psa_set_key_algorithm(&key_attributes, alg);
2083 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2086 if (status != PSA_SUCCESS) {
2087 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2088 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002089
2090 /* Allow calling psa_destroy_key() on psk remove */
2091 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002093}
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2096 mbedtls_svc_key_id_t psk,
2097 const unsigned char *psk_identity,
2098 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002099{
Janos Follath865b3eb2019-12-16 11:46:15 +00002100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101
2102 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2104 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2105 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002106
Hanno Becker7390c712018-11-15 13:33:04 +00002107 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (mbedtls_svc_key_id_is_null(psk)) {
2109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2110 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002111 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002112
2113 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2115 psk_identity_len);
2116 if (ret != 0) {
2117 ssl_conf_remove_psk(conf);
2118 }
Hanno Becker7390c712018-11-15 13:33:04 +00002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121}
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2124 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002125{
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if ((mbedtls_svc_key_id_is_null(psk)) ||
2127 (ssl->handshake == NULL)) {
2128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2129 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002132 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002134}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002135
Jerry Yu8897c072022-08-12 13:56:53 +08002136#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002137void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2138 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2139 size_t),
2140 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002141{
2142 conf->f_psk = f_psk;
2143 conf->p_psk = p_psk;
2144}
Jerry Yu8897c072022-08-12 13:56:53 +08002145#endif /* MBEDTLS_SSL_SRV_C */
2146
Ronald Cron73fe8df2022-10-05 14:31:43 +02002147#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002148
Gilles Peskine301711e2022-04-26 16:57:05 +02002149static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002151{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (alg == PSA_ALG_CBC_NO_PADDING) {
2154 return MBEDTLS_SSL_MODE_CBC;
2155 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002156#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (PSA_ALG_IS_AEAD(alg)) {
2158 return MBEDTLS_SSL_MODE_AEAD;
2159 }
2160 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002161}
2162
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002163
Gilles Peskinee108d982022-04-26 16:50:40 +02002164static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2165 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002167{
2168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2170 base_mode == MBEDTLS_SSL_MODE_CBC) {
2171 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002172 }
2173#else
2174 (void) encrypt_then_mac;
2175#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002177}
2178
Neil Armstrongab555e02022-04-04 11:07:59 +02002179mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002181{
Gilles Peskinee108d982022-04-26 16:50:40 +02002182 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002184 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002185
Gilles Peskinee108d982022-04-26 16:50:40 +02002186 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002187#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002188 encrypt_then_mac = transform->encrypt_then_mac;
2189#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002191}
2192
Neil Armstrongab555e02022-04-04 11:07:59 +02002193mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002194#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002196#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002198{
Gilles Peskinee108d982022-04-26 16:50:40 +02002199 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2200
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002201 psa_status_t status;
2202 psa_algorithm_t alg;
2203 psa_key_type_t type;
2204 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002205 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2206 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (status == PSA_SUCCESS) {
2208 base_mode = mbedtls_ssl_get_base_mode(alg);
2209 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210
Gilles Peskinee108d982022-04-26 16:50:40 +02002211#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2212 int encrypt_then_mac = 0;
2213#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002215}
2216
Jerry Yu251a12e2022-07-13 15:15:48 +08002217
Ronald Cron8b592d22024-11-12 18:08:25 +01002218const mbedtls_error_pair_t psa_to_ssl_errors[] =
2219{
2220 { PSA_SUCCESS, 0 },
2221 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2222 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2223 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2224 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2225 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2226 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2227};
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2230 size_t taglen,
2231 psa_algorithm_t *alg,
2232 psa_key_type_t *key_type,
2233 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002234{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002235#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002236 (void) taglen;
2237#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002239#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002240 case MBEDTLS_CIPHER_AES_128_CBC:
2241 *alg = PSA_ALG_CBC_NO_PADDING;
2242 *key_type = PSA_KEY_TYPE_AES;
2243 *key_size = 128;
2244 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002245#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002246#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002247 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249 *key_type = PSA_KEY_TYPE_AES;
2250 *key_size = 128;
2251 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002252#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002253#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002254 case MBEDTLS_CIPHER_AES_128_GCM:
2255 *alg = PSA_ALG_GCM;
2256 *key_type = PSA_KEY_TYPE_AES;
2257 *key_size = 128;
2258 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002259#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002260#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002261 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002263 *key_type = PSA_KEY_TYPE_AES;
2264 *key_size = 192;
2265 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002266#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002267#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002268 case MBEDTLS_CIPHER_AES_192_GCM:
2269 *alg = PSA_ALG_GCM;
2270 *key_type = PSA_KEY_TYPE_AES;
2271 *key_size = 192;
2272 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002273#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002274#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002275 case MBEDTLS_CIPHER_AES_256_CBC:
2276 *alg = PSA_ALG_CBC_NO_PADDING;
2277 *key_type = PSA_KEY_TYPE_AES;
2278 *key_size = 256;
2279 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002280#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002281#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002282 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002284 *key_type = PSA_KEY_TYPE_AES;
2285 *key_size = 256;
2286 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002287#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002288#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002289 case MBEDTLS_CIPHER_AES_256_GCM:
2290 *alg = PSA_ALG_GCM;
2291 *key_type = PSA_KEY_TYPE_AES;
2292 *key_size = 256;
2293 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002294#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002295#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002296 case MBEDTLS_CIPHER_ARIA_128_CBC:
2297 *alg = PSA_ALG_CBC_NO_PADDING;
2298 *key_type = PSA_KEY_TYPE_ARIA;
2299 *key_size = 128;
2300 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002301#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002302#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002303 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002305 *key_type = PSA_KEY_TYPE_ARIA;
2306 *key_size = 128;
2307 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002308#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002309#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002310 case MBEDTLS_CIPHER_ARIA_128_GCM:
2311 *alg = PSA_ALG_GCM;
2312 *key_type = PSA_KEY_TYPE_ARIA;
2313 *key_size = 128;
2314 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002315#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002316#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002317 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002319 *key_type = PSA_KEY_TYPE_ARIA;
2320 *key_size = 192;
2321 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002322#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002323#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002324 case MBEDTLS_CIPHER_ARIA_192_GCM:
2325 *alg = PSA_ALG_GCM;
2326 *key_type = PSA_KEY_TYPE_ARIA;
2327 *key_size = 192;
2328 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002329#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002330#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002331 case MBEDTLS_CIPHER_ARIA_256_CBC:
2332 *alg = PSA_ALG_CBC_NO_PADDING;
2333 *key_type = PSA_KEY_TYPE_ARIA;
2334 *key_size = 256;
2335 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002336#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002337#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002338 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002340 *key_type = PSA_KEY_TYPE_ARIA;
2341 *key_size = 256;
2342 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002343#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002344#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002345 case MBEDTLS_CIPHER_ARIA_256_GCM:
2346 *alg = PSA_ALG_GCM;
2347 *key_type = PSA_KEY_TYPE_ARIA;
2348 *key_size = 256;
2349 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002350#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002351#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002352 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2353 *alg = PSA_ALG_CBC_NO_PADDING;
2354 *key_type = PSA_KEY_TYPE_CAMELLIA;
2355 *key_size = 128;
2356 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002357#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002358#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002359 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002361 *key_type = PSA_KEY_TYPE_CAMELLIA;
2362 *key_size = 128;
2363 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002364#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002365#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002366 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2367 *alg = PSA_ALG_GCM;
2368 *key_type = PSA_KEY_TYPE_CAMELLIA;
2369 *key_size = 128;
2370 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002371#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002372#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002373 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002375 *key_type = PSA_KEY_TYPE_CAMELLIA;
2376 *key_size = 192;
2377 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002378#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002379#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002380 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2381 *alg = PSA_ALG_GCM;
2382 *key_type = PSA_KEY_TYPE_CAMELLIA;
2383 *key_size = 192;
2384 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002385#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002386#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002387 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2388 *alg = PSA_ALG_CBC_NO_PADDING;
2389 *key_type = PSA_KEY_TYPE_CAMELLIA;
2390 *key_size = 256;
2391 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002392#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002393#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002394 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002396 *key_type = PSA_KEY_TYPE_CAMELLIA;
2397 *key_size = 256;
2398 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002399#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002400#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002401 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2402 *alg = PSA_ALG_GCM;
2403 *key_type = PSA_KEY_TYPE_CAMELLIA;
2404 *key_size = 256;
2405 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002406#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002407#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002408 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2409 *alg = PSA_ALG_CHACHA20_POLY1305;
2410 *key_type = PSA_KEY_TYPE_CHACHA20;
2411 *key_size = 256;
2412 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002413#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002414 case MBEDTLS_CIPHER_NULL:
2415 *alg = MBEDTLS_SSL_NULL_CIPHER;
2416 *key_type = 0;
2417 *key_size = 0;
2418 break;
2419 default:
2420 return PSA_ERROR_NOT_SUPPORTED;
2421 }
2422
2423 return PSA_SUCCESS;
2424}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002425
Ronald Crone68ab4f2022-10-05 12:46:29 +02002426#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002427#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002428/*
2429 * Set allowed/preferred hashes for handshake signatures
2430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002431void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2432 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002433{
2434 conf->sig_hashes = hashes;
2435}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002436#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002437
Jerry Yuf017ee42022-01-12 15:49:48 +08002438/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002439void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2440 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002441{
Jerry Yuf017ee42022-01-12 15:49:48 +08002442#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2443 conf->sig_hashes = NULL;
2444#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2445 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002446}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002447#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002448
Brett Warrene0edc842021-08-17 09:53:13 +01002449/*
2450 * Set the allowed groups
2451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2453 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002454{
Brett Warrene0edc842021-08-17 09:53:13 +01002455 conf->group_list = group_list;
2456}
2457
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002458#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002459int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002460{
Hanno Becker947194e2017-04-07 13:25:49 +01002461 /* Initialize to suppress unnecessary compiler warning */
2462 size_t hostname_len = 0;
2463
2464 /* Check if new hostname is valid before
2465 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 if (hostname != NULL) {
2467 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2470 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2471 }
Hanno Becker947194e2017-04-07 13:25:49 +01002472 }
2473
2474 /* Now it's clear that we will overwrite the old hostname,
2475 * so we can free it safely */
2476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002478 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002479 }
2480
2481 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002484 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 } else {
2486 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2487 if (ssl->hostname == NULL) {
2488 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2489 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002492
Hanno Becker947194e2017-04-07 13:25:49 +01002493 ssl->hostname[hostname_len] = '\0';
2494 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002497}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002498#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002499
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002500#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002501void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2502 int (*f_sni)(void *, mbedtls_ssl_context *,
2503 const unsigned char *, size_t),
2504 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002506 conf->f_sni = f_sni;
2507 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002508}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002512int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002513{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002514 size_t cur_len, tot_len;
2515 const char **p;
2516
2517 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002518 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2519 * MUST NOT be truncated."
2520 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002521 */
2522 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 for (p = protos; *p != NULL; p++) {
2524 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002525 tot_len += cur_len;
2526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if ((cur_len == 0) ||
2528 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2529 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2530 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2531 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002532 }
2533
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002534 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002537}
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002540{
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002542}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002544
Johan Pascalb62bb512015-12-03 21:56:45 +01002545#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002546void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2547 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002548{
2549 conf->dtls_srtp_mki_support = support_mki_value;
2550}
2551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2553 unsigned char *mki_value,
2554 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002555{
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2557 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002558 }
Ron Eldor591f1622018-01-22 12:30:04 +02002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2561 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002562 }
Ron Eldor591f1622018-01-22 12:30:04 +02002563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002565 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002567}
2568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2570 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002571{
Johan Pascal253d0262020-09-22 13:04:45 +02002572 const mbedtls_ssl_srtp_profile *p;
2573 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002574
Johan Pascal253d0262020-09-22 13:04:45 +02002575 /* check the profiles list: all entry must be valid,
2576 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2578 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2579 p++) {
2580 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002581 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002583 /* unsupported value, stop parsing and set the size to an error value */
2584 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002585 }
2586 }
2587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2589 conf->dtls_srtp_profile_list = NULL;
2590 conf->dtls_srtp_profile_list_len = 0;
2591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002592 }
2593
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002594 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002595 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002596
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002598}
2599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2601 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002602{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002603 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2604 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002606 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002608 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2610 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002611 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002612}
Johan Pascalb62bb512015-12-03 21:56:45 +01002613#endif /* MBEDTLS_SSL_DTLS_SRTP */
2614
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302615#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002616void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002617{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002618 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002619}
2620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002622{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002623 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002624}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302625#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002626
Janos Follath088ce432017-04-10 12:42:31 +01002627#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002628void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2629 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002630{
2631 conf->cert_req_ca_list = cert_req_ca_list;
2632}
2633#endif
2634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002636void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002637{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002638 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002639}
2640#endif
2641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002643void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002644{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002645 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002646}
2647#endif
2648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002650int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002651{
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2653 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002655 }
2656
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002657 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002660}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002664{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002665 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002666}
2667
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002669void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002670{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002671 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002672}
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002676 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002677}
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2680 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002681{
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002683}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002687#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002688void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002689{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002690 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002691}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002692#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002693
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002694#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002695
Jerry Yud0766ec2022-09-22 10:46:57 +08002696#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002697void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2698 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002699{
Jerry Yud0766ec2022-09-22 10:46:57 +08002700 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002701}
2702#endif
2703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2705 mbedtls_ssl_ticket_write_t *f_ticket_write,
2706 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2707 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002708{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002709 conf->f_ticket_write = f_ticket_write;
2710 conf->f_ticket_parse = f_ticket_parse;
2711 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002712}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002713#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2717 mbedtls_ssl_export_keys_t *f_export_keys,
2718 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002719{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002720 ssl->f_export_keys = f_export_keys;
2721 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002722}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002723
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002724#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002725void mbedtls_ssl_conf_async_private_cb(
2726 mbedtls_ssl_config *conf,
2727 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002728 mbedtls_ssl_async_resume_t *f_async_resume,
2729 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002731{
2732 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002733 conf->f_async_resume = f_async_resume;
2734 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002735 conf->p_async_config_data = async_config_data;
2736}
2737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002739{
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002741}
2742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002744{
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 if (ssl->handshake == NULL) {
2746 return NULL;
2747 } else {
2748 return ssl->handshake->user_async_ctx;
2749 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2753 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002754{
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002756 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002758}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002759#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002760
Paul Bakker5121ce52009-01-03 21:22:43 +00002761/*
2762 * SSL get accessors
2763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002764uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002765{
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 if (ssl->session != NULL) {
2767 return ssl->session->verify_result;
2768 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (ssl->session_negotiate != NULL) {
2771 return ssl->session_negotiate->verify_result;
2772 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002773
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002775}
2776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002778{
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (ssl == NULL || ssl->session == NULL) {
2780 return 0;
2781 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002784}
2785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002787{
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl == NULL || ssl->session == NULL) {
2789 return NULL;
2790 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002793}
2794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002796{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2799 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002800 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002802 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002804 }
2805 }
2806#endif
2807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002809 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002811 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002813 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002815 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002816}
2817
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002818#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2819
2820size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2821{
2822 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2823 size_t record_size_limit = max_len;
2824
2825 if (ssl->session != NULL &&
2826 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2827 ssl->session->record_size_limit < max_len) {
2828 record_size_limit = ssl->session->record_size_limit;
2829 }
2830
2831 // TODO: this is currently untested
2832 /* During a handshake, use the value being negotiated */
2833 if (ssl->session_negotiate != NULL &&
2834 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2835 ssl->session_negotiate->record_size_limit < max_len) {
2836 record_size_limit = ssl->session_negotiate->record_size_limit;
2837 }
2838
2839 return record_size_limit;
2840}
2841#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2842
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002843#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002845{
David Horstmann95d516f2021-05-04 18:36:56 +01002846 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002847 size_t read_mfl;
2848
Jerry Yuddda0502022-12-01 19:43:12 +08002849#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002850 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2852 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2853 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002854 }
Jerry Yuddda0502022-12-01 19:43:12 +08002855#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002856
2857 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->session_out != NULL) {
2859 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2860 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002861 max_len = read_mfl;
2862 }
2863 }
2864
Jerry Yuddda0502022-12-01 19:43:12 +08002865 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if (ssl->session_negotiate != NULL) {
2867 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2868 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002869 max_len = read_mfl;
2870 }
2871 }
2872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002874}
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002877{
2878 size_t max_len;
2879
2880 /*
2881 * Assume mfl_code is correct since it was checked when set
2882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002884
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002885 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 if (ssl->session_out != NULL &&
2887 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2888 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002889 }
2890
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002891 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (ssl->session_negotiate != NULL &&
2893 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2894 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002895 }
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002898}
2899#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2900
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002901#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002902size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002903{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002904 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2906 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2907 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2908 return 0;
2909 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2912 return ssl->mtu;
2913 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (ssl->mtu == 0) {
2916 return ssl->handshake->mtu;
2917 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002918
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 return ssl->mtu < ssl->handshake->mtu ?
2920 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002921}
2922#endif /* MBEDTLS_SSL_PROTO_DTLS */
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002925{
2926 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2927
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002928#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002929 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002930 !defined(MBEDTLS_SSL_PROTO_DTLS)
2931 (void) ssl;
2932#endif
2933
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002934#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002938 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002940#endif
2941
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002942#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2943 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2944
2945 if (max_len > record_size_limit) {
2946 max_len = record_size_limit;
2947 }
2948#endif
2949
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002950 if (ssl->transform_out != NULL &&
2951 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002952 /*
2953 * In TLS 1.3 case, when records are protected, `max_len` as computed
2954 * above is the maximum length of the TLSInnerPlaintext structure that
2955 * along the plaintext payload contains the inner content type (one byte)
2956 * and some zero padding. Given the algorithm used for padding
2957 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2958 * the plaintext payload. Round down to a multiple of
2959 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2960 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002961 */
2962 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2963 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2964 }
2965
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002966#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2968 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2969 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002970 const size_t overhead = (size_t) ret;
2971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 if (ret < 0) {
2973 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002974 }
2975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mtu <= overhead) {
2977 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2978 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2979 }
2980
2981 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002982 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002984 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002985#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002986
Hanno Becker0defedb2018-08-10 12:35:02 +01002987#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002988 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2989 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002990 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002991#endif
2992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002994}
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002997{
2998 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2999
3000#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3001 (void) ssl;
3002#endif
3003
3004#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003006
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003008 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003010#endif
3011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003013}
3014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003016const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003017{
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 if (ssl == NULL || ssl->session == NULL) {
3019 return NULL;
3020 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003021
Hanno Beckere6824572019-02-07 13:18:46 +00003022#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003024#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003026#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003027}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003031int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3032 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003033{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003034 int ret;
3035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003037 dst == NULL ||
3038 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003041 }
3042
Hanno Beckere810bbc2021-05-14 16:01:05 +01003043 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3044 * idempotent: Each session can only be exported once.
3045 *
3046 * (This is in preparation for TLS 1.3 support where we will
3047 * need the ability to export multiple sessions (aka tickets),
3048 * which will be achieved by calling mbedtls_ssl_get_session()
3049 * multiple times until it fails.)
3050 *
3051 * Check whether we have already exported the current session,
3052 * and fail if so.
3053 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (ssl->session->exported == 1) {
3055 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3056 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3059 if (ret != 0) {
3060 return ret;
3061 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003062
3063 /* Remember that we've exported the session. */
3064 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003066}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003068
David Horstmanncb01b362024-02-29 17:31:46 +00003069#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3070
3071/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003072 *
David Horstmanncb01b362024-02-29 17:31:46 +00003073 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003074 */
3075static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3076 unsigned char *buf,
3077 size_t buf_len)
3078{
3079 unsigned char *p = buf;
3080 size_t used = 0;
3081
3082#if defined(MBEDTLS_HAVE_TIME)
3083 uint64_t start;
3084#endif
3085#if defined(MBEDTLS_X509_CRT_PARSE_C)
3086#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3087 size_t cert_len;
3088#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3089#endif /* MBEDTLS_X509_CRT_PARSE_C */
3090
3091 /*
3092 * Time
3093 */
3094#if defined(MBEDTLS_HAVE_TIME)
3095 used += 8;
3096
3097 if (used <= buf_len) {
3098 start = (uint64_t) session->start;
3099
3100 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3101 p += 8;
3102 }
3103#endif /* MBEDTLS_HAVE_TIME */
3104
3105 /*
3106 * Basic mandatory fields
3107 */
3108 used += 1 /* id_len */
3109 + sizeof(session->id)
3110 + sizeof(session->master)
3111 + 4; /* verify_result */
3112
3113 if (used <= buf_len) {
3114 *p++ = MBEDTLS_BYTE_0(session->id_len);
3115 memcpy(p, session->id, 32);
3116 p += 32;
3117
3118 memcpy(p, session->master, 48);
3119 p += 48;
3120
3121 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3122 p += 4;
3123 }
3124
3125 /*
3126 * Peer's end-entity certificate
3127 */
3128#if defined(MBEDTLS_X509_CRT_PARSE_C)
3129#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3130 if (session->peer_cert == NULL) {
3131 cert_len = 0;
3132 } else {
3133 cert_len = session->peer_cert->raw.len;
3134 }
3135
3136 used += 3 + cert_len;
3137
3138 if (used <= buf_len) {
3139 *p++ = MBEDTLS_BYTE_2(cert_len);
3140 *p++ = MBEDTLS_BYTE_1(cert_len);
3141 *p++ = MBEDTLS_BYTE_0(cert_len);
3142
3143 if (session->peer_cert != NULL) {
3144 memcpy(p, session->peer_cert->raw.p, cert_len);
3145 p += cert_len;
3146 }
3147 }
3148#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3149 if (session->peer_cert_digest != NULL) {
3150 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3151 if (used <= buf_len) {
3152 *p++ = (unsigned char) session->peer_cert_digest_type;
3153 *p++ = (unsigned char) session->peer_cert_digest_len;
3154 memcpy(p, session->peer_cert_digest,
3155 session->peer_cert_digest_len);
3156 p += session->peer_cert_digest_len;
3157 }
3158 } else {
3159 used += 2;
3160 if (used <= buf_len) {
3161 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3162 *p++ = 0;
3163 }
3164 }
3165#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3166#endif /* MBEDTLS_X509_CRT_PARSE_C */
3167
3168 /*
3169 * Session ticket if any, plus associated data
3170 */
3171#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3172#if defined(MBEDTLS_SSL_CLI_C)
3173 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3174 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3175
3176 if (used <= buf_len) {
3177 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3178 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3179 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3180
3181 if (session->ticket != NULL) {
3182 memcpy(p, session->ticket, session->ticket_len);
3183 p += session->ticket_len;
3184 }
3185
3186 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3187 p += 4;
3188 }
3189 }
3190#endif /* MBEDTLS_SSL_CLI_C */
3191#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3192 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3193 used += 8;
3194
3195 if (used <= buf_len) {
3196 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3197 p += 8;
3198 }
3199 }
3200#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3201#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3202
3203 /*
3204 * Misc extension-related info
3205 */
3206#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3207 used += 1;
3208
3209 if (used <= buf_len) {
3210 *p++ = session->mfl_code;
3211 }
3212#endif
3213
3214#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3215 used += 1;
3216
3217 if (used <= buf_len) {
3218 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3219 }
3220#endif
3221
3222 return used;
3223}
3224
3225MBEDTLS_CHECK_RETURN_CRITICAL
3226static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3227 const unsigned char *buf,
3228 size_t len)
3229{
3230#if defined(MBEDTLS_HAVE_TIME)
3231 uint64_t start;
3232#endif
3233#if defined(MBEDTLS_X509_CRT_PARSE_C)
3234#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3235 size_t cert_len;
3236#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3237#endif /* MBEDTLS_X509_CRT_PARSE_C */
3238
3239 const unsigned char *p = buf;
3240 const unsigned char * const end = buf + len;
3241
3242 /*
3243 * Time
3244 */
3245#if defined(MBEDTLS_HAVE_TIME)
3246 if (8 > (size_t) (end - p)) {
3247 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3248 }
3249
3250 start = MBEDTLS_GET_UINT64_BE(p, 0);
3251 p += 8;
3252
3253 session->start = (time_t) start;
3254#endif /* MBEDTLS_HAVE_TIME */
3255
3256 /*
3257 * Basic mandatory fields
3258 */
3259 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3260 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3261 }
3262
3263 session->id_len = *p++;
3264 memcpy(session->id, p, 32);
3265 p += 32;
3266
3267 memcpy(session->master, p, 48);
3268 p += 48;
3269
3270 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3271 p += 4;
3272
3273 /* Immediately clear invalid pointer values that have been read, in case
3274 * we exit early before we replaced them with valid ones. */
3275#if defined(MBEDTLS_X509_CRT_PARSE_C)
3276#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3277 session->peer_cert = NULL;
3278#else
3279 session->peer_cert_digest = NULL;
3280#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3281#endif /* MBEDTLS_X509_CRT_PARSE_C */
3282#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3283 session->ticket = NULL;
3284#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3285
3286 /*
3287 * Peer certificate
3288 */
3289#if defined(MBEDTLS_X509_CRT_PARSE_C)
3290#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3291 /* Deserialize CRT from the end of the ticket. */
3292 if (3 > (size_t) (end - p)) {
3293 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3294 }
3295
3296 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3297 p += 3;
3298
3299 if (cert_len != 0) {
3300 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3301
3302 if (cert_len > (size_t) (end - p)) {
3303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3304 }
3305
3306 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3307
3308 if (session->peer_cert == NULL) {
3309 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3310 }
3311
3312 mbedtls_x509_crt_init(session->peer_cert);
3313
3314 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3315 p, cert_len)) != 0) {
3316 mbedtls_x509_crt_free(session->peer_cert);
3317 mbedtls_free(session->peer_cert);
3318 session->peer_cert = NULL;
3319 return ret;
3320 }
3321
3322 p += cert_len;
3323 }
3324#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3325 /* Deserialize CRT digest from the end of the ticket. */
3326 if (2 > (size_t) (end - p)) {
3327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3328 }
3329
3330 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3331 session->peer_cert_digest_len = (size_t) *p++;
3332
3333 if (session->peer_cert_digest_len != 0) {
3334 const mbedtls_md_info_t *md_info =
3335 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3336 if (md_info == NULL) {
3337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3338 }
3339 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3341 }
3342
3343 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3344 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3345 }
3346
3347 session->peer_cert_digest =
3348 mbedtls_calloc(1, session->peer_cert_digest_len);
3349 if (session->peer_cert_digest == NULL) {
3350 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3351 }
3352
3353 memcpy(session->peer_cert_digest, p,
3354 session->peer_cert_digest_len);
3355 p += session->peer_cert_digest_len;
3356 }
3357#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3358#endif /* MBEDTLS_X509_CRT_PARSE_C */
3359
3360 /*
3361 * Session ticket and associated data
3362 */
3363#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3364#if defined(MBEDTLS_SSL_CLI_C)
3365 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3366 if (3 > (size_t) (end - p)) {
3367 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3368 }
3369
3370 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3371 p += 3;
3372
3373 if (session->ticket_len != 0) {
3374 if (session->ticket_len > (size_t) (end - p)) {
3375 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3376 }
3377
3378 session->ticket = mbedtls_calloc(1, session->ticket_len);
3379 if (session->ticket == NULL) {
3380 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3381 }
3382
3383 memcpy(session->ticket, p, session->ticket_len);
3384 p += session->ticket_len;
3385 }
3386
3387 if (4 > (size_t) (end - p)) {
3388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3389 }
3390
3391 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3392 p += 4;
3393 }
3394#endif /* MBEDTLS_SSL_CLI_C */
3395#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3396 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3397 if (8 > (size_t) (end - p)) {
3398 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3399 }
3400 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3401 p += 8;
3402 }
3403#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3404#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3405
3406 /*
3407 * Misc extension-related info
3408 */
3409#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3410 if (1 > (size_t) (end - p)) {
3411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3412 }
3413
3414 session->mfl_code = *p++;
3415#endif
3416
3417#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3418 if (1 > (size_t) (end - p)) {
3419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3420 }
3421
3422 session->encrypt_then_mac = *p++;
3423#endif
3424
3425 /* Done, should have consumed entire buffer */
3426 if (p != end) {
3427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3428 }
3429
3430 return 0;
3431}
3432
3433#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3434
3435#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3436/* Serialization of TLS 1.3 sessions:
3437 *
David Horstmanncb01b362024-02-29 17:31:46 +00003438 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003439 */
3440#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3441MBEDTLS_CHECK_RETURN_CRITICAL
3442static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3443 unsigned char *buf,
3444 size_t buf_len,
3445 size_t *olen)
3446{
3447 unsigned char *p = buf;
3448#if defined(MBEDTLS_SSL_CLI_C) && \
3449 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3450 size_t hostname_len = (session->hostname == NULL) ?
3451 0 : strlen(session->hostname) + 1;
3452#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003453
3454#if defined(MBEDTLS_SSL_SRV_C) && \
3455 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003456 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003457 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003458#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003459 size_t needed = 4 /* ticket_age_add */
3460 + 1 /* ticket_flags */
3461 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003462
David Horstmanne59f9702024-02-29 16:08:57 +00003463 *olen = 0;
3464
3465 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3466 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3467 }
3468 needed += session->resumption_key_len; /* resumption_key */
3469
3470#if defined(MBEDTLS_SSL_EARLY_DATA)
3471 needed += 4; /* max_early_data_size */
3472#endif
3473#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3474 needed += 2; /* record_size_limit */
3475#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3476
3477#if defined(MBEDTLS_HAVE_TIME)
3478 needed += 8; /* ticket_creation_time or ticket_reception_time */
3479#endif
3480
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003481#if defined(MBEDTLS_SSL_SRV_C)
3482 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3483#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003484 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003485 + alpn_len; /* alpn */
3486#endif
3487 }
3488#endif /* MBEDTLS_SSL_SRV_C */
3489
David Horstmanne59f9702024-02-29 16:08:57 +00003490#if defined(MBEDTLS_SSL_CLI_C)
3491 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3492#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3493 needed += 2 /* hostname_len */
3494 + hostname_len; /* hostname */
3495#endif
3496
3497 needed += 4 /* ticket_lifetime */
3498 + 2; /* ticket_len */
3499
3500 /* Check size_t overflow */
3501 if (session->ticket_len > SIZE_MAX - needed) {
3502 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3503 }
3504
3505 needed += session->ticket_len; /* ticket */
3506 }
3507#endif /* MBEDTLS_SSL_CLI_C */
3508
3509 *olen = needed;
3510 if (needed > buf_len) {
3511 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3512 }
3513
3514 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3515 p[4] = session->ticket_flags;
3516
3517 /* save resumption_key */
3518 p[5] = session->resumption_key_len;
3519 p += 6;
3520 memcpy(p, session->resumption_key, session->resumption_key_len);
3521 p += session->resumption_key_len;
3522
3523#if defined(MBEDTLS_SSL_EARLY_DATA)
3524 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3525 p += 4;
3526#endif
3527#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3528 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3529 p += 2;
3530#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3531
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003532#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003533 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003534#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003535 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3536 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003537#endif /* MBEDTLS_HAVE_TIME */
3538
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003539#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003540 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3541 p += 2;
3542
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003543 if (alpn_len > 0) {
3544 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003545 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003546 p += alpn_len;
3547 }
3548#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3549 }
3550#endif /* MBEDTLS_SSL_SRV_C */
3551
David Horstmanne59f9702024-02-29 16:08:57 +00003552#if defined(MBEDTLS_SSL_CLI_C)
3553 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3554#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3555 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3556 p += 2;
3557 if (hostname_len > 0) {
3558 /* save host name */
3559 memcpy(p, session->hostname, hostname_len);
3560 p += hostname_len;
3561 }
3562#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3563
3564#if defined(MBEDTLS_HAVE_TIME)
3565 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3566 p += 8;
3567#endif
3568 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3569 p += 4;
3570
3571 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3572 p += 2;
3573
3574 if (session->ticket != NULL && session->ticket_len > 0) {
3575 memcpy(p, session->ticket, session->ticket_len);
3576 p += session->ticket_len;
3577 }
3578 }
3579#endif /* MBEDTLS_SSL_CLI_C */
3580 return 0;
3581}
3582
3583MBEDTLS_CHECK_RETURN_CRITICAL
3584static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3585 const unsigned char *buf,
3586 size_t len)
3587{
3588 const unsigned char *p = buf;
3589 const unsigned char *end = buf + len;
3590
3591 if (end - p < 6) {
3592 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3593 }
3594 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3595 session->ticket_flags = p[4];
3596
3597 /* load resumption_key */
3598 session->resumption_key_len = p[5];
3599 p += 6;
3600
3601 if (end - p < session->resumption_key_len) {
3602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3603 }
3604
3605 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3607 }
3608 memcpy(session->resumption_key, p, session->resumption_key_len);
3609 p += session->resumption_key_len;
3610
3611#if defined(MBEDTLS_SSL_EARLY_DATA)
3612 if (end - p < 4) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3614 }
3615 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3616 p += 4;
3617#endif
3618#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3619 if (end - p < 2) {
3620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3621 }
3622 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3623 p += 2;
3624#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3625
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003626#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003627 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003628#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003629 if (end - p < 8) {
3630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3631 }
3632 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3633 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003634#endif /* MBEDTLS_HAVE_TIME */
3635
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003636#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003637 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003638
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003639 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003642
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003643 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3644 p += 2;
3645
3646 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3648 }
3649
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003650 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003651 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3652 if (ret != 0) {
3653 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003654 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003655 p += alpn_len;
3656 }
3657#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3658 }
3659#endif /* MBEDTLS_SSL_SRV_C */
3660
David Horstmanne59f9702024-02-29 16:08:57 +00003661#if defined(MBEDTLS_SSL_CLI_C)
3662 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3663#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3664 size_t hostname_len;
3665 /* load host name */
3666 if (end - p < 2) {
3667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3668 }
3669 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3670 p += 2;
3671
3672 if (end - p < (long int) hostname_len) {
3673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3674 }
3675 if (hostname_len > 0) {
3676 session->hostname = mbedtls_calloc(1, hostname_len);
3677 if (session->hostname == NULL) {
3678 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3679 }
3680 memcpy(session->hostname, p, hostname_len);
3681 p += hostname_len;
3682 }
3683#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3684
3685#if defined(MBEDTLS_HAVE_TIME)
3686 if (end - p < 8) {
3687 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3688 }
3689 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3690 p += 8;
3691#endif
3692 if (end - p < 4) {
3693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694 }
3695 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3696 p += 4;
3697
3698 if (end - p < 2) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3702 p += 2;
3703
3704 if (end - p < (long int) session->ticket_len) {
3705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3706 }
3707 if (session->ticket_len > 0) {
3708 session->ticket = mbedtls_calloc(1, session->ticket_len);
3709 if (session->ticket == NULL) {
3710 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3711 }
3712 memcpy(session->ticket, p, session->ticket_len);
3713 p += session->ticket_len;
3714 }
3715 }
3716#endif /* MBEDTLS_SSL_CLI_C */
3717
3718 return 0;
3719
3720}
3721#else /* MBEDTLS_SSL_SESSION_TICKETS */
3722MBEDTLS_CHECK_RETURN_CRITICAL
3723static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3724 unsigned char *buf,
3725 size_t buf_len,
3726 size_t *olen)
3727{
3728 ((void) session);
3729 ((void) buf);
3730 ((void) buf_len);
3731 *olen = 0;
3732 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3733}
3734
3735static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003736 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003737 size_t buf_len)
3738{
3739 ((void) session);
3740 ((void) buf);
3741 ((void) buf_len);
3742 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3743}
3744#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3745#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3746
Paul Bakker5121ce52009-01-03 21:22:43 +00003747/*
Hanno Beckera835da52019-05-16 12:39:07 +01003748 * Define ticket header determining Mbed TLS version
3749 * and structure of the ticket.
3750 */
3751
Hanno Becker94ef3b32019-05-16 12:50:45 +01003752/*
Hanno Becker50b59662019-05-28 14:30:45 +01003753 * Define bitflag determining compile-time settings influencing
3754 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003755 */
3756
Hanno Becker50b59662019-05-28 14:30:45 +01003757#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003758#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003759#else
Hanno Becker3e088662019-05-29 11:10:18 +01003760#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003761#endif /* MBEDTLS_HAVE_TIME */
3762
3763#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003764#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003765#else
Hanno Becker3e088662019-05-29 11:10:18 +01003766#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003767#endif /* MBEDTLS_X509_CRT_PARSE_C */
3768
David Horstmann5c5a32f2024-02-13 17:53:35 +00003769#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003770#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003771#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003772#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003773#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3774
Hanno Becker94ef3b32019-05-16 12:50:45 +01003775#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003776#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003777#else
Hanno Becker3e088662019-05-29 11:10:18 +01003778#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003779#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3780
3781#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003782#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003783#else
Hanno Becker3e088662019-05-29 11:10:18 +01003784#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003785#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3786
Hanno Becker94ef3b32019-05-16 12:50:45 +01003787#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003788#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003789#else
Hanno Becker3e088662019-05-29 11:10:18 +01003790#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3792
Hanno Becker94ef3b32019-05-16 12:50:45 +01003793#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3794#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3795#else
3796#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3797#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3798
David Horstmann92b258b2024-02-13 17:23:34 +00003799#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3800#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3801#else
3802#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3803#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3804
3805#if defined(MBEDTLS_SSL_EARLY_DATA)
3806#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3807#else
3808#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3809#endif /* MBEDTLS_SSL_EARLY_DATA */
3810
3811#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3812#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3813#else
3814#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3815#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3816
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003817#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3818 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003819#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3820#else
3821#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3822#endif /* MBEDTLS_SSL_ALPN */
3823
Hanno Becker3e088662019-05-29 11:10:18 +01003824#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3825#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3826#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3827#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003828#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3829#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003830#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003831#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3832#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3833#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003834#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003835
Hanno Becker50b59662019-05-28 14:30:45 +01003836#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 ((uint16_t) ( \
3838 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3839 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3840 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3841 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3842 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3843 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003844 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003845 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3846 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003847 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3848 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3849 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3850 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003851 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003852 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003853 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003854
Chien Wong4e9683e2023-12-28 17:07:43 +08003855static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003856 MBEDTLS_VERSION_MAJOR,
3857 MBEDTLS_VERSION_MINOR,
3858 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003859 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3860 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003861};
Hanno Beckera835da52019-05-16 12:39:07 +01003862
3863/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003864 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003865 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003866 *
David Horstmanncb01b362024-02-29 17:31:46 +00003867 * TLS 1.2 session:
3868 *
3869 * struct {
3870 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3871 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3872 * uint32 ticket_lifetime;
3873 * #endif
3874 * } ClientOnlyData;
3875 *
3876 * struct {
3877 * #if defined(MBEDTLS_HAVE_TIME)
3878 * uint64 start_time;
3879 * #endif
3880 * uint8 session_id_len; // at most 32
3881 * opaque session_id[32];
3882 * opaque master[48]; // fixed length in the standard
3883 * uint32 verify_result;
3884 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3885 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3886 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003887 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003888 * opaque peer_cert_digest<0..2^8-1>
3889 * #endif
3890 * select (endpoint) {
3891 * case client: ClientOnlyData;
3892 * case server: uint64 ticket_creation_time;
3893 * };
3894 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3895 * uint8 mfl_code; // up to 255 according to standard
3896 * #endif
3897 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3898 * uint8 encrypt_then_mac; // 0 or 1
3899 * #endif
3900 * } serialized_session_tls12;
3901 *
3902 *
3903 * TLS 1.3 Session:
3904 *
3905 * struct {
3906 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3907 * opaque hostname<0..2^16-1>;
3908 * #endif
3909 * #if defined(MBEDTLS_HAVE_TIME)
3910 * uint64 ticket_reception_time;
3911 * #endif
3912 * uint32 ticket_lifetime;
3913 * opaque ticket<1..2^16-1>;
3914 * } ClientOnlyData;
3915 *
3916 * struct {
3917 * uint32 ticket_age_add;
3918 * uint8 ticket_flags;
3919 * opaque resumption_key<0..255>;
3920 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3921 * uint32 max_early_data_size;
3922 * #endif
3923 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3924 * uint16 record_size_limit;
3925 * #endif
3926 * select ( endpoint ) {
3927 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003928 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003929 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003930 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003931 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003932 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003933 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003934 * #endif
3935 * };
3936 * } serialized_session_tls13;
3937 *
3938 *
3939 * SSL session:
3940 *
3941 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003942 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003943 * opaque mbedtls_version[3]; // library version: major, minor, patch
3944 * opaque session_format[2]; // library-version specific 16-bit field
3945 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003946 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003947 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003948 * Note: When updating the format, remember to keep
3949 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003950 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003951 * // In this version, `session_format` determines
3952 * // the setting of those compile-time
3953 * // configuration options which influence
3954 * // the structure of mbedtls_ssl_session.
3955 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003956 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003957 * // - TLS 1.2 (0x0303)
3958 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003959 * uint8_t endpoint;
3960 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003961 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003962 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003963 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003964 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003965 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003966 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003967 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003968 *
3969 * };
3970 *
3971 * } serialized_session;
3972 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003973 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003974
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003975MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003976static int ssl_session_save(const mbedtls_ssl_session *session,
3977 unsigned char omit_header,
3978 unsigned char *buf,
3979 size_t buf_len,
3980 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003981{
3982 unsigned char *p = buf;
3983 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003984 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003985#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3986 size_t out_len;
3987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3988#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 if (session == NULL) {
3990 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3991 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003992
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003994 /*
3995 * Add Mbed TLS version identifier
3996 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 if (used <= buf_len) {
4000 memcpy(p, ssl_serialized_session_header,
4001 sizeof(ssl_serialized_session_header));
4002 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004003 }
4004 }
4005
4006 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004007 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004008 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004009 used += 1 /* TLS version */
4010 + 1 /* endpoint */
4011 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004012 if (used <= buf_len) {
4013 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004014 *p++ = session->endpoint;
4015 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4016 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004017 }
4018
4019 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004020 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004022#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 case MBEDTLS_SSL_VERSION_TLS1_2:
4024 used += ssl_tls12_session_save(session, p, remaining_len);
4025 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004026#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4027
Jerry Yu251a12e2022-07-13 15:15:48 +08004028#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 case MBEDTLS_SSL_VERSION_TLS1_3:
4030 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4031 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4032 return ret;
4033 }
4034 used += out_len;
4035 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004036#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4037
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 default:
4039 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004040 }
4041
4042 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (used > buf_len) {
4044 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4045 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004048}
4049
4050/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004051 * Public wrapper for ssl_session_save()
4052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004053int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4054 unsigned char *buf,
4055 size_t buf_len,
4056 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004057{
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004059}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004060
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004061/*
4062 * Deserialize session, see mbedtls_ssl_session_save() for format.
4063 *
4064 * This internal version is wrapped by a public function that cleans up in
4065 * case of error, and has an extra option omit_header.
4066 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004067MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004068static int ssl_session_load(mbedtls_ssl_session *session,
4069 unsigned char omit_header,
4070 const unsigned char *buf,
4071 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004072{
4073 const unsigned char *p = buf;
4074 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004075 size_t remaining_len;
4076
4077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 if (session == NULL) {
4079 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4080 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004083 /*
4084 * Check Mbed TLS version identifier
4085 */
4086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004089 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004090
4091 if (memcmp(p, ssl_serialized_session_header,
4092 sizeof(ssl_serialized_session_header)) != 0) {
4093 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4094 }
4095 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004096 }
4097
4098 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004099 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004100 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004101 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4103 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004104 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004105 session->endpoint = *p++;
4106 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4107 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004108
4109 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004110 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004112#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 case MBEDTLS_SSL_VERSION_TLS1_2:
4114 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004115#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4116
Jerry Yu438ddd82022-07-07 06:55:50 +00004117#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 case MBEDTLS_SSL_VERSION_TLS1_3:
4119 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004120#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 default:
4123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004124 }
4125}
4126
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004127/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004128 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004129 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004130int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4131 const unsigned char *buf,
4132 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004133{
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004135
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (ret != 0) {
4137 mbedtls_ssl_session_free(session);
4138 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004141}
4142
4143/*
Paul Bakker1961b702013-01-25 14:49:24 +01004144 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004145 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004147static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004148{
4149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4150
Ronald Cron66dbf912022-02-02 15:33:46 +01004151 /*
4152 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004153 * that were written into the output buffer by the previous handshake step,
4154 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004155 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4156 * We proceed to the next handshake step only when all data from the
4157 * previous one have been sent to the peer, thus we make sure that this is
4158 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4159 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4160 * we have to wait before to go ahead.
4161 * In the case of TLS 1.3, handshake step handlers do not send data to the
4162 * peer. Data are only sent here and through
4163 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004164 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004165 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4167 return ret;
4168 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004169
4170#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4172 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4173 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4174 return ret;
4175 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004176 }
4177#endif /* MBEDTLS_SSL_PROTO_DTLS */
4178
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004180}
4181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004183{
Hanno Becker41934dd2021-08-07 19:13:43 +01004184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004187 ssl->conf == NULL ||
4188 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4190 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004191 }
4192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 ret = ssl_prepare_handshake_step(ssl);
4194 if (ret != 0) {
4195 return ret;
4196 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 ret = mbedtls_ssl_handle_pending_alert(ssl);
4199 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004200 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 }
Jerry Yue7047812021-09-13 19:26:39 +08004202
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004203 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4204 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4205 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004207#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4209 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004210 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004213 case MBEDTLS_SSL_HELLO_REQUEST:
4214 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004215 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004216 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004217
Ronald Cron9f0fba32022-02-10 16:45:15 +01004218 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004220 break;
4221
4222 default:
4223#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4225 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4226 } else {
4227 ret = mbedtls_ssl_handshake_client_step(ssl);
4228 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004229#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004230 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004231#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004233#endif
4234 }
Jerry Yub9930e72021-08-06 17:11:51 +08004235 }
Ronald Cron6291b232023-03-08 15:51:25 +01004236#endif /* MBEDTLS_SSL_CLI_C */
4237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004238#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004240#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4241 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004243 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 ret = mbedtls_ssl_handshake_server_step(ssl);
4245 }
Ronald Cron6291b232023-03-08 15:51:25 +01004246#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4247 ret = mbedtls_ssl_handshake_server_step(ssl);
4248#else
4249 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004250#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004251 }
4252#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004255 /* handshake_step return error. And it is same
4256 * with alert_reason.
4257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 if (ssl->send_alert) {
4259 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004260 goto cleanup;
4261 }
4262 }
4263
4264cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004266}
4267
4268/*
4269 * Perform the SSL handshake
4270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004271int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004272{
4273 int ret = 0;
4274
Hanno Beckera817ea42020-10-20 15:20:23 +01004275 /* Sanity checks */
4276
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 if (ssl == NULL || ssl->conf == NULL) {
4278 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4279 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004280
Hanno Beckera817ea42020-10-20 15:20:23 +01004281#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4283 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4284 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4285 "mbedtls_ssl_set_timer_cb() for DTLS"));
4286 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004287 }
4288#endif /* MBEDTLS_SSL_PROTO_DTLS */
4289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004291
Hanno Beckera817ea42020-10-20 15:20:23 +01004292 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004293 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4294 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004297 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 }
Paul Bakker1961b702013-01-25 14:49:24 +01004299 }
4300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004304}
4305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004306#if defined(MBEDTLS_SSL_RENEGOTIATION)
4307#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004308/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004309 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004310 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004311MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004312static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004313{
Janos Follath865b3eb2019-12-16 11:46:15 +00004314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004317
4318 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004319 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4320 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4323 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4324 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004325 }
4326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004330}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004331#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004332
4333/*
4334 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004335 * - any side: calling mbedtls_ssl_renegotiate(),
4336 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4337 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004338 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004339 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004340 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004341 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004342int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004343{
Janos Follath865b3eb2019-12-16 11:46:15 +00004344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 if ((ret = ssl_handshake_init(ssl)) != 0) {
4349 return ret;
4350 }
Paul Bakker48916f92012-09-16 19:57:18 +00004351
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004352 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4353 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004354#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4356 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4357 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004358 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004360 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004361 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004362 }
4363#endif
4364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004365 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4366 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004367
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4369 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4370 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004371 }
4372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004376}
4377
4378/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004379 * Renegotiate current connection on client,
4380 * or request renegotiation on server
4381 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004382int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004383{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 if (ssl == NULL || ssl->conf == NULL) {
4387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4388 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004391 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4393 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4395 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004396
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004397 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004398
4399 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (ssl->out_left != 0) {
4401 return mbedtls_ssl_flush_output(ssl);
4402 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004405 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004406#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004409 /*
4410 * On client, either start the renegotiation process or,
4411 * if already in progress, continue the handshake
4412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4414 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004416 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004417
4418 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4419 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4420 return ret;
4421 }
4422 } else {
4423 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4424 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4425 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004426 }
4427 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004428#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004431}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004433
Gilles Peskine449bd832023-01-11 14:50:10 +01004434void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004435{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004436 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004439 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004441
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004442#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004443#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (ssl->handshake->group_list_heap_allocated) {
4445 mbedtls_free((void *) handshake->group_list);
4446 }
Brett Warrene0edc842021-08-17 09:53:13 +01004447 handshake->group_list = NULL;
4448#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004449#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004450
Ronald Crone68ab4f2022-10-05 12:46:29 +02004451#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004452#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (ssl->handshake->sig_algs_heap_allocated) {
4454 mbedtls_free((void *) handshake->sig_algs);
4455 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004456 handshake->sig_algs = NULL;
4457#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004458#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (ssl->handshake->certificate_request_context) {
4460 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004461 }
4462#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004463#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004464
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004465#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004466 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004467 ssl->conf->f_async_cancel(ssl);
4468 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004469 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004470
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004471#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4472
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004473#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004475#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004476#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004478#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004479
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004480#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004482 /*
4483 * Opaque keys are not stored in the handshake's data and it's the user
4484 * responsibility to destroy them. Clear ones, instead, are created by
4485 * the TLS library and should be destroyed at the same level
4486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4488 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004489 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004490 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004491#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004493 handshake->ecjpake_cache = NULL;
4494 handshake->ecjpake_cache_len = 0;
4495#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004496#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004497
Valerio Setti7aeec542023-07-05 18:57:21 +02004498#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004499 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004500 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004501 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004503#endif
4504
Ronald Cron73fe8df2022-10-05 14:31:43 +02004505#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004507 /* The maintenance of the external PSK key slot is the
4508 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (ssl->handshake->psk_opaque_is_internal) {
4510 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004511 ssl->handshake->psk_opaque_is_internal = 0;
4512 }
4513 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4514 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004515#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4518 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004519 /*
4520 * Free only the linked list wrapper, not the keys themselves
4521 * since the belong to the SNI callback
4522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004524#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004525
Gilles Peskineeccd8882020-03-10 12:19:08 +01004526#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4528 if (handshake->ecrs_peer_cert != NULL) {
4529 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4530 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004531 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004532#endif
4533
Hanno Becker75173122019-02-06 16:18:31 +00004534#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4535 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004537#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4538
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004539#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4541 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004542#endif /* MBEDTLS_SSL_CLI_C &&
4543 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004544
4545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 mbedtls_ssl_flight_free(handshake->flight);
4547 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004548#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004549
Valerio Settiea59c432023-07-25 11:14:03 +02004550#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004551 if (handshake->xxdh_psa_privkey_is_external == 0) {
4552 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 }
Valerio Settiea59c432023-07-25 11:14:03 +02004554#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004555
Ronald Cron6f135e12021-12-08 16:57:54 +01004556#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 mbedtls_ssl_transform_free(handshake->transform_handshake);
4558 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004559#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4561 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004562#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004563#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004564
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004565
4566#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4567 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4568 * processes datagrams and the fact that a datagram is allowed to have
4569 * several records in it, it is possible that the I/O buffers are not
4570 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4572 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004573#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004574
Jerry Yuba9c7272021-10-30 11:54:10 +08004575 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 mbedtls_platform_zeroize(handshake,
4577 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004578}
4579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004581{
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004583 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004586#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004588#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004589
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004590#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004591#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4592 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004594#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004596#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004597
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004598#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4599 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004600 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004601#endif
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004604}
4605
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004606#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004607
4608#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4609#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4610#else
4611#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4612#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4613
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004614#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004615
4616#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4617#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4618#else
4619#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4620#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4621
4622#if defined(MBEDTLS_SSL_ALPN)
4623#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4624#else
4625#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4626#endif /* MBEDTLS_SSL_ALPN */
4627
4628#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4629#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4630#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4631#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4632
4633#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 ((uint32_t) ( \
4635 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4636 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4637 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4638 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4639 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4640 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4641 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4642 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004643
Chien Wong4e9683e2023-12-28 17:07:43 +08004644static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004645 MBEDTLS_VERSION_MAJOR,
4646 MBEDTLS_VERSION_MINOR,
4647 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4649 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4650 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4651 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4652 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004653};
4654
Paul Bakker5121ce52009-01-03 21:22:43 +00004655/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004656 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004657 *
4658 * The format of the serialized data is:
4659 * (in the presentation language of TLS, RFC 8446 section 3)
4660 *
4661 * // header
4662 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004663 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004664 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004665 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004666 * Note: When updating the format, remember to keep these
4667 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004668 *
4669 * // session sub-structure
4670 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4671 * // transform sub-structure
4672 * uint8 random[64]; // ServerHello.random+ClientHello.random
4673 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4674 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4675 * // fields from ssl_context
4676 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4677 * uint64 in_window_top; // DTLS: last validated record seq_num
4678 * uint64 in_window; // DTLS: bitmask for replay protection
4679 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4680 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4681 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4682 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4683 *
4684 * Note that many fields of the ssl_context or sub-structures are not
4685 * serialized, as they fall in one of the following categories:
4686 *
4687 * 1. forced value (eg in_left must be 0)
4688 * 2. pointer to dynamically-allocated memory (eg session, transform)
4689 * 3. value can be re-derived from other data (eg session keys from MS)
4690 * 4. value was temporary (eg content of input buffer)
4691 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004692 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004693int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4694 unsigned char *buf,
4695 size_t buf_len,
4696 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004697{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004698 unsigned char *p = buf;
4699 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004700 size_t session_len;
4701 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004702
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004703 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004704 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4705 * this function's documentation.
4706 *
4707 * These are due to assumptions/limitations in the implementation. Some of
4708 * them are likely to stay (no handshake in progress) some might go away
4709 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004710 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004711 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4713 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004715 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 if (ssl->handshake != NULL) {
4717 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004719 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004720 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if (ssl->transform == NULL || ssl->session == NULL) {
4722 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004724 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004725 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (mbedtls_ssl_check_pending(ssl) != 0) {
4727 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if (ssl->out_left != 0) {
4731 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004733 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004734 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4736 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004738 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004739 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4741 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004743 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004744 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4746 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004748 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004749 /* Renegotiation must not be enabled */
4750#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004754 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004755#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004756
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004757 /*
4758 * Version and format identifier
4759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (used <= buf_len) {
4763 memcpy(p, ssl_serialized_context_header,
4764 sizeof(ssl_serialized_context_header));
4765 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004766 }
4767
4768 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004769 * Session (length + data)
4770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4772 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4773 return ret;
4774 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004775
4776 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (used <= buf_len) {
4778 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004779 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 ret = ssl_session_save(ssl->session, 1,
4782 p, session_len, &session_len);
4783 if (ret != 0) {
4784 return ret;
4785 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004786
4787 p += session_len;
4788 }
4789
4790 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004791 * Transform
4792 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 used += sizeof(ssl->transform->randbytes);
4794 if (used <= buf_len) {
4795 memcpy(p, ssl->transform->randbytes,
4796 sizeof(ssl->transform->randbytes));
4797 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004798 }
4799
4800#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004801 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004803 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004805 p += ssl->transform->in_cid_len;
4806
4807 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004809 p += ssl->transform->out_cid_len;
4810 }
4811#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4812
4813 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004814 * Saved fields from top-level ssl_context structure
4815 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004816 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (used <= buf_len) {
4818 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004819 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004820 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004821
4822#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4823 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if (used <= buf_len) {
4825 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004826 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004829 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004830 }
4831#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4832
4833#if defined(MBEDTLS_SSL_PROTO_DTLS)
4834 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004836 *p++ = ssl->disable_datagram_packing;
4837 }
4838#endif /* MBEDTLS_SSL_PROTO_DTLS */
4839
Jerry Yuae0b2e22021-10-08 15:21:19 +08004840 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (used <= buf_len) {
4842 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004843 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004844 }
4845
4846#if defined(MBEDTLS_SSL_PROTO_DTLS)
4847 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (used <= buf_len) {
4849 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004850 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004851 }
4852#endif /* MBEDTLS_SSL_PROTO_DTLS */
4853
4854#if defined(MBEDTLS_SSL_ALPN)
4855 {
4856 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004858 : 0;
4859
4860 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004862 *p++ = alpn_len;
4863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (ssl->alpn_chosen != NULL) {
4865 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004866 p += alpn_len;
4867 }
4868 }
4869 }
4870#endif /* MBEDTLS_SSL_ALPN */
4871
4872 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004873 * Done
4874 */
4875 *olen = used;
4876
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (used > buf_len) {
4878 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4879 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004884}
4885
4886/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004887 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004888 *
4889 * This internal version is wrapped by a public function that cleans up in
4890 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004891 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004892MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004893static int ssl_context_load(mbedtls_ssl_context *ssl,
4894 const unsigned char *buf,
4895 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004896{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004897 const unsigned char *p = buf;
4898 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004899 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004901#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004902 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004903#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004904
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004905 /*
4906 * The context should have been freshly setup or reset.
4907 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004908 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004909 * renegotiating, or if the user mistakenly loaded a session first.)
4910 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4912 ssl->session != NULL) {
4913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004914 }
4915
4916 /*
4917 * We can't check that the config matches the initial one, but we can at
4918 * least check it matches the requirements for serializing.
4919 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004920 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004921#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004922 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004923#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004924 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4925 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4926 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4927 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004929 }
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004932
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004933 /*
4934 * Check version identifier
4935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4937 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004938 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004939
4940 if (memcmp(p, ssl_serialized_context_header,
4941 sizeof(ssl_serialized_context_header)) != 0) {
4942 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4943 }
4944 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004945
4946 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004947 * Session
4948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if ((size_t) (end - p) < 4) {
4950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4951 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004952
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004953 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004954 p += 4;
4955
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004956 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004957 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004958 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004959 ssl->session_in = ssl->session;
4960 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004961 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 if ((size_t) (end - p) < session_len) {
4964 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4965 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004966
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 ret = ssl_session_load(ssl->session, 1, p, session_len);
4968 if (ret != 0) {
4969 mbedtls_ssl_session_free(ssl->session);
4970 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004971 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004972
4973 p += session_len;
4974
4975 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004976 * Transform
4977 */
4978
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004979 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004980 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004981#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004982 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004983 ssl->transform_in = ssl->transform;
4984 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004985 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004986#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004987
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004988#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4990 if (prf_func == NULL) {
4991 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4992 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004993
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004994 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4996 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4997 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004998
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 ret = ssl_tls12_populate_transform(ssl->transform,
5000 ssl->session->ciphersuite,
5001 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005002#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005004#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 prf_func,
5006 p, /* currently pointing to randbytes */
5007 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5008 ssl->conf->endpoint,
5009 ssl);
5010 if (ret != 0) {
5011 return ret;
5012 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005013#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005015
5016#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5017 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 if ((size_t) (end - p) < 1) {
5019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5020 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005021
5022 ssl->transform->in_cid_len = *p++;
5023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5026 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005029 p += ssl->transform->in_cid_len;
5030
5031 ssl->transform->out_cid_len = *p++;
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5035 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005038 p += ssl->transform->out_cid_len;
5039#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5040
5041 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005042 * Saved fields from top-level ssl_context structure
5043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if ((size_t) (end - p) < 4) {
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5046 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005047
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005048 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005049 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005050
5051#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if ((size_t) (end - p) < 16) {
5053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5054 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005055
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005056 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005057 p += 8;
5058
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005059 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005060 p += 8;
5061#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5062
5063#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if ((size_t) (end - p) < 1) {
5065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5066 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005067
5068 ssl->disable_datagram_packing = *p++;
5069#endif /* MBEDTLS_SSL_PROTO_DTLS */
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5073 }
5074 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5075 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005076
5077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if ((size_t) (end - p) < 2) {
5079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5080 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005081
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005082 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005083 p += 2;
5084#endif /* MBEDTLS_SSL_PROTO_DTLS */
5085
5086#if defined(MBEDTLS_SSL_ALPN)
5087 {
5088 uint8_t alpn_len;
5089 const char **cur;
5090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if ((size_t) (end - p) < 1) {
5092 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5093 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005094
5095 alpn_len = *p++;
5096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005098 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5100 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005101 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005102 ssl->alpn_chosen = *cur;
5103 break;
5104 }
5105 }
5106 }
5107
5108 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5111 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005112
5113 p += alpn_len;
5114 }
5115#endif /* MBEDTLS_SSL_ALPN */
5116
5117 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005118 * Forced fields from top-level ssl_context structure
5119 *
5120 * Most of them already set to the correct value by mbedtls_ssl_init() and
5121 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5122 */
5123 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005124 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005125
Hanno Becker361b10d2019-08-30 10:42:49 +01005126 /* Adjust pointers for header fields of outgoing records to
5127 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005129
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005130#if defined(MBEDTLS_SSL_PROTO_DTLS)
5131 ssl->in_epoch = 1;
5132#endif
5133
5134 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5135 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005136 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5137 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 if (ssl->handshake != NULL) {
5139 mbedtls_ssl_handshake_free(ssl);
5140 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005141 ssl->handshake = NULL;
5142 }
5143
5144 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005145 * Done - should have consumed entire buffer
5146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (p != end) {
5148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5149 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005152}
5153
5154/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005155 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005157int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5158 const unsigned char *buf,
5159 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005160{
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (ret != 0) {
5164 mbedtls_ssl_free(context);
5165 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005168}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005169#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005170
5171/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005172 * Free an SSL context
5173 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005174void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005175{
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005177 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005183#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5184 size_t out_buf_len = ssl->out_buf_len;
5185#else
5186 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5187#endif
5188
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005189 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005190 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005191 }
5192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005194#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5195 size_t in_buf_len = ssl->in_buf_len;
5196#else
5197 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5198#endif
5199
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005200 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005201 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005202 }
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (ssl->transform) {
5205 mbedtls_ssl_transform_free(ssl->transform);
5206 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005207 }
5208
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 if (ssl->handshake) {
5210 mbedtls_ssl_handshake_free(ssl);
5211 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005212
5213#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5215 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005216#endif
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 mbedtls_ssl_session_free(ssl->session_negotiate);
5219 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005220 }
5221
Ronald Cron6f135e12021-12-08 16:57:54 +01005222#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 mbedtls_ssl_transform_free(ssl->transform_application);
5224 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005225#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 if (ssl->session) {
5228 mbedtls_ssl_session_free(ssl->session);
5229 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005230 }
5231
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005232#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005234 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005235 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005236#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005237
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005238#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005240#endif
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005243
Paul Bakker86f04f42013-02-14 11:20:09 +01005244 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005246}
5247
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005248/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005249 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005252{
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005254}
5255
Gilles Peskineae270bf2021-06-02 00:05:29 +02005256/* The selection should be the same as mbedtls_x509_crt_profile_default in
5257 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005258 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005259 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005260 * about this list.
5261 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005262static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005263#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005264 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005265#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005266#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005267 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005268#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005269#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005270 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005271#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005272#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005273 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005274#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005275#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005276 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005277#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005278#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005279 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005280#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005281#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005282 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005283#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005284#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005285 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005286#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005287#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005288 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5289 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5290 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5291 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5292 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5293#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005294 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005295};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005296
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005297static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005298 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5299 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5300 0
5301};
5302
Ronald Crone68ab4f2022-10-05 12:46:29 +02005303#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005304
Jerry Yu909df7b2022-01-22 11:56:27 +08005305/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005306 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005307 * rules SHOULD be upheld.
5308 * - No duplicate entries.
5309 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005310 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005311 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005312 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005313static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005314
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005315#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005316 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005317 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005318 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005319 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5320#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005321
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005322#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005323 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005324 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005325 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005326 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5327#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005328
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005329#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005330 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005331 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005332 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005333 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5334#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005335
Gabor Mezeic15ef932024-06-13 12:53:54 +02005336#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005337 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005338#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005339
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005340#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005341 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005342#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005343
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005344#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005345 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005346#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005347
Gabor Mezeic15ef932024-06-13 12:53:54 +02005348#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005349 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005350#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005351
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005352#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005353 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005354#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005355
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005356#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005357 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005358#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005359
Gabor Mezei15b95a62022-05-09 16:37:58 +02005360 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005361};
5362
5363/* NOTICE: see above */
5364#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5365static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005366
Gabor Mezeic15ef932024-06-13 12:53:54 +02005367#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005368#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005370#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005371#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5372 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005373#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005374#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005376#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005377#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005378
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005379#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005380#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005382#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005383#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5384 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005385#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005386#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005388#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005389#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005390
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005391#if defined(PSA_WANT_ALG_SHA_256)
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_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +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_SHA256,
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_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005400#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005401#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005402
Gabor Mezei15b95a62022-05-09 16:37:58 +02005403 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005404};
5405#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005406
Jerry Yu909df7b2022-01-22 11:56:27 +08005407/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005408static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005409
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005410#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005411 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005412 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005413 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005414 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5415#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005416
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005417#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005418 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005419 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005420 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005421 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5422#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005423
Gabor Mezei15b95a62022-05-09 16:37:58 +02005424 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005425};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005426
Jerry Yu909df7b2022-01-22 11:56:27 +08005427/* NOTICE: see above */
5428#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5429static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005430
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005431#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005432#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005434#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005435#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005436
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005437#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005438#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005440#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005441#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005442
Gabor Mezei15b95a62022-05-09 16:37:58 +02005443 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005444};
Jerry Yu909df7b2022-01-22 11:56:27 +08005445#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5446
Ronald Crone68ab4f2022-10-05 12:46:29 +02005447#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005448
Chien Wong4e9683e2023-12-28 17:07:43 +08005449static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005450#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005451 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005452#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005453#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005454 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005455#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005456 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005457};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005458
Ronald Crone68ab4f2022-10-05 12:46:29 +02005459#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005460/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005461 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005462MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005463static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005464{
5465 size_t i, j;
5466 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005467
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5469 for (j = 0; j < i; j++) {
5470 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005471 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 }
5473 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5474 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5475 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005476 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005477 }
5478 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005480}
5481
Ronald Crone68ab4f2022-10-05 12:46:29 +02005482#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005483
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005484/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005485 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005487int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5488 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005489{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005490#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5492 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5493 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005494 }
5495
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5497 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5498 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005499 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005500
5501#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5503 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5504 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005505 }
5506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5508 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5509 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005510 }
5511#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005512#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005513
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005514 /* Use the functions here so that they are covered in tests,
5515 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 mbedtls_ssl_conf_endpoint(conf, endpoint);
5517 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005518
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005519 /*
5520 * Things that are common to all presets
5521 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005522#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005524 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5525#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5526 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5527#endif
5528 }
5529#endif
5530
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005531#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5532 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5533#endif
5534
5535#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5536 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5537#endif
5538
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005539#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005540 conf->f_cookie_write = ssl_cookie_write_dummy;
5541 conf->f_cookie_check = ssl_cookie_check_dummy;
5542#endif
5543
5544#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5545 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5546#endif
5547
Janos Follath088ce432017-04-10 12:42:31 +01005548#if defined(MBEDTLS_SSL_SRV_C)
5549 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005550 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005551#endif
5552
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005553#if defined(MBEDTLS_SSL_PROTO_DTLS)
5554 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5555 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5556#endif
5557
5558#if defined(MBEDTLS_SSL_RENEGOTIATION)
5559 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 memset(conf->renego_period, 0x00, 2);
5561 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005562#endif
5563
Ronald Cron6f135e12021-12-08 16:57:54 +01005564#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005565
5566#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005567 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005568#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005569 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005570#endif
5571#endif /* MBEDTLS_SSL_EARLY_DATA */
5572
Jerry Yud0766ec2022-09-22 10:46:57 +08005573#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005574 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005576#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005577 /*
5578 * Allow all TLS 1.3 key exchange modes by default.
5579 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005580 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005581#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005582
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005584#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005585 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005586 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005587#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005589#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005591#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005592 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5593 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005594#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5595 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5596 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5597#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5598 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5599 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5600#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005602#endif
5603 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005604
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005605 /*
5606 * Preset-specific defaults
5607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005609 /*
5610 * NSA Suite B
5611 */
5612 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005613
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005614 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005615
5616#if defined(MBEDTLS_X509_CRT_PARSE_C)
5617 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005618#endif
5619
Ronald Crone68ab4f2022-10-05 12:46:29 +02005620#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005621#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005623 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005625#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005627#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628
Brett Warrene0edc842021-08-17 09:53:13 +01005629 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005630 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005631
5632 /*
5633 * Default
5634 */
5635 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005636
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005637 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005638
5639#if defined(MBEDTLS_X509_CRT_PARSE_C)
5640 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5641#endif
5642
Ronald Crone68ab4f2022-10-05 12:46:29 +02005643#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005644#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005646 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005648#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005650#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005651
Brett Warrene0edc842021-08-17 09:53:13 +01005652 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005653 }
5654
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005656}
5657
5658/*
5659 * Free mbedtls_ssl_config
5660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005662{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005663 if (conf == NULL) {
5664 return;
5665 }
5666
Ronald Cron73fe8df2022-10-05 14:31:43 +02005667#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005669 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5670 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005672 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005673 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005674 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005675 }
5676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005678 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005679 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005680 conf->psk_identity_len = 0;
5681 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005682#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005683
5684#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005686#endif
5687
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005689}
5690
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005691#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005692 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005693/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005694 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005695 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005696unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005697{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5700 return MBEDTLS_SSL_SIG_RSA;
5701 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005702#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005703#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5705 return MBEDTLS_SSL_SIG_ECDSA;
5706 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005707#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005709}
5710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005712{
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005714 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005716 case MBEDTLS_PK_ECDSA:
5717 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005719 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005721 }
5722}
5723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005725{
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727#if defined(MBEDTLS_RSA_C)
5728 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005730#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005731#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005732 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005734#endif
5735 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005737 }
5738}
Valerio Settie9646ec2023-08-02 20:02:28 +02005739#endif /* MBEDTLS_PK_C &&
5740 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005741
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005742/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005743 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005744 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005745mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005746{
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005748#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005749 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005751#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005752#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005753 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005755#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005756#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005757 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005759#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005760#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005763#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005764#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005765 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005767#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005768#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005769 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005771#endif
5772 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005774 }
5775}
5776
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005777/*
5778 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005780unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005781{
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005783#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005784 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005786#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005787#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005788 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005790#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005791#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005792 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005794#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005795#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005796 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005798#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005799#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005800 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005802#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005803#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005804 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005806#endif
5807 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005809 }
5810}
5811
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005812/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005813 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005814 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005816int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005817{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005818 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005819
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if (group_list == NULL) {
5821 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005822 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 for (; *group_list != 0; group_list++) {
5825 if (*group_list == tls_id) {
5826 return 0;
5827 }
5828 }
5829
5830 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005831}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005832
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005833#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005834/*
5835 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005838{
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005840
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005842 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005844
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005846}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005847#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005848
Valerio Setti18c9fed2022-12-30 17:44:24 +01005849static const struct {
5850 uint16_t tls_id;
5851 mbedtls_ecp_group_id ecp_group_id;
5852 psa_ecc_family_t psa_family;
5853 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005854} tls_id_match_table[] =
5855{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005856#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005857 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005858#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005859#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005860 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005861#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005862#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005863 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005864#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005865#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005866 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005867#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005868#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005869 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005870#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005871#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005872 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005873#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005874#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005875 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005876#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005877#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005878 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005879#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005880#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005881 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005882#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005883#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005884 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005885#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005886#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005887 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005888#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005889#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005890 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005891#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005892 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005893};
5894
Gilles Peskine449bd832023-01-11 14:50:10 +01005895int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005896 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898{
Gilles Peskine449bd832023-01-11 14:50:10 +01005899 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5900 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005901 if (type != NULL) {
5902 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 }
5904 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005905 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005907 return PSA_SUCCESS;
5908 }
5909 }
5910
5911 return PSA_ERROR_NOT_SUPPORTED;
5912}
5913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005915{
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5917 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005918 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005920 }
5921
5922 return MBEDTLS_ECP_DP_NONE;
5923}
5924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005926{
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5928 i++) {
5929 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005930 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005932 }
5933
5934 return 0;
5935}
5936
Valerio Setti67419f02023-01-04 16:12:42 +01005937#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005938static const struct {
5939 uint16_t tls_id;
5940 const char *name;
5941} tls_id_curve_name_table[] =
5942{
Valerio Setti54e23792023-07-07 10:49:27 +02005943 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5944 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5945 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5946 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5947 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5948 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5949 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5950 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5951 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5952 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5953 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5954 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5955 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005956 { 0, NULL },
5957};
5958
Gilles Peskine449bd832023-01-11 14:50:10 +01005959const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005960{
Valerio Settiacd32c02023-06-29 18:06:29 +02005961 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5962 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5963 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005964 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005965 }
5966
5967 return NULL;
5968}
Valerio Setti67419f02023-01-04 16:12:42 +01005969#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5972 const mbedtls_md_type_t md,
5973 unsigned char *dst,
5974 size_t dst_len,
5975 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005976{
Ronald Cronf6893e12022-01-07 22:09:01 +01005977 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5978 psa_hash_operation_t *hash_operation_to_clone;
5979 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5980
Jerry Yu148165c2021-09-24 23:20:59 +08005981 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005984#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 case MBEDTLS_MD_SHA384:
5986 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5987 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005988#endif
5989
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005990#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 case MBEDTLS_MD_SHA256:
5992 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5993 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005994#endif
5995
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 default:
5997 goto exit;
5998 }
5999
6000 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6001 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006002 goto exit;
6003 }
6004
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6006 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006007 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006009
6010exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006011#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006012 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006013 (void) ssl;
6014#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006015 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006016}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006017
Ronald Crone68ab4f2022-10-05 12:46:29 +02006018#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006019/* mbedtls_ssl_parse_sig_alg_ext()
6020 *
6021 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6022 * value (TLS 1.3 RFC8446):
6023 * enum {
6024 * ....
6025 * ecdsa_secp256r1_sha256( 0x0403 ),
6026 * ecdsa_secp384r1_sha384( 0x0503 ),
6027 * ecdsa_secp521r1_sha512( 0x0603 ),
6028 * ....
6029 * } SignatureScheme;
6030 *
6031 * struct {
6032 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6033 * } SignatureSchemeList;
6034 *
6035 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6036 * value (TLS 1.2 RFC5246):
6037 * enum {
6038 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6039 * sha512(6), (255)
6040 * } HashAlgorithm;
6041 *
6042 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6043 * SignatureAlgorithm;
6044 *
6045 * struct {
6046 * HashAlgorithm hash;
6047 * SignatureAlgorithm signature;
6048 * } SignatureAndHashAlgorithm;
6049 *
6050 * SignatureAndHashAlgorithm
6051 * supported_signature_algorithms<2..2^16-2>;
6052 *
6053 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6054 * generalization of the TLS 1.2 signature algorithm extension.
6055 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6056 * `SignatureScheme` field of TLS 1.3
6057 *
6058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006059int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6060 const unsigned char *buf,
6061 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006062{
6063 const unsigned char *p = buf;
6064 size_t supported_sig_algs_len = 0;
6065 const unsigned char *supported_sig_algs_end;
6066 uint16_t sig_alg;
6067 uint32_t common_idx = 0;
6068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6070 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006071 p += 2;
6072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 memset(ssl->handshake->received_sig_algs, 0,
6074 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006077 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 while (p < supported_sig_algs_end) {
6079 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6080 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006081 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6083 sig_alg,
6084 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006085#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6087 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6088 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006089 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006090 }
6091#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6094 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006097 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6098 common_idx += 1;
6099 }
6100 }
6101 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (p != end) {
6103 MBEDTLS_SSL_DEBUG_MSG(1,
6104 ("Signature algorithms extension length misaligned"));
6105 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6106 MBEDTLS_ERR_SSL_DECODE_ERROR);
6107 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006108 }
6109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (common_idx == 0) {
6111 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6112 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6113 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6114 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006115 }
6116
Gabor Mezei15b95a62022-05-09 16:37:58 +02006117 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006119}
6120
Ronald Crone68ab4f2022-10-05 12:46:29 +02006121#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006122
Jerry Yudc7bd172022-02-17 13:44:15 +08006123#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6124
Jerry Yudc7bd172022-02-17 13:44:15 +08006125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6127 mbedtls_svc_key_id_t key,
6128 psa_algorithm_t alg,
6129 const unsigned char *raw_psk, size_t raw_psk_length,
6130 const unsigned char *seed, size_t seed_length,
6131 const unsigned char *label, size_t label_length,
6132 const unsigned char *other_secret,
6133 size_t other_secret_length,
6134 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006135{
6136 psa_status_t status;
6137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 status = psa_key_derivation_setup(derivation, alg);
6139 if (status != PSA_SUCCESS) {
6140 return status;
6141 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006142
Gilles Peskine449bd832023-01-11 14:50:10 +01006143 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6144 status = psa_key_derivation_input_bytes(derivation,
6145 PSA_KEY_DERIVATION_INPUT_SEED,
6146 seed, seed_length);
6147 if (status != PSA_SUCCESS) {
6148 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006149 }
6150
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 if (other_secret != NULL) {
6152 status = psa_key_derivation_input_bytes(derivation,
6153 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6154 other_secret, other_secret_length);
6155 if (status != PSA_SUCCESS) {
6156 return status;
6157 }
6158 }
6159
6160 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006161 status = psa_key_derivation_input_bytes(
6162 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 raw_psk, raw_psk_length);
6164 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006165 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006167 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (status != PSA_SUCCESS) {
6169 return status;
6170 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 status = psa_key_derivation_input_bytes(derivation,
6173 PSA_KEY_DERIVATION_INPUT_LABEL,
6174 label, label_length);
6175 if (status != PSA_SUCCESS) {
6176 return status;
6177 }
6178 } else {
6179 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 }
6181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 status = psa_key_derivation_set_capacity(derivation, capacity);
6183 if (status != PSA_SUCCESS) {
6184 return status;
6185 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006186
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006188}
6189
Andrzej Kurek57d10632022-10-24 10:32:01 -04006190#if defined(PSA_WANT_ALG_SHA_384) || \
6191 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006192MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006193static int tls_prf_generic(mbedtls_md_type_t md_type,
6194 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006195 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 const unsigned char *random, size_t rlen,
6197 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006198{
6199 psa_status_t status;
6200 psa_algorithm_t alg;
6201 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6202 psa_key_derivation_operation_t derivation =
6203 PSA_KEY_DERIVATION_OPERATION_INIT;
6204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006206 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006208 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006210
6211 /* Normally a "secret" should be long enough to be impossible to
6212 * find by brute force, and in particular should not be empty. But
6213 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6214 * and for this use case it makes sense to have a 0-length "secret".
6215 * Since the key API doesn't allow importing a key of length 0,
6216 * keep master_key=0, which setup_psa_key_derivation() understands
6217 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6221 psa_set_key_algorithm(&key_attributes, alg);
6222 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006223
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6225 if (status != PSA_SUCCESS) {
6226 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6227 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 }
6229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 status = setup_psa_key_derivation(&derivation,
6231 master_key, alg,
6232 NULL, 0,
6233 random, rlen,
6234 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006235 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 NULL, 0,
6237 dlen);
6238 if (status != PSA_SUCCESS) {
6239 psa_key_derivation_abort(&derivation);
6240 psa_destroy_key(master_key);
6241 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 }
6243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6245 if (status != PSA_SUCCESS) {
6246 psa_key_derivation_abort(&derivation);
6247 psa_destroy_key(master_key);
6248 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006249 }
6250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 status = psa_key_derivation_abort(&derivation);
6252 if (status != PSA_SUCCESS) {
6253 psa_destroy_key(master_key);
6254 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006255 }
6256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 if (!mbedtls_svc_key_id_is_null(master_key)) {
6258 status = psa_destroy_key(master_key);
6259 }
6260 if (status != PSA_SUCCESS) {
6261 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6262 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006265}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006266#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006267
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006268#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006269MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006270static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6271 const char *label,
6272 const unsigned char *random, size_t rlen,
6273 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006274{
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006276 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006277}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006278#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006280#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006282static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6283 const char *label,
6284 const unsigned char *random, size_t rlen,
6285 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006286{
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006288 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006289}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006290#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006291
Jerry Yuf009d862022-02-17 14:01:37 +08006292/*
6293 * Set appropriate PRF function and other SSL / TLS1.2 functions
6294 *
6295 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006296 * - hash associated with the ciphersuite (only used by TLS 1.2)
6297 *
6298 * Outputs:
6299 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6300 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006302static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6303 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006304{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006305#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006307 handshake->tls_prf = tls_prf_sha384;
6308 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6309 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006311#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006312#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006313 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006314 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006315 handshake->tls_prf = tls_prf_sha256;
6316 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6317 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6318 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006319#else
Jerry Yuf009d862022-02-17 14:01:37 +08006320 {
Jerry Yuf009d862022-02-17 14:01:37 +08006321 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006322 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006324 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006325#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006328}
Jerry Yud6ab2352022-02-17 14:03:43 +08006329
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006330/*
6331 * Compute master secret if needed
6332 *
6333 * Parameters:
6334 * [in/out] handshake
6335 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6336 * (PSA-PSK) ciphersuite_info, psk_opaque
6337 * [out] premaster (cleared)
6338 * [out] master
6339 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6340 * debug: conf->f_dbg, conf->p_dbg
6341 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006342 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006343 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006344MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006345static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6346 unsigned char *master,
6347 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006348{
6349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6350
6351 /* cf. RFC 5246, Section 8.1:
6352 * "The master secret is always exactly 48 bytes in length." */
6353 size_t const master_secret_len = 48;
6354
6355#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6356 unsigned char session_hash[48];
6357#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6358
6359 /* The label for the KDF used for key expansion.
6360 * This is either "master secret" or "extended master secret"
6361 * depending on whether the Extended Master Secret extension
6362 * is used. */
6363 char const *lbl = "master secret";
6364
Przemek Stekielae4ed302022-04-05 17:15:55 +02006365 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366 * - If the Extended Master Secret extension is not used,
6367 * this is ClientHello.Random + ServerHello.Random
6368 * (see Sect. 8.1 in RFC 5246).
6369 * - If the Extended Master Secret extension is used,
6370 * this is the transcript of the handshake so far.
6371 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006372 unsigned char const *seed = handshake->randbytes;
6373 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006374
6375#if !defined(MBEDTLS_DEBUG_C) && \
6376 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006377 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006378 ssl = NULL; /* make sure we don't use it except for those cases */
6379 (void) ssl;
6380#endif
6381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 if (handshake->resume != 0) {
6383 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6384 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385 }
6386
6387#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006389 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006390 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006391 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6392 if (ret != 0) {
6393 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6394 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6397 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006398 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006399#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006401#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006403 /* Perform PSK-to-MS expansion in a single step. */
6404 psa_status_t status;
6405 psa_algorithm_t alg;
6406 mbedtls_svc_key_id_t psk;
6407 psa_key_derivation_operation_t derivation =
6408 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006409 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006421 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006425 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006426 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006427 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006428 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006429 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6430 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6431 other_secret = handshake->premaster + 2;
6432 break;
6433 default:
6434 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006435 }
6436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 status = setup_psa_key_derivation(&derivation, psk, alg,
6438 ssl->conf->psk, ssl->conf->psk_len,
6439 seed, seed_len,
6440 (unsigned char const *) lbl,
6441 (size_t) strlen(lbl),
6442 other_secret, other_secret_len,
6443 master_secret_len);
6444 if (status != PSA_SUCCESS) {
6445 psa_key_derivation_abort(&derivation);
6446 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006447 }
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 status = psa_key_derivation_output_bytes(&derivation,
6450 master,
6451 master_secret_len);
6452 if (status != PSA_SUCCESS) {
6453 psa_key_derivation_abort(&derivation);
6454 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006455 }
6456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 status = psa_key_derivation_abort(&derivation);
6458 if (status != PSA_SUCCESS) {
6459 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6460 }
6461 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006462#endif
6463 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006464#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006466 psa_status_t status;
6467 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6468 psa_key_derivation_operation_t derivation =
6469 PSA_KEY_DERIVATION_OPERATION_INIT;
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006472
6473 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 status = psa_key_derivation_setup(&derivation, alg);
6476 if (status != PSA_SUCCESS) {
6477 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006478 }
6479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 status = psa_key_derivation_set_capacity(&derivation,
6481 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6482 if (status != PSA_SUCCESS) {
6483 psa_key_derivation_abort(&derivation);
6484 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485 }
6486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6488 &derivation);
6489 if (status != PSA_SUCCESS) {
6490 psa_key_derivation_abort(&derivation);
6491 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492 }
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_key_derivation_output_bytes(&derivation,
6495 handshake->premaster,
6496 handshake->pmslen);
6497 if (status != PSA_SUCCESS) {
6498 psa_key_derivation_abort(&derivation);
6499 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6500 }
6501
6502 status = psa_key_derivation_abort(&derivation);
6503 if (status != PSA_SUCCESS) {
6504 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006505 }
6506 }
6507#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6509 lbl, seed, seed_len,
6510 master,
6511 master_secret_len);
6512 if (ret != 0) {
6513 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6514 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006515 }
6516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6518 handshake->premaster,
6519 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006520
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 mbedtls_platform_zeroize(handshake->premaster,
6522 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523 }
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526}
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006529{
6530 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6531 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6532 ssl->handshake->ciphersuite_info;
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006535
6536 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006538 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 if (ret != 0) {
6540 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6541 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006542 }
6543
6544 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 ret = ssl_compute_master(ssl->handshake,
6546 ssl->session_negotiate->master,
6547 ssl);
6548 if (ret != 0) {
6549 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6550 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006551 }
6552
6553 /* Swap the client and server random values:
6554 * - MS derivation wanted client+server (RFC 5246 8.1)
6555 * - key derivation wants server+client (RFC 5246 6.3) */
6556 {
6557 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 memcpy(tmp, ssl->handshake->randbytes, 64);
6559 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6560 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6561 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006562 }
6563
6564 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6566 ssl->session_negotiate->ciphersuite,
6567 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006568#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006570#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 ssl->handshake->tls_prf,
6572 ssl->handshake->randbytes,
6573 ssl->tls_version,
6574 ssl->conf->endpoint,
6575 ssl);
6576 if (ret != 0) {
6577 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6578 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006579 }
6580
6581 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6583 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006584
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006588}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006589
Gilles Peskine449bd832023-01-11 14:50:10 +01006590int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006591{
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006593#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006594 case MBEDTLS_SSL_HASH_SHA384:
6595 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6596 break;
6597#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006598#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006599 case MBEDTLS_SSL_HASH_SHA256:
6600 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6601 break;
6602#endif
6603 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006605 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006606#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006607 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006608 (void) ssl;
6609#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006611}
6612
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006613static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6614 const psa_hash_operation_t *hs_op,
6615 size_t buffer_size,
6616 unsigned char *hash,
6617 size_t *hlen)
6618{
6619 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006620 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006621
6622#if !defined(MBEDTLS_DEBUG_C)
6623 (void) ssl;
6624#endif
6625 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006626 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006627 if (status != PSA_SUCCESS) {
6628 goto exit;
6629 }
6630
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006631 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006632 if (status != PSA_SUCCESS) {
6633 goto exit;
6634 }
6635
6636 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6637 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6638
6639exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006640 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006641 return mbedtls_md_error_from_psa(status);
6642}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006643
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006644#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006645int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6646 unsigned char *hash,
6647 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006648{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006649 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6650 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006651}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006652#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006653
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006654#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006655int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6656 unsigned char *hash,
6657 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006658{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006659 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6660 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006661}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006662#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006663
Jerry Yuc2c673d2022-02-17 14:20:39 +08006664#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006665MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006666static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006667
6668#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006669int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006670{
6671 /* If renegotiation is not enforced, retransmit until we would reach max
6672 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006674 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6675 unsigned char doublings = 1;
6676
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006678 ++doublings;
6679 ratio >>= 1;
6680 }
6681
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 if (++ssl->renego_records_seen > doublings) {
6683 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6684 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006685 }
6686 }
6687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006689}
6690#endif
6691#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006692
Jerry Yud9526692022-02-17 14:23:47 +08006693/*
6694 * Handshake functions
6695 */
6696#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6697/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006698int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006699{
6700 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6701 ssl->handshake->ciphersuite_info;
6702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6706 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006707 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006709 }
6710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6712 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006713}
6714
Gilles Peskine449bd832023-01-11 14:50:10 +01006715int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006716{
6717 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6718 ssl->handshake->ciphersuite_info;
6719
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6723 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006724 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006726 }
6727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6729 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006730}
6731
6732#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6733/* Some certificate support -> implement write and parse */
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006736{
6737 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6738 size_t i, n;
6739 const mbedtls_x509_crt *crt;
6740 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6741 ssl->handshake->ciphersuite_info;
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006744
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6746 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006747 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006749 }
6750
6751#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6753 if (ssl->handshake->client_auth == 0) {
6754 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006755 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006757 }
6758 }
6759#endif /* MBEDTLS_SSL_CLI_C */
6760#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6762 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006763 /* Should never happen because we shouldn't have picked the
6764 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006766 }
6767 }
6768#endif
6769
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006771
6772 /*
6773 * 0 . 0 handshake type
6774 * 1 . 3 handshake length
6775 * 4 . 6 length of all certs
6776 * 7 . 9 length of cert. 1
6777 * 10 . n-1 peer certificate
6778 * n . n+2 length of cert. 2
6779 * n+3 . ... upper level cert, etc.
6780 */
6781 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006783
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006785 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6787 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6788 " > %" MBEDTLS_PRINTF_SIZET,
6789 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6790 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006791 }
6792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6794 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6795 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006798 i += n; crt = crt->next;
6799 }
6800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6802 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6803 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006804
6805 ssl->out_msglen = i;
6806 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6807 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6808
6809 ssl->state++;
6810
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6812 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6813 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006814 }
6815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006819}
6820
6821#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6822
6823#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006824MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006825static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6826 unsigned char *crt_buf,
6827 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006828{
6829 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 if (peer_crt == NULL) {
6832 return -1;
6833 }
Jerry Yud9526692022-02-17 14:23:47 +08006834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (peer_crt->raw.len != crt_buf_len) {
6836 return -1;
6837 }
Jerry Yud9526692022-02-17 14:23:47 +08006838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006840}
6841#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006842MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006843static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6844 unsigned char *crt_buf,
6845 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006846{
6847 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6848 unsigned char const * const peer_cert_digest =
6849 ssl->session->peer_cert_digest;
6850 mbedtls_md_type_t const peer_cert_digest_type =
6851 ssl->session->peer_cert_digest_type;
6852 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006854 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6855 size_t digest_len;
6856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 if (peer_cert_digest == NULL || digest_info == NULL) {
6858 return -1;
6859 }
Jerry Yud9526692022-02-17 14:23:47 +08006860
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 digest_len = mbedtls_md_get_size(digest_info);
6862 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6863 return -1;
6864 }
Jerry Yud9526692022-02-17 14:23:47 +08006865
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6867 if (ret != 0) {
6868 return -1;
6869 }
Jerry Yud9526692022-02-17 14:23:47 +08006870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006872}
6873#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6874#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6875
6876/*
6877 * Once the certificate message is read, parse it into a cert chain and
6878 * perform basic checks, but leave actual verification to the caller
6879 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006880MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006881static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6882 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006883{
6884 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6885#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006887#endif
6888 size_t i, n;
6889 uint8_t alert;
6890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6892 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6893 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6894 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6895 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006896 }
6897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6899 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6900 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6901 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006902 }
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6905 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6906 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6907 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6908 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006909 }
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006912
6913 /*
6914 * Same message structure as in mbedtls_ssl_write_certificate()
6915 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006916 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if (ssl->in_msg[i] != 0 ||
6919 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6920 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6921 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6922 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6923 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006924 }
6925
6926 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6927 i += 3;
6928
6929 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006931 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 if (i + 3 > ssl->in_hslen) {
6933 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6934 mbedtls_ssl_send_alert_message(ssl,
6935 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6936 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6937 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006938 }
6939 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6940 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 if (ssl->in_msg[i] != 0) {
6942 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6943 mbedtls_ssl_send_alert_message(ssl,
6944 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6945 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6946 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006947 }
6948
6949 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006950 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006951 i += 3;
6952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 if (n < 128 || i + n > ssl->in_hslen) {
6954 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6955 mbedtls_ssl_send_alert_message(ssl,
6956 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6957 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6958 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006959 }
6960
6961 /* Check if we're handling the first CRT in the chain. */
6962#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006964 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006966 /* During client-side renegotiation, check that the server's
6967 * end-CRTs hasn't changed compared to the initial handshake,
6968 * mitigating the triple handshake attack. On success, reuse
6969 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6971 if (ssl_check_peer_crt_unchanged(ssl,
6972 &ssl->in_msg[i],
6973 n) != 0) {
6974 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6975 mbedtls_ssl_send_alert_message(ssl,
6976 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6977 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6978 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006979 }
6980
6981 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006983 }
6984#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6985
6986 /* Parse the next certificate in the chain. */
6987#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006989#else
6990 /* If we don't need to store the CRT chain permanently, parse
6991 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006993#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08006995 case 0: /*ok*/
Gilles Peskinea7e14dc2024-09-16 13:10:11 +02006996 case MBEDTLS_ERR_OID_NOT_FOUND:
Jerry Yud9526692022-02-17 14:23:47 +08006997 /* Ignore certificate with an unknown algorithm: maybe a
6998 prior certificate was already trusted. */
6999 break;
7000
7001 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7002 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7003 goto crt_parse_der_failed;
7004
7005 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7006 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7007 goto crt_parse_der_failed;
7008
7009 default:
7010 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007011crt_parse_der_failed:
7012 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7013 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7014 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007015 }
7016
7017 i += n;
7018 }
7019
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7021 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007022}
7023
7024#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007025MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007026static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007027{
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7029 return -1;
7030 }
Jerry Yud9526692022-02-17 14:23:47 +08007031
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007033 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7034 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7036 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7037 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007038 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007040}
7041#endif /* MBEDTLS_SSL_SRV_C */
7042
7043/* Check if a certificate message is expected.
7044 * Return either
7045 * - SSL_CERTIFICATE_EXPECTED, or
7046 * - SSL_CERTIFICATE_SKIP
7047 * indicating whether a Certificate message is expected or not.
7048 */
7049#define SSL_CERTIFICATE_EXPECTED 0
7050#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007051MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007052static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7053 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007054{
7055 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7056 ssl->handshake->ciphersuite_info;
7057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7059 return SSL_CERTIFICATE_SKIP;
7060 }
Jerry Yud9526692022-02-17 14:23:47 +08007061
7062#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007065 ssl->session_negotiate->verify_result =
7066 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007068 }
7069 }
7070#else
7071 ((void) authmode);
7072#endif /* MBEDTLS_SSL_SRV_C */
7073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007075}
7076
Jerry Yud9526692022-02-17 14:23:47 +08007077#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007078MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007079static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7080 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007081{
7082 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7083 /* Remember digest of the peer's end-CRT. */
7084 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7086 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7087 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7088 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7089 mbedtls_ssl_send_alert_message(ssl,
7090 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7091 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007092
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007094 }
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 ret = mbedtls_md(mbedtls_md_info_from_type(
7097 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7098 start, len,
7099 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007100
7101 ssl->session_negotiate->peer_cert_digest_type =
7102 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7103 ssl->session_negotiate->peer_cert_digest_len =
7104 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7105
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007107}
7108
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007109MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007110static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7111 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007112{
7113 unsigned char *end = start + len;
7114 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7115
7116 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7118 ret = mbedtls_pk_parse_subpubkey(&start, end,
7119 &ssl->handshake->peer_pubkey);
7120 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007121 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007123 }
7124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007126}
7127#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007130{
7131 int ret = 0;
7132 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007133 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007134#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7135 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7136 ? ssl->handshake->sni_authmode
7137 : ssl->conf->authmode;
7138#else
7139 const int authmode = ssl->conf->authmode;
7140#endif
7141 void *rs_ctx = NULL;
7142 mbedtls_x509_crt *chain = NULL;
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007145
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7147 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7148 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007149 goto exit;
7150 }
7151
7152#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 if (ssl->handshake->ecrs_enabled &&
7154 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007155 chain = ssl->handshake->ecrs_peer_cert;
7156 ssl->handshake->ecrs_peer_cert = NULL;
7157 goto crt_verify;
7158 }
7159#endif
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007162 /* mbedtls_ssl_read_record may have sent an alert already. We
7163 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007165 goto exit;
7166 }
7167
7168#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007170 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007173 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 }
Jerry Yud9526692022-02-17 14:23:47 +08007175
7176 goto exit;
7177 }
7178#endif /* MBEDTLS_SSL_SRV_C */
7179
7180 /* Clear existing peer CRT structure in case we tried to
7181 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7185 if (chain == NULL) {
7186 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7187 sizeof(mbedtls_x509_crt)));
7188 mbedtls_ssl_send_alert_message(ssl,
7189 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7190 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007191
7192 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7193 goto exit;
7194 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 ret = ssl_parse_certificate_chain(ssl, chain);
7198 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007199 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 }
Jerry Yud9526692022-02-17 14:23:47 +08007201
7202#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007204 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 }
Jerry Yud9526692022-02-17 14:23:47 +08007206
7207crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007209 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 }
Jerry Yud9526692022-02-17 14:23:47 +08007211#endif
7212
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007213 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7214 ssl->handshake->ciphersuite_info,
7215 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007217 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 }
Jerry Yud9526692022-02-17 14:23:47 +08007219
7220#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7221 {
7222 unsigned char *crt_start, *pk_start;
7223 size_t crt_len, pk_len;
7224
7225 /* We parse the CRT chain without copying, so
7226 * these pointers point into the input buffer,
7227 * and are hence still valid after freeing the
7228 * CRT chain. */
7229
7230 crt_start = chain->raw.p;
7231 crt_len = chain->raw.len;
7232
7233 pk_start = chain->pk_raw.p;
7234 pk_len = chain->pk_raw.len;
7235
7236 /* Free the CRT structures before computing
7237 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 mbedtls_x509_crt_free(chain);
7239 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007240 chain = NULL;
7241
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7243 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 }
Jerry Yud9526692022-02-17 14:23:47 +08007246
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7248 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007249 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007250 }
Jerry Yud9526692022-02-17 14:23:47 +08007251 }
7252#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7253 /* Pass ownership to session structure. */
7254 ssl->session_negotiate->peer_cert = chain;
7255 chain = NULL;
7256#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007259
7260exit:
7261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007263 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 }
Jerry Yud9526692022-02-17 14:23:47 +08007265
7266#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007268 ssl->handshake->ecrs_peer_cert = chain;
7269 chain = NULL;
7270 }
7271#endif
7272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 if (chain != NULL) {
7274 mbedtls_x509_crt_free(chain);
7275 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007276 }
7277
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007279}
7280#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7281
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007282static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7283 unsigned char *padbuf, size_t hlen,
7284 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007285{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007286 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007287 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007288 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007289 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007290 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007291 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007292
7293 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007294 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007295 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007297
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007299 ? "client finished"
7300 : "server finished";
7301
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007302 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007303
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007304 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007306 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007307 }
7308
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007309 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007310 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007311 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007312 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007313 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007314
7315 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7316
Jerry Yu615bd6f2022-02-17 14:25:15 +08007317 /*
7318 * TLSv1.2:
7319 * hash = PRF( master, finished_label,
7320 * Hash( handshake ) )[0.11]
7321 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007323 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007326
Paul Elliottecb95be2023-08-11 16:41:04 +01007327 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007328
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007329 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007330
7331exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007332 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007333 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007334}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007335
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007336#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007337static int ssl_calc_finished_tls_sha256(
7338 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7339{
7340 unsigned char padbuf[32];
7341 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007342 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007343 padbuf, sizeof(padbuf),
7344 buf, from);
7345}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007346#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007347
Jerry Yub7ba49e2022-02-17 14:25:53 +08007348
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007349#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007350static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007352{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007353 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007354 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007355 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007356 padbuf, sizeof(padbuf),
7357 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007358}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007359#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007360
Gilles Peskine449bd832023-01-11 14:50:10 +01007361void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007362{
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007364
7365 /*
7366 * Free our handshake params
7367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 mbedtls_ssl_handshake_free(ssl);
7369 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007370 ssl->handshake = NULL;
7371
7372 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007373 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007374 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 if (ssl->transform) {
7376 mbedtls_ssl_transform_free(ssl->transform);
7377 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007378 }
7379 ssl->transform = ssl->transform_negotiate;
7380 ssl->transform_negotiate = NULL;
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007383}
7384
Gilles Peskine449bd832023-01-11 14:50:10 +01007385void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007386{
7387 int resume = ssl->handshake->resume;
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007390
7391#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007393 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7394 ssl->renego_records_seen = 0;
7395 }
7396#endif
7397
7398 /*
7399 * Free the previous session and switch in the current one
7400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007402#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7403 /* RFC 7366 3.1: keep the EtM state */
7404 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007406#endif
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 mbedtls_ssl_session_free(ssl->session);
7409 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007410 }
7411 ssl->session = ssl->session_negotiate;
7412 ssl->session_negotiate = NULL;
7413
7414 /*
7415 * Add cache entry
7416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007418 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 resume == 0) {
7420 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7421 ssl->session->id,
7422 ssl->session->id_len,
7423 ssl->session) != 0) {
7424 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7425 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007426 }
7427
7428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7430 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007431 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007432 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007433
7434 /* Keep last flight around in case we need to resend it:
7435 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7437 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007438#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007440
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007441 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007444}
7445
Gilles Peskine449bd832023-01-11 14:50:10 +01007446int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007447{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007448 int ret;
7449 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007450
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007454
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007455 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7456 if (ret != 0) {
7457 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7458 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007459
7460 /*
7461 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7462 * may define some other value. Currently (early 2016), no defined
7463 * ciphersuite does this (and this is unlikely to change as activity has
7464 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7465 */
7466 hash_len = 12;
7467
7468#if defined(MBEDTLS_SSL_RENEGOTIATION)
7469 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007471#endif
7472
7473 ssl->out_msglen = 4 + hash_len;
7474 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7475 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7476
7477 /*
7478 * In case of session resuming, invert the client and server
7479 * ChangeCipherSpec messages order.
7480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007482#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007484 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007486#endif
7487#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007489 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007491#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007493 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007495
7496 /*
7497 * Switch to our negotiated transform and session parameters for outbound
7498 * data.
7499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007501
7502#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007504 unsigned char i;
7505
7506 /* Remember current epoch settings for resending */
7507 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7509 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007510
7511 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007513
7514
7515 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 for (i = 2; i > 0; i--) {
7517 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007518 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 }
7520 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007521
7522 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 if (i == 0) {
7524 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7525 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007526 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007528#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007530
7531 ssl->transform_out = ssl->transform_negotiate;
7532 ssl->session_out = ssl->session_negotiate;
7533
7534#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7536 mbedtls_ssl_send_flight_completed(ssl);
7537 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007538#endif
7539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7541 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7542 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007543 }
7544
7545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7547 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7549 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007550 }
7551#endif
7552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007556}
7557
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007558#define SSL_MAX_HASH_LEN 12
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007561{
7562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7563 unsigned int hash_len = 12;
7564 unsigned char buf[SSL_MAX_HASH_LEN];
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007567
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007568 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7569 if (ret != 0) {
7570 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7571 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7574 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007575 goto exit;
7576 }
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7579 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7580 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7581 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007582 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7583 goto exit;
7584 }
7585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7587 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7588 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007589 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7590 goto exit;
7591 }
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7594 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7595 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7596 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007597 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7598 goto exit;
7599 }
7600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7602 buf, hash_len) != 0) {
7603 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7604 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7605 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007606 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7607 goto exit;
7608 }
7609
7610#if defined(MBEDTLS_SSL_RENEGOTIATION)
7611 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007613#endif
7614
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007616#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007618 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007620#endif
7621#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007623 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007625#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007627 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007629
7630#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7632 mbedtls_ssl_recv_flight_completed(ssl);
7633 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007634#endif
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007637
7638exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 mbedtls_platform_zeroize(buf, hash_len);
7640 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007641}
7642
Jerry Yu392112c2022-02-17 14:34:10 +08007643#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7644/*
7645 * Helper to get TLS 1.2 PRF from ciphersuite
7646 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7647 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007648static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007649{
Jerry Yu392112c2022-02-17 14:34:10 +08007650 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007652#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7654 return tls_prf_sha384;
7655 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007656#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007657#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007658 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7660 return tls_prf_sha256;
7661 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007662 }
7663#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007664#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007665 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007666 (void) ciphersuite_info;
7667#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007670}
7671#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007674{
7675 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007676#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (tls_prf == tls_prf_sha384) {
7678 return MBEDTLS_SSL_TLS_PRF_SHA384;
7679 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007680#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007681#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 if (tls_prf == tls_prf_sha256) {
7683 return MBEDTLS_SSL_TLS_PRF_SHA256;
7684 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007685#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007687}
7688
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007689/*
7690 * Populate a transform structure with session keys and all the other
7691 * necessary information.
7692 *
7693 * Parameters:
7694 * - [in/out]: transform: structure to populate
7695 * [in] must be just initialised with mbedtls_ssl_transform_init()
7696 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7697 * - [in] ciphersuite
7698 * - [in] master
7699 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007700 * - [in] tls_prf: pointer to PRF to use for key derivation
7701 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007702 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007703 * - [in] endpoint: client or server
7704 * - [in] ssl: used for:
7705 * - ssl->conf->{f,p}_export_keys
7706 * [in] optionally used for:
7707 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7708 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007709MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007710static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7711 int ciphersuite,
7712 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007713#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007715#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 ssl_tls_prf_t tls_prf,
7717 const unsigned char randbytes[64],
7718 mbedtls_ssl_protocol_version tls_version,
7719 unsigned endpoint,
7720 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007721{
7722 int ret = 0;
7723 unsigned char keyblk[256];
7724 unsigned char *key1;
7725 unsigned char *key2;
7726 unsigned char *mac_enc;
7727 unsigned char *mac_dec;
7728 size_t mac_key_len = 0;
7729 size_t iv_copy_len;
7730 size_t keylen;
7731 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007732 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007733
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007734 psa_key_type_t key_type;
7735 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7736 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007737 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007738 size_t key_bits;
7739 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007740
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007741 /*
7742 * Some data just needs copying into the structure
7743 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007744#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007745 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007746#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007747 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007748
Max Fillinger2fe35f62024-10-25 00:52:24 +02007749#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007751#endif
7752
7753#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007755 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7756 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007757 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007758 }
7759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7760
7761 /*
7762 * Get various info structures
7763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7765 if (ciphersuite_info == NULL) {
7766 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7767 ciphersuite));
7768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007769 }
7770
Neil Armstrongab555e02022-04-04 11:07:59 +02007771 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007772#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007774#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007776
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007778 transform->taglen =
7779 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007781
Dave Rodgman2eab4622023-10-05 13:30:37 +01007782 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 transform->taglen,
7784 &alg,
7785 &key_type,
7786 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007787 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007789 goto end;
7790 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007791
Dave Rodgman2eab4622023-10-05 13:30:37 +01007792 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007794 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 (unsigned) ciphersuite_info->mac));
7796 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007797 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007798
7799#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7800 /* Copy own and peer's CID if the use of the CID
7801 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7803 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007804
7805 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7807 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7808 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007809
7810 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7812 ssl->handshake->peer_cid_len);
7813 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7814 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007815 }
7816#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7817
7818 /*
7819 * Compute key block using the PRF
7820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7822 if (ret != 0) {
7823 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7824 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007825 }
7826
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7828 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7829 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7830 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7831 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007832
7833 /*
7834 * Determine the appropriate key, IV and MAC length.
7835 */
7836
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007837 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838
Valerio Settie5707042023-10-11 11:54:42 +02007839#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007841 size_t explicit_ivlen;
7842
7843 transform->maclen = 0;
7844 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007845
7846 /* All modes haves 96-bit IVs, but the length of the static parts vary
7847 * with mode and version:
7848 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7849 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7850 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7851 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7852 * sequence number).
7853 */
7854 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007855
7856 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007858
Gilles Peskine449bd832023-01-11 14:50:10 +01007859 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007860 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007862 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007864
7865 /* Minimum length of encrypted record */
7866 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7867 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 } else
Valerio Settie5707042023-10-11 11:54:42 +02007869#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007870#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007872 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007875
Neil Armstronge4512952022-03-08 09:08:22 +01007876 /* Get MAC length */
7877 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007878 transform->maclen = mac_key_len;
7879
7880 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007882
7883 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007885 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007887 /*
7888 * GenericBlockCipher:
7889 * 1. if EtM is in use: one block plus MAC
7890 * otherwise: * first multiple of blocklen greater than maclen
7891 * 2. IV
7892 */
7893#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007895 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 + block_size;
7897 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007898#endif
7899 {
7900 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 + block_size
7902 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007903 }
7904
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007906 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 } else {
7908 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7910 goto end;
7911 }
7912 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007914#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7915 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7917 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007918 }
7919
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7921 (unsigned) keylen,
7922 (unsigned) transform->minlen,
7923 (unsigned) transform->ivlen,
7924 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007925
7926 /*
7927 * Finally setup the cipher contexts, IVs and MAC secrets.
7928 */
7929#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931 key1 = keyblk + mac_key_len * 2;
7932 key2 = keyblk + mac_key_len * 2 + keylen;
7933
7934 mac_enc = keyblk;
7935 mac_dec = keyblk + mac_key_len;
7936
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 iv_copy_len = (transform->fixed_ivlen) ?
7938 transform->fixed_ivlen : transform->ivlen;
7939 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7940 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7941 iv_copy_len);
7942 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007943#endif /* MBEDTLS_SSL_CLI_C */
7944#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007946 key1 = keyblk + mac_key_len * 2 + keylen;
7947 key2 = keyblk + mac_key_len * 2;
7948
7949 mac_enc = keyblk + mac_key_len;
7950 mac_dec = keyblk;
7951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 iv_copy_len = (transform->fixed_ivlen) ?
7953 transform->fixed_ivlen : transform->ivlen;
7954 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7955 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7956 iv_copy_len);
7957 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007958#endif /* MBEDTLS_SSL_SRV_C */
7959 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007961 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7962 goto end;
7963 }
7964
Paul Elliott4fb19552023-10-18 12:15:30 +01007965 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 ssl->f_export_keys(ssl->p_export_keys,
7967 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7968 master, 48,
7969 randbytes + 32,
7970 randbytes,
7971 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007972 }
7973
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007974 transform->psa_alg = alg;
7975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7977 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7978 psa_set_key_algorithm(&attributes, alg);
7979 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if ((status = psa_import_key(&attributes,
7982 key1,
7983 PSA_BITS_TO_BYTES(key_bits),
7984 &transform->psa_key_enc)) != PSA_SUCCESS) {
7985 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007986 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007988 goto end;
7989 }
7990
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007992
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if ((status = psa_import_key(&attributes,
7994 key2,
7995 PSA_BITS_TO_BYTES(key_bits),
7996 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007997 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007999 goto end;
8000 }
8001 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008002
Neil Armstrong29c0c042022-03-17 17:47:28 +01008003#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8004 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8005 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008008
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8010 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8011 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 if ((status = psa_import_key(&attributes,
8014 mac_enc, mac_key_len,
8015 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008016 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008018 goto end;
8019 }
8020
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8022 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008023#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008025#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008027 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8029 PSA_KEY_USAGE_VERIFY_HASH);
8030 } else {
8031 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8032 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if ((status = psa_import_key(&attributes,
8035 mac_dec, mac_key_len,
8036 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008037 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008039 goto end;
8040 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008041 }
8042#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8043
8044 ((void) mac_dec);
8045 ((void) mac_enc);
8046
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008047end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8049 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008050}
8051
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008052#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008053int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 psa_pake_operation_t *pake_ctx,
8055 const unsigned char *buf,
8056 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008057{
8058 psa_status_t status;
8059 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008060 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008061 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8062 * At round two perform a single cycle
8063 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008065
Gilles Peskine449bd832023-01-11 14:50:10 +01008066 for (; remaining_steps > 0; remaining_steps--) {
8067 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008068 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008070 /* Length is stored at the first byte */
8071 size_t length = buf[input_offset];
8072 input_offset += 1;
8073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008075 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8076 }
8077
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 status = psa_pake_input(pake_ctx, step,
8079 buf + input_offset, length);
8080 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008081 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008082 }
8083
8084 input_offset += length;
8085 }
8086 }
8087
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008089 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008091
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008093}
8094
Valerio Setti6b3dab02022-11-17 17:14:54 +01008095int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 psa_pake_operation_t *pake_ctx,
8097 unsigned char *buf,
8098 size_t len, size_t *olen,
8099 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008100{
8101 psa_status_t status;
8102 size_t output_offset = 0;
8103 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008104 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008105 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8106 * At round two perform a single cycle
8107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 for (; remaining_steps > 0; remaining_steps--) {
8111 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8112 step <= PSA_PAKE_STEP_ZK_PROOF;
8113 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008114 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008115 * For each step, prepend 1 byte with the length of the data as
8116 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008117 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 status = psa_pake_output(pake_ctx, step,
8119 buf + output_offset + 1,
8120 len - output_offset - 1,
8121 &output_len);
8122 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008123 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008124 }
8125
Valerio Setti99d88c12022-11-22 16:03:43 +01008126 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008127
8128 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008129 }
8130 }
8131
8132 *olen = output_offset;
8133
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008135}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008136#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8139 unsigned char *hash, size_t *hashlen,
8140 unsigned char *data, size_t data_len,
8141 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008142{
8143 psa_status_t status;
8144 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008145 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 if ((status = psa_hash_setup(&hash_operation,
8150 hash_alg)) != PSA_SUCCESS) {
8151 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008152 goto exit;
8153 }
8154
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8156 64)) != PSA_SUCCESS) {
8157 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008158 goto exit;
8159 }
8160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 if ((status = psa_hash_update(&hash_operation,
8162 data, data_len)) != PSA_SUCCESS) {
8163 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008164 goto exit;
8165 }
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8168 hashlen)) != PSA_SUCCESS) {
8169 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8170 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008171 }
8172
8173exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 if (status != PSA_SUCCESS) {
8175 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8176 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8177 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008178 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008180 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8181 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008183 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008185 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008187 }
8188 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008190}
8191
Jerry Yuee40f9d2022-02-17 14:55:16 +08008192
Jerry Yud9d91da2022-02-17 14:57:06 +08008193#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8194
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008195/* Find the preferred hash for a given signature algorithm. */
8196unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 mbedtls_ssl_context *ssl,
8198 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008199{
Gabor Mezei078e8032022-04-27 21:17:56 +02008200 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008201 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8204 return MBEDTLS_SSL_HASH_NONE;
8205 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008206
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008208 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8210 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008211 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8213 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008214
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008215 mbedtls_md_type_t md_alg =
8216 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8217 if (md_alg == MBEDTLS_MD_NONE) {
8218 continue;
8219 }
8220
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008223 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008224 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008225
Gilles Peskine449bd832023-01-11 14:50:10 +01008226 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8227 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8228 PSA_ALG_ECDSA(psa_hash_alg),
8229 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008230 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008232
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8234 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8235 PSA_ALG_RSA_PKCS1V15_SIGN(
8236 psa_hash_alg),
8237 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008238 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008240 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008241
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008243 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008244 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008247}
8248
8249#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8250
Jerry Yudc7bd172022-02-17 13:44:15 +08008251#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8252
XiaokangQian75d40ef2022-04-20 11:05:24 +00008253int mbedtls_ssl_validate_ciphersuite(
8254 const mbedtls_ssl_context *ssl,
8255 const mbedtls_ssl_ciphersuite_t *suite_info,
8256 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008258{
8259 (void) ssl;
8260
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 if (suite_info == NULL) {
8262 return -1;
8263 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008264
Gilles Peskine449bd832023-01-11 14:50:10 +01008265 if ((suite_info->min_tls_version > max_tls_version) ||
8266 (suite_info->max_tls_version < min_tls_version)) {
8267 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008268 }
8269
XiaokangQian060d8672022-04-21 09:24:56 +00008270#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008271#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008273 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008275 }
8276#endif
8277
8278 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8279#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8281 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8282 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008283 }
8284#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8285#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8286
Gilles Peskine449bd832023-01-11 14:50:10 +01008287 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008288}
8289
Ronald Crone68ab4f2022-10-05 12:46:29 +02008290#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008291/*
8292 * Function for writing a signature algorithm extension.
8293 *
8294 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8295 * value (TLS 1.3 RFC8446):
8296 * enum {
8297 * ....
8298 * ecdsa_secp256r1_sha256( 0x0403 ),
8299 * ecdsa_secp384r1_sha384( 0x0503 ),
8300 * ecdsa_secp521r1_sha512( 0x0603 ),
8301 * ....
8302 * } SignatureScheme;
8303 *
8304 * struct {
8305 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8306 * } SignatureSchemeList;
8307 *
8308 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8309 * value (TLS 1.2 RFC5246):
8310 * enum {
8311 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8312 * sha512(6), (255)
8313 * } HashAlgorithm;
8314 *
8315 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8316 * SignatureAlgorithm;
8317 *
8318 * struct {
8319 * HashAlgorithm hash;
8320 * SignatureAlgorithm signature;
8321 * } SignatureAndHashAlgorithm;
8322 *
8323 * SignatureAndHashAlgorithm
8324 * supported_signature_algorithms<2..2^16-2>;
8325 *
8326 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8327 * generalization of the TLS 1.2 signature algorithm extension.
8328 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8329 * `SignatureScheme` field of TLS 1.3
8330 *
8331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008332int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8333 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008334{
8335 unsigned char *p = buf;
8336 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8337 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8338
8339 *out_len = 0;
8340
Gilles Peskine449bd832023-01-11 14:50:10 +01008341 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008342
8343 /* Check if we have space for header and length field:
8344 * - extension_type (2 bytes)
8345 * - extension_data_length (2 bytes)
8346 * - supported_signature_algorithms_length (2 bytes)
8347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008348 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008349 p += 6;
8350
8351 /*
8352 * Write supported_signature_algorithms
8353 */
8354 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8356 if (sig_alg == NULL) {
8357 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8358 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008359
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8361 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8362 *sig_alg,
8363 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8364 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008365 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 }
8367 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8368 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008369 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8371 *sig_alg,
8372 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008373 }
8374
8375 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008376 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 if (supported_sig_alg_len == 0) {
8378 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8379 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008380 }
8381
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8383 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8384 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008385
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008386 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008387
8388#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008390#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008391
Gilles Peskine449bd832023-01-11 14:50:10 +01008392 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008393}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008394#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008395
XiaokangQian40a35232022-05-07 09:02:40 +00008396#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008397/*
8398 * mbedtls_ssl_parse_server_name_ext
8399 *
8400 * Structure of server_name extension:
8401 *
8402 * enum {
8403 * host_name(0), (255)
8404 * } NameType;
8405 * opaque HostName<1..2^16-1>;
8406 *
8407 * struct {
8408 * NameType name_type;
8409 * select (name_type) {
8410 * case host_name: HostName;
8411 * } name;
8412 * } ServerName;
8413 * struct {
8414 * ServerName server_name_list<1..2^16-1>
8415 * } ServerNameList;
8416 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008417MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008418int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8419 const unsigned char *buf,
8420 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008421{
8422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8423 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008424 size_t server_name_list_len, hostname_len;
8425 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008426
Gilles Peskine449bd832023-01-11 14:50:10 +01008427 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008428
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8430 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008431 p += 2;
8432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008434 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 while (p < server_name_list_end) {
8436 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8437 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8438 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8439 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008440
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008442 /* sni_name is intended to be used only during the parsing of the
8443 * ClientHello message (it is reset to NULL before the end of
8444 * the message parsing). Thus it is ok to just point to the
8445 * reception buffer and not make a copy of it.
8446 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008447 ssl->handshake->sni_name = p + 3;
8448 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008449 if (ssl->conf->f_sni == NULL) {
8450 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008451 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8453 ssl, p + 3, hostname_len);
8454 if (ret != 0) {
8455 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8456 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8457 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8458 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8459 }
8460 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008461 }
8462
8463 p += hostname_len + 3;
8464 }
8465
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008467}
8468#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8469
XiaokangQianacb39922022-06-17 10:18:48 +00008470#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008472int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8473 const unsigned char *buf,
8474 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008475{
8476 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008477 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008478 const unsigned char *protocol_name_list;
8479 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008480 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008481
8482 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 if (ssl->conf->alpn_list == NULL) {
8484 return 0;
8485 }
XiaokangQianacb39922022-06-17 10:18:48 +00008486
8487 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008488 * RFC7301, section 3.1
8489 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008490 *
XiaokangQianc7403452022-06-23 03:24:12 +00008491 * struct {
8492 * ProtocolName protocol_name_list<2..2^16-1>
8493 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008494 */
8495
XiaokangQianc7403452022-06-23 03:24:12 +00008496 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008497 * protocol_name_list_len 2 bytes
8498 * protocol_name_len 1 bytes
8499 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008502
Gilles Peskine449bd832023-01-11 14:50:10 +01008503 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008504 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008505 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008506 protocol_name_list = p;
8507 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008508
8509 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008511 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8513 protocol_name_len);
8514 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008515 MBEDTLS_SSL_PEND_FATAL_ALERT(
8516 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8518 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008519 }
8520
8521 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008522 }
8523
8524 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8526 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008527 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008529 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 if (protocol_name_len == alpn_len &&
8531 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008532 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008534 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008535
8536 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008537 }
8538 }
8539
XiaokangQian95d5f542022-06-24 02:29:26 +00008540 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008541 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8543 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8544 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008545}
8546
Gilles Peskine449bd832023-01-11 14:50:10 +01008547int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8548 unsigned char *buf,
8549 unsigned char *end,
8550 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008551{
8552 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008553 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008554 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008555
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 if (ssl->alpn_chosen == NULL) {
8557 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008558 }
8559
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 protocol_name_len = strlen(ssl->alpn_chosen);
8561 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008562
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008564 /*
8565 * 0 . 1 ext identifier
8566 * 2 . 3 ext length
8567 * 4 . 5 protocol list length
8568 * 6 . 6 protocol name length
8569 * 7 . 7+n protocol name
8570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008572
XiaokangQian95d5f542022-06-24 02:29:26 +00008573 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008574
Gilles Peskine449bd832023-01-11 14:50:10 +01008575 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8576 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008577 /* Note: the length of the chosen protocol has been checked to be less
8578 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008581
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008583
8584#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008586#endif
8587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008589}
8590#endif /* MBEDTLS_SSL_ALPN */
8591
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008592#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008593 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008594 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008595 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008596int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8597 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008598{
8599 /* Initialize to suppress unnecessary compiler warning */
8600 size_t hostname_len = 0;
8601
8602 /* Check if new hostname is valid before
8603 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 if (hostname != NULL) {
8605 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008606
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8609 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008610 }
8611
8612 /* Now it's clear that we will overwrite the old hostname,
8613 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008614 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008615 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008617 }
8618
8619 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008621 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 } else {
8623 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8624 if (session->hostname == NULL) {
8625 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8626 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008629 }
8630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008632}
Xiaokang Qian03409292022-10-12 02:49:52 +00008633#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8634 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008635 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008636 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008637
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008638#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8639 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008640int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8641 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008642{
8643 size_t alpn_len = 0;
8644
8645 if (alpn != NULL) {
8646 alpn_len = strlen(alpn);
8647
8648 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8650 }
8651 }
8652
8653 if (session->ticket_alpn != NULL) {
8654 mbedtls_zeroize_and_free(session->ticket_alpn,
8655 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008656 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008657 }
8658
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008659 if (alpn != NULL) {
8660 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008661 if (session->ticket_alpn == NULL) {
8662 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8663 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008664 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008665 }
8666
8667 return 0;
8668}
8669#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008670
8671/*
8672 * The following functions are used by 1.2 and 1.3, client and server.
8673 */
8674#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8675int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8676 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8677 int recv_endpoint,
8678 mbedtls_ssl_protocol_version tls_version,
8679 uint32_t *flags)
8680{
8681 int ret = 0;
8682 unsigned int usage = 0;
8683 const char *ext_oid;
8684 size_t ext_len;
8685
8686 /*
8687 * keyUsage
8688 */
8689
8690 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8691 * to check what a compliant client will think while choosing which cert
8692 * to send to the client. */
8693#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8694 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8695 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8696 /* TLS 1.2 server part of the key exchange */
8697 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008698 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8699 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8700 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8701 break;
8702
8703 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8704 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8705 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8706 break;
8707
8708 /* Don't use default: we want warnings when adding new values */
8709 case MBEDTLS_KEY_EXCHANGE_NONE:
8710 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008711 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8712 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8713 usage = 0;
8714 }
8715 } else
8716#endif
8717 {
8718 /* This is either TLS 1.3 authentication, which always uses signatures,
8719 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8720 * options we implement, both using signatures. */
8721 (void) tls_version;
8722 (void) ciphersuite;
8723 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8724 }
8725
8726 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8727 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8728 ret = -1;
8729 }
8730
8731 /*
8732 * extKeyUsage
8733 */
8734
8735 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8736 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8737 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8738 } else {
8739 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8740 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8741 }
8742
8743 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8744 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8745 ret = -1;
8746 }
8747
8748 return ret;
8749}
8750
8751int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8752 int authmode,
8753 mbedtls_x509_crt *chain,
8754 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8755 void *rs_ctx)
8756{
8757 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8758 return 0;
8759 }
8760
8761 /*
8762 * Primary check: use the appropriate X.509 verification function
8763 */
8764 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8765 void *p_vrfy;
8766 if (ssl->f_vrfy != NULL) {
8767 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8768 f_vrfy = ssl->f_vrfy;
8769 p_vrfy = ssl->p_vrfy;
8770 } else {
8771 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8772 f_vrfy = ssl->conf->f_vrfy;
8773 p_vrfy = ssl->conf->p_vrfy;
8774 }
8775
8776 int ret = 0;
8777 int have_ca_chain_or_callback = 0;
8778#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8779 if (ssl->conf->f_ca_cb != NULL) {
8780 ((void) rs_ctx);
8781 have_ca_chain_or_callback = 1;
8782
8783 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8784 ret = mbedtls_x509_crt_verify_with_ca_cb(
8785 chain,
8786 ssl->conf->f_ca_cb,
8787 ssl->conf->p_ca_cb,
8788 ssl->conf->cert_profile,
8789 ssl->hostname,
8790 &ssl->session_negotiate->verify_result,
8791 f_vrfy, p_vrfy);
8792 } else
8793#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8794 {
8795 mbedtls_x509_crt *ca_chain;
8796 mbedtls_x509_crl *ca_crl;
8797#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8798 if (ssl->handshake->sni_ca_chain != NULL) {
8799 ca_chain = ssl->handshake->sni_ca_chain;
8800 ca_crl = ssl->handshake->sni_ca_crl;
8801 } else
8802#endif
8803 {
8804 ca_chain = ssl->conf->ca_chain;
8805 ca_crl = ssl->conf->ca_crl;
8806 }
8807
8808 if (ca_chain != NULL) {
8809 have_ca_chain_or_callback = 1;
8810 }
8811
8812 ret = mbedtls_x509_crt_verify_restartable(
8813 chain,
8814 ca_chain, ca_crl,
8815 ssl->conf->cert_profile,
8816 ssl->hostname,
8817 &ssl->session_negotiate->verify_result,
8818 f_vrfy, p_vrfy, rs_ctx);
8819 }
8820
8821 if (ret != 0) {
8822 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8823 }
8824
8825#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8826 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8827 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8828 }
8829#endif
8830
8831 /*
8832 * Secondary checks: always done, but change 'ret' only if it was 0
8833 */
8834
8835 /* With TLS 1.2 and ECC certs, check that the curve used by the
8836 * certificate is on our list of acceptable curves.
8837 *
8838 * With TLS 1.3 this is not needed because the curve is part of the
8839 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8840 * we validate the signature made with the key associated to this cert.
8841 */
8842#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8843 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8844 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8845 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8846 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8847 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8848 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8849 if (ret == 0) {
8850 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8851 }
8852 }
8853 }
8854#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8855
8856 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8857 if (mbedtls_ssl_check_cert_usage(chain,
8858 ciphersuite_info,
8859 ssl->conf->endpoint,
8860 ssl->tls_version,
8861 &ssl->session_negotiate->verify_result) != 0) {
8862 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8863 if (ret == 0) {
8864 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8865 }
8866 }
8867
8868 /* With authmode optional, we want to keep going if the certificate was
8869 * unacceptable, but still fail on other errors (out of memory etc),
8870 * including fatal errors from the f_vrfy callback.
8871 *
8872 * The only acceptable errors are:
8873 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8874 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8875 * Anything else is a fatal error. */
8876 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8877 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8878 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8879 ret = 0;
8880 }
8881
8882 /* Return a specific error as this is a user error: inconsistent
8883 * configuration - can't verify without trust anchors. */
8884 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8885 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8886 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8887 }
8888
8889 if (ret != 0) {
8890 uint8_t alert;
8891
8892 /* The certificate may have been rejected for several reasons.
8893 Pick one and send the corresponding alert. Which alert to send
8894 may be a subject of debate in some cases. */
8895 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8896 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8897 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8898 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8899 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8900 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8901 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8902 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8903 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8904 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8905 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8906 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8907 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8908 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8909 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8910 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8911 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8912 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8913 } else {
8914 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8915 }
8916 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8917 alert);
8918 }
8919
8920#if defined(MBEDTLS_DEBUG_C)
8921 if (ssl->session_negotiate->verify_result != 0) {
8922 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8923 (unsigned int) ssl->session_negotiate->verify_result));
8924 } else {
8925 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8926 }
8927#endif /* MBEDTLS_DEBUG_C */
8928
8929 return ret;
8930}
8931#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8932
Max Fillinger2fe35f62024-10-25 00:52:24 +02008933#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008934
Max Fillinger29beade2024-09-21 11:06:28 +02008935#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008936static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8937 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008938 uint8_t *out,
8939 const size_t key_len,
8940 const char *label,
8941 const size_t label_len,
8942 const unsigned char *context,
8943 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008944 const int use_context)
8945{
8946 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008947 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008948
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008949 /* The input to the PRF is client_random, then server_random.
8950 * If a context is provided, this is then followed by the context length
8951 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008952 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8953 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008954 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02008955 if (context_len > UINT16_MAX) {
8956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8957 }
8958
8959 /* This does not overflow a 32-bit size_t because the current value of
8960 * prf_input_len is 64 (length of client_random + server_random) and
8961 * context_len fits into two bytes (checked above). */
8962 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008963 }
Max Fillinger155cea02024-10-23 16:32:54 +02008964
8965 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
8966 if (prf_input == NULL) {
8967 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8968 }
8969
8970 memcpy(prf_input,
8971 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
8972 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
8973 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
8974 ssl->transform->randbytes,
8975 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
8976 if (use_context) {
8977 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
8978 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
8979 }
8980 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02008981 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008982 prf_input, prf_input_len,
8983 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008984 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008985 return ret;
8986}
Max Fillinger281fb792024-10-23 18:35:09 +02008987#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008988
Max Fillinger29beade2024-09-21 11:06:28 +02008989#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008990static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
8991 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008992 uint8_t *out,
8993 const size_t key_len,
8994 const char *label,
8995 const size_t label_len,
8996 const unsigned char *context,
8997 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008998{
8999 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9000 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9001 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9002
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009003 /* The length of the label must be at most 250 bytes to fit into the HkdfLabel
9004 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009005 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009006 * The length of the context is unlimited even though the context field in the
9007 * struct can only hold up to 256 bytes. This is because we place a *hash* of
9008 * the context in the field. */
9009 if (label_len > 250) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9011 }
9012
9013 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009014 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009015 context, context_len, out, key_len);
9016}
Max Fillinger281fb792024-10-23 18:35:09 +02009017#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009018
9019int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009020 uint8_t *out, const size_t key_len,
9021 const char *label, const size_t label_len,
9022 const unsigned char *context, const size_t context_len,
9023 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009024{
9025 if (!mbedtls_ssl_is_handshake_over(ssl)) {
9026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9027 }
9028
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009029 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9031 }
9032
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009033 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9034 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9035 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9036
9037 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009039 case MBEDTLS_SSL_VERSION_TLS1_2:
9040 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9041 label, label_len,
9042 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009043#endif
9044#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009045 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009046 return mbedtls_ssl_tls13_export_keying_material(ssl,
9047 hash_alg,
9048 out,
9049 key_len,
9050 label,
9051 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009052 use_context ? context : NULL,
9053 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009054#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009055 default:
9056 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9057 }
9058}
9059
Max Fillinger2fe35f62024-10-25 00:52:24 +02009060#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009062#endif /* MBEDTLS_SSL_TLS_C */