blob: 4744db3d49f00ea07f711da6f27ac41bdc389d79 [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"
Andrzej Kurek25f27152022-08-17 16:09:31 -040021
Valerio Settib4f50762024-01-17 10:24:52 +010022#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050024#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010025#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Valerio Setti384fbde2024-01-02 13:26:40 +010030#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020031#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050033#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define local translating functions to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050048
Ronald Cronad8c17b2022-06-10 17:18:09 +020049#if defined(MBEDTLS_TEST_HOOKS)
50static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
51
52void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010053 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020054{
55 chk_buf_ptr_fail_args.cur = cur;
56 chk_buf_ptr_fail_args.end = end;
57 chk_buf_ptr_fail_args.need = need;
58}
59
Gilles Peskine449bd832023-01-11 14:50:10 +010060void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020061{
Gilles Peskine449bd832023-01-11 14:50:10 +010062 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020063}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return (chk_buf_ptr_fail_args.cur != args->cur) ||
68 (chk_buf_ptr_fail_args.end != args->end) ||
69 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020070}
71#endif /* MBEDTLS_TEST_HOOKS */
72
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010074
Hanno Beckera0e20d02019-05-15 14:03:01 +010075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010076/* Top-level Connection ID API */
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
79 size_t len,
80 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
83 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
84 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
87 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010089 }
90
91 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010092 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010094}
95
Gilles Peskine449bd832023-01-11 14:50:10 +010096int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
97 int enable,
98 unsigned char const *own_cid,
99 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100{
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
103 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100104
Hanno Beckerca092242019-04-25 16:01:49 +0100105 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (enable == MBEDTLS_SSL_CID_DISABLED) {
107 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
108 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100109 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
111 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100112
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (own_cid_len != ssl->conf->cid_len) {
114 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
115 (unsigned) own_cid_len,
116 (unsigned) ssl->conf->cid_len));
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100121 /* Truncation is not an issue here because
122 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
123 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100126}
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
129 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100130 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000132{
133 *enabled = MBEDTLS_SSL_CID_DISABLED;
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
137 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000138
139 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
140 * zero as this is indistinguishable from not requesting to use
141 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
143 return 0;
144 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000147 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (own_cid != NULL) {
149 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 }
152
153 *enabled = MBEDTLS_SSL_CID_ENABLED;
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000156}
157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
159 int *enabled,
160 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
161 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100162{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100164
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
166 mbedtls_ssl_is_handshake_over(ssl) == 0) {
167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100168 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Beckerc5f24222019-05-03 12:54:52 +0100170 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
171 * were used, but client and server requested the empty CID.
172 * This is indistinguishable from not using the CID extension
173 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 if (ssl->transform_in->in_cid_len == 0 &&
175 ssl->transform_in->out_cid_len == 0) {
176 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177 }
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100180 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (peer_cid != NULL) {
182 memcpy(peer_cid, ssl->transform_in->out_cid,
183 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100184 }
185 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186
187 *enabled = MBEDTLS_SSL_CID_ENABLED;
188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100190}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196/*
197 * Convert max_fragment_length codes to length.
198 * RFC 6066 says:
199 * enum{
200 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
201 * } MaxFragmentLength;
202 * and we add 0 -> extension unused
203 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205{
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 switch (mfl) {
207 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
208 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
209 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
210 return 512;
211 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
212 return 1024;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
214 return 2048;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
216 return 4096;
217 default:
218 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000219 }
220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
224 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200225{
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_ssl_session_free(dst);
227 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800228#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
229 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000230#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
231 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000232 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800233#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800235
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000236#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
237 defined(MBEDTLS_SSL_EARLY_DATA)
238 dst->ticket_alpn = NULL;
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
279 defined(MBEDTLS_SSL_EARLY_DATA)
280 {
281 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
282 if (ret != 0) {
283 return ret;
284 }
285 }
286#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800320 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100329 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330
331 *buffer = resized_buffer;
332 *len_old = len_new;
333
334 return 0;
335}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
338 size_t in_buf_new_len,
339 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340{
341 int modified = 0;
342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
343 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 written_in = ssl->in_msg - ssl->in_buf;
346 iv_offset_in = ssl->in_iv - ssl->in_buf;
347 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200349 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 ssl->in_buf_len < in_buf_new_len) {
351 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
352 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
353 } else {
354 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
355 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200356 modified = 1;
357 }
358 }
359 }
360
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200362 written_out = ssl->out_msg - ssl->out_buf;
363 iv_offset_out = ssl->out_iv - ssl->out_buf;
364 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200366 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 ssl->out_buf_len < out_buf_new_len) {
368 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
369 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
370 } else {
371 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
372 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200373 modified = 1;
374 }
375 }
376 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Fields below might not be properly updated with record
381 * splitting or with CID, so they are manually updated here. */
382 ssl->out_msg = ssl->out_buf + written_out;
383 ssl->out_len = ssl->out_buf + len_offset_out;
384 ssl->out_iv = ssl->out_buf + iv_offset_out;
385
386 ssl->in_msg = ssl->in_buf + written_in;
387 ssl->in_len = ssl->in_buf + len_offset_in;
388 ssl->in_iv = ssl->in_buf + iv_offset_in;
389 }
390}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500391#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
392
Jerry Yudb8c48a2022-01-27 14:54:54 +0800393#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800394
395#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100396typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
397 const char *label,
398 const unsigned char *random, size_t rlen,
399 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800400
Gilles Peskine449bd832023-01-11 14:50:10 +0100401static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800402
403#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
404
405/* Type for the TLS PRF */
406typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
407 const unsigned char *, size_t,
408 unsigned char *, size_t);
409
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200410MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100411static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
412 int ciphersuite,
413 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200416#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 ssl_tls_prf_t tls_prf,
418 const unsigned char randbytes[64],
419 mbedtls_ssl_protocol_version tls_version,
420 unsigned endpoint,
421 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800422
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100423#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200424MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100425static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300426 const char *label,
427 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100429static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
430static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100431
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100432#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100433
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100434#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100435MBEDTLS_CHECK_RETURN_CRITICAL
436static int tls_prf_sha384(const unsigned char *secret, size_t slen,
437 const char *label,
438 const unsigned char *random, size_t rlen,
439 unsigned char *dstbuf, size_t dlen);
440
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100441static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
442static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100443#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445MBEDTLS_CHECK_RETURN_CRITICAL
446static int ssl_tls12_session_load(mbedtls_ssl_session *session,
447 const unsigned char *buf,
448 size_t len);
449#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
450
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100451static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100452
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100453#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100454static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100455#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100457#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100459#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
461int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
462 const unsigned char *secret, size_t slen,
463 const char *label,
464 const unsigned char *random, size_t rlen,
465 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300466{
467 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
468
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300470#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100471#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472 case MBEDTLS_SSL_TLS_PRF_SHA384:
473 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100476#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA256:
478 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300481#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 default:
483 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300484 }
485
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487}
488
Jerry Yuc73c6182022-02-08 20:29:25 +0800489#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100490static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800491{
492#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 if (session->peer_cert != NULL) {
494 mbedtls_x509_crt_free(session->peer_cert);
495 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800496 session->peer_cert = NULL;
497 }
498#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800502 session->peer_cert_digest = NULL;
503 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
504 session->peer_cert_digest_len = 0;
505 }
506#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
507}
508#endif /* MBEDTLS_X509_CRT_PARSE_C */
509
Gilles Peskine449bd832023-01-11 14:50:10 +0100510uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800511{
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800513 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800515
516 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800518
519 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800521
522 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800524
525 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800527
528 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
Jan Bruckner151f6422023-02-10 12:45:19 +0100591 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
592 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
593
Jerry Yu7a485c12022-10-31 13:08:18 +0800594 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
597 }
598
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600}
601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800603{
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Jerry Yud25cab02022-10-31 12:48:30 +0800607#if defined(MBEDTLS_DEBUG_C)
608static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800609 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800610 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
611 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
612 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
613 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
614 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
615 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
616 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
617 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
618 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
619 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
620 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
621 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
622 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
623 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
624 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
625 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
626 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
627 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
628 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
629 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
630 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
631 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
632 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
633 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
634 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
635 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100636 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
637 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800638};
639
Chien Wong4e9683e2023-12-28 17:07:43 +0800640static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800641 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
642 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
643 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
644 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
645 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
646 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
647 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
648 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
649 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
650 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
651 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
652 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
653 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
654 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
655 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
656 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
657 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
658 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
659 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
660 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
661 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
662 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
663 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
664 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
665 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
666 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
667 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100668 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
669 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800670};
671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800673{
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return extension_name_table[
675 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800676}
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800679{
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800681 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800683 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800697}
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
700 int level, const char *file, int line,
701 int hs_msg_type, unsigned int extension_type,
702 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800703{
704 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800706 mbedtls_debug_print_msg(
707 ssl, level, file, line,
708 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 ssl_tls13_get_hs_msg_name(hs_msg_type),
710 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800711 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800713 return;
714 }
715
716 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800718 mbedtls_debug_print_msg(
719 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
721 mbedtls_ssl_get_extension_name(extension_type), extension_type,
722 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800723 return;
724 }
725
726 mbedtls_debug_print_msg(
727 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
729 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800730}
731
Gilles Peskine449bd832023-01-11 14:50:10 +0100732void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
733 int level, const char *file, int line,
734 int hs_msg_type, uint32_t extensions_mask,
735 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800736{
737
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 for (unsigned i = 0;
739 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
740 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800741 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800742 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800744 }
745}
746
Pengyu Lvee455c02023-01-12 14:37:24 +0800747#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800748static const char *ticket_flag_name_table[] =
749{
750 [0] = "ALLOW_PSK_RESUMPTION",
751 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
752 [3] = "ALLOW_EARLY_DATA",
753};
754
Pengyu Lv4938a562023-01-16 11:28:49 +0800755void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
756 int level, const char *file, int line,
757 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800758{
759 size_t i;
760
761 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800762 "print ticket_flags (0x%02x)", flags);
763
764 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800765
766 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800768 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
769 ticket_flag_name_table[i]);
770 }
771 }
772}
773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
774
Jerry Yud25cab02022-10-31 12:48:30 +0800775#endif /* MBEDTLS_DEBUG_C */
776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
778 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800779{
780 ((void) ciphersuite_info);
781
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100782#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800784 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800786#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100787#if defined(PSA_WANT_ALG_SHA_256)
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_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
792 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 return;
795 }
796}
797
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100798int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100799 unsigned hs_type,
800 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100801{
802 unsigned char hs_hdr[4];
803
804 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
806 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
807 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
808 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100809
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100810 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100811}
812
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 unsigned hs_type,
815 unsigned char const *msg,
816 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100817{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818 int ret;
819 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100820 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100821 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100822 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824}
825
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100826int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800827{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100828#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100829 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100830 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100831#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800832 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100833#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100834#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
836 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200837 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100838 }
839 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
840 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200841 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800843#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100844#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100854 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800855}
856
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100857static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100858 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800859{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100860#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100861 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100862 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100863#else /* SHA-256 or SHA-384 */
864 ((void) ssl);
865 (void) buf;
866 (void) len;
867#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100868#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100869 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
870 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200871 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100872 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800873#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100874#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100875 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
876 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200877 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100878 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100880 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800881}
882
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100883#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100885 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800886{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200887 return mbedtls_md_error_from_psa(psa_hash_update(
888 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800889}
890#endif
891
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100892#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100893static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100894 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800895{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200896 return mbedtls_md_error_from_psa(psa_hash_update(
897 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800898}
899#endif
900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200902{
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200904
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100905#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500906 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500907#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100908#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500909 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200911
912 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200917#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200918 handshake->psa_pake_ctx = psa_pake_operation_init();
919 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200920#if defined(MBEDTLS_SSL_CLI_C)
921 handshake->ecjpake_cache = NULL;
922 handshake->ecjpake_cache_len = 0;
923#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200924#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200925
Gilles Peskineeccd8882020-03-10 12:19:08 +0100926#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200928#endif
929
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200930#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
931 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
932#endif
Hanno Becker75173122019-02-06 16:18:31 +0000933
934#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
935 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000937#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200938}
939
Gilles Peskine449bd832023-01-11 14:50:10 +0100940void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200941{
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200943
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100944 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
945 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000947#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100948 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
949 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100950#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951}
952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956}
957
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100959static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000960{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
962
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200963 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800964#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 if (ssl->transform_negotiate) {
966 mbedtls_ssl_transform_free(ssl->transform_negotiate);
967 }
Jerry Yu2e199812022-12-01 18:57:19 +0800968#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (ssl->session_negotiate) {
970 mbedtls_ssl_session_free(ssl->session_negotiate);
971 }
972 if (ssl->handshake) {
973 mbedtls_ssl_handshake_free(ssl);
974 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200975
Jerry Yu2e199812022-12-01 18:57:19 +0800976#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977 /*
978 * Either the pointers are now NULL or cleared properly and can be freed.
979 * Now allocate missing structures.
980 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (ssl->transform_negotiate == NULL) {
982 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200983 }
Jerry Yu2e199812022-12-01 18:57:19 +0800984#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 if (ssl->session_negotiate == NULL) {
987 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200988 }
Paul Bakker48916f92012-09-16 19:57:18 +0000989
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (ssl->handshake == NULL) {
991 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200992 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500993#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
994 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400995
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
997 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500998#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000999
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001000 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001002#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001003 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 ssl->session_negotiate == NULL) {
1006 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001010
1011#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001013 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001014#endif
1015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017 ssl->session_negotiate = NULL;
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001020 }
1021
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001022#if defined(MBEDTLS_SSL_EARLY_DATA)
1023#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001024 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001025#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001026#if defined(MBEDTLS_SSL_SRV_C)
1027 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1028#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001029 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001030#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001031
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001032 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 mbedtls_ssl_session_init(ssl->session_negotiate);
1034 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001035
Jerry Yu2e199812022-12-01 18:57:19 +08001036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001038#endif
1039
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001040 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001041 ret = mbedtls_ssl_reset_checksum(ssl);
1042 if (ret != 0) {
1043 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1044 return ret;
1045 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001046
Jerry Yud0766ec2022-09-22 10:46:57 +08001047#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1048 defined(MBEDTLS_SSL_SRV_C) && \
1049 defined(MBEDTLS_SSL_SESSION_TICKETS)
1050 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001051 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001052#endif
1053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001056 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001059 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001065 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001066#endif
1067
Ronald Crone68ab4f2022-10-05 12:46:29 +02001068#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001069#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001070#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001071 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1072 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1074 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001075 const int *md;
1076 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001077 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001078 uint16_t *p;
1079
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001080 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1081 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1082 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1085 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001086 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001088#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001090#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001091
Jerry Yub476a442022-01-21 18:14:45 +08001092#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1096 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1097 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001098 }
1099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1101 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1102 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1105 sizeof(uint16_t));
1106 if (ssl->handshake->sig_algs == NULL) {
1107 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1108 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 p = (uint16_t *) ssl->handshake->sig_algs;
1111 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1112 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1113 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001114 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001116#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001118 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001119#endif
1120#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001122 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001123#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001125 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001128#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001129 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 ssl->handshake->sig_algs_heap_allocated = 0;
1131 }
Jerry Yucc539102022-06-27 16:27:35 +08001132#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001133#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001135}
1136
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001137#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001138/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001139MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001140static int ssl_cookie_write_dummy(void *ctx,
1141 unsigned char **p, unsigned char *end,
1142 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001143{
1144 ((void) ctx);
1145 ((void) p);
1146 ((void) end);
1147 ((void) cli_id);
1148 ((void) cli_id_len);
1149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001151}
1152
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001154static int ssl_cookie_check_dummy(void *ctx,
1155 const unsigned char *cookie, size_t cookie_len,
1156 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001157{
1158 ((void) ctx);
1159 ((void) cookie);
1160 ((void) cookie_len);
1161 ((void) cli_id);
1162 ((void) cli_id_len);
1163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001165}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001166#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167
Paul Bakker5121ce52009-01-03 21:22:43 +00001168/*
1169 * Initialize an SSL context
1170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001171void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001172{
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174}
1175
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001176MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001177static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001178{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001179 const mbedtls_ssl_config *conf = ssl->conf;
1180
Ronald Cron6f135e12021-12-08 16:57:54 +01001181#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1183 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1184 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1185 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001186 }
1187
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1189 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001190 }
1191#endif
1192
1193#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1195 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1196 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001197 }
1198#endif
1199
Ronald Cron6f135e12021-12-08 16:57:54 +01001200#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1202 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1203 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1204 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 }
1206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1208 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001209 }
1210#endif
1211
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1213 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001214}
1215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001216MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001217static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1218{
1219 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 ret = ssl_conf_version_check(ssl);
1221 if (ret != 0) {
1222 return ret;
1223 }
Jerry Yu60835a82021-08-04 10:13:52 +08001224
Yanray Wangb422cab2023-12-01 16:18:10 +08001225 if (ssl->conf->f_rng == NULL) {
1226 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1227 return MBEDTLS_ERR_SSL_NO_RNG;
1228 }
1229
Jerry Yu60835a82021-08-04 10:13:52 +08001230 /* Space for further checks */
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001233}
1234
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001235/*
1236 * Setup an SSL context
1237 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1240 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001241{
Janos Follath865b3eb2019-12-16 11:46:15 +00001242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001243 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1244 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001245
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001246 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if ((ret = ssl_conf_check(ssl)) != 0) {
1249 return ret;
1250 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001251 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001252
Paul Bakker62f2dee2012-09-28 07:31:51 +00001253 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001254 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001255 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001256
1257 /* Set to NULL in case of an error condition */
1258 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001259
Darryl Greenb33cc762019-11-28 14:29:44 +00001260#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1261 ssl->in_buf_len = in_buf_len;
1262#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1264 if (ssl->in_buf == NULL) {
1265 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001266 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001267 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001268 }
1269
Darryl Greenb33cc762019-11-28 14:29:44 +00001270#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1271 ssl->out_buf_len = out_buf_len;
1272#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1274 if (ssl->out_buf == NULL) {
1275 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001276 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001277 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 }
1279
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001281
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001284#endif
1285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001287 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001291
1292error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 mbedtls_free(ssl->in_buf);
1294 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001295
1296 ssl->conf = NULL;
1297
Darryl Greenb33cc762019-11-28 14:29:44 +00001298#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1299 ssl->in_buf_len = 0;
1300 ssl->out_buf_len = 0;
1301#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001302 ssl->in_buf = NULL;
1303 ssl->out_buf = NULL;
1304
1305 ssl->in_hdr = NULL;
1306 ssl->in_ctr = NULL;
1307 ssl->in_len = NULL;
1308 ssl->in_iv = NULL;
1309 ssl->in_msg = NULL;
1310
1311 ssl->out_hdr = NULL;
1312 ssl->out_ctr = NULL;
1313 ssl->out_len = NULL;
1314 ssl->out_iv = NULL;
1315 ssl->out_msg = NULL;
1316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001318}
1319
1320/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001321 * Reset an initialized and used SSL context for re-use while retaining
1322 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001323 *
1324 * If partial is non-zero, keep data in the input buffer and client ID.
1325 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1328 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001329{
Darryl Greenb33cc762019-11-28 14:29:44 +00001330#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1331 size_t in_buf_len = ssl->in_buf_len;
1332 size_t out_buf_len = ssl->out_buf_len;
1333#else
1334 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1335 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1336#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001337
Hanno Beckerb0302c42021-08-03 09:39:42 +01001338#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1339 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001340#endif
1341
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001346
1347 /* Reset incoming message parsing */
1348 ssl->in_offt = NULL;
1349 ssl->nb_zero = 0;
1350 ssl->in_msgtype = 0;
1351 ssl->in_msglen = 0;
1352 ssl->in_hslen = 0;
1353 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;
Gilles Peskine95fe2a62025-02-20 18:12:29 +01001414 ssl->flags = 0;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1527 int (*f_rng)(void *, unsigned char *, size_t),
1528 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001530 conf->f_rng = f_rng;
1531 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1535 void (*f_dbg)(void *, int, const char *, int, const char *),
1536 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001537{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001538 conf->f_dbg = f_dbg;
1539 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001540}
1541
Gilles Peskine449bd832023-01-11 14:50:10 +01001542void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1543 void *p_bio,
1544 mbedtls_ssl_send_t *f_send,
1545 mbedtls_ssl_recv_t *f_recv,
1546 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001547{
1548 ssl->p_bio = p_bio;
1549 ssl->f_send = f_send;
1550 ssl->f_recv = f_recv;
1551 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001552}
1553
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001554#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001555void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001556{
1557 ssl->mtu = mtu;
1558}
1559#endif
1560
Gilles Peskine449bd832023-01-11 14:50:10 +01001561void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001562{
1563 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001564}
1565
Gilles Peskine449bd832023-01-11 14:50:10 +01001566void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1567 void *p_timer,
1568 mbedtls_ssl_set_timer_t *f_set_timer,
1569 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001570{
1571 ssl->p_timer = p_timer;
1572 ssl->f_set_timer = f_set_timer;
1573 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001574
1575 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001577}
1578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001580void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1581 void *p_cache,
1582 mbedtls_ssl_cache_get_t *f_get_cache,
1583 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001584{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001585 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001586 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001587 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001588}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001592int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001593{
Janos Follath865b3eb2019-12-16 11:46:15 +00001594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001597 session == NULL ||
1598 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1600 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001601 }
1602
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 if (ssl->handshake->resume == 1) {
1604 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1605 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001606
Jerry Yu21092062022-10-10 21:21:31 +08001607#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001609#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001610 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001614 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1616 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1617 session->ciphersuite));
1618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001619 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001620#else
1621 /*
1622 * If session tickets are not enabled, it is not possible to resume a
1623 * TLS 1.3 session, thus do not make any change to the SSL context in
1624 * the first place.
1625 */
1626 return 0;
1627#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001628 }
Jerry Yu21092062022-10-10 21:21:31 +08001629#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1632 session)) != 0) {
1633 return ret;
1634 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001635
Paul Bakker0a597072012-09-25 21:55:46 +00001636 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001639}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1643 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001644{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001645 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646}
1647
Ronald Cron6f135e12021-12-08 16:57:54 +01001648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001649void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1650 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001651{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001652 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001653}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001654
1655#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001656void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1657 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001658{
1659 conf->early_data_enabled = early_data_enabled;
1660}
Jerry Yucc4e0072022-11-22 17:22:22 +08001661
1662#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001663void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001665{
Jerry Yu39da9852022-12-06 16:58:36 +08001666 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001667}
1668#endif /* MBEDTLS_SSL_SRV_C */
1669
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001670#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001671#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001674void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1675 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001676{
1677 conf->cert_profile = profile;
1678}
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001681{
1682 mbedtls_ssl_key_cert *cur = key_cert, *next;
1683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001685 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001687 cur = next;
1688 }
1689}
1690
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001691/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001692MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001693static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1694 mbedtls_x509_crt *cert,
1695 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001696{
niisato8ee24222018-06-25 19:05:48 +09001697 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001700 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001702 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001704 }
1705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1707 if (new_cert == NULL) {
1708 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1709 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001710
niisato8ee24222018-06-25 19:05:48 +09001711 new_cert->cert = cert;
1712 new_cert->key = key;
1713 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001714
Glenn Strauss36872db2022-01-22 05:06:31 -05001715 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001717 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001721 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 }
niisato8ee24222018-06-25 19:05:48 +09001723 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001724 }
1725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001727}
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001730 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001732{
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001734}
1735
Gilles Peskine449bd832023-01-11 14:50:10 +01001736void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001737 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001739{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001740 conf->ca_chain = ca_chain;
1741 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1744 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1745 * cannot be used together. */
1746 conf->f_ca_cb = NULL;
1747 conf->p_ca_cb = NULL;
1748#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001749}
Hanno Becker5adaad92019-03-27 16:54:37 +00001750
1751#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001752void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1753 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1754 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001755{
1756 conf->f_ca_cb = f_ca_cb;
1757 conf->p_ca_cb = p_ca_cb;
1758
1759 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1760 * cannot be used together. */
1761 conf->ca_chain = NULL;
1762 conf->ca_crl = NULL;
1763}
1764#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001766
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001767#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001768const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1769 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001770{
1771 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001773}
1774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *own_cert,
1777 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001778{
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1780 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001781}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1784 mbedtls_x509_crt *ca_chain,
1785 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001786{
1787 ssl->handshake->sni_ca_chain = ca_chain;
1788 ssl->handshake->sni_ca_crl = ca_crl;
1789}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001790
Glenn Strauss999ef702022-03-11 01:37:23 -05001791#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1793 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001794{
1795 ssl->handshake->dn_hints = crt;
1796}
1797#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1800 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001801{
1802 ssl->handshake->sni_authmode = authmode;
1803}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001804#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1805
Hanno Becker8927c832019-04-03 12:52:50 +01001806#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001807void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1808 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1809 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001810{
1811 ssl->f_vrfy = f_vrfy;
1812 ssl->p_vrfy = p_vrfy;
1813}
1814#endif
1815
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001816#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001817
Przemek Stekielfde11282023-03-13 16:06:09 +01001818static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1819static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1820
Valerio Setti016f6822022-12-09 14:17:50 +01001821static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 mbedtls_ssl_context *ssl,
1823 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001824{
1825 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001826 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001827 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001828 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001829 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001830 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1832 psa_pake_cs_set_primitive(&cipher_suite,
1833 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1834 PSA_ECC_FAMILY_SECP_R1,
1835 256));
1836 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1839 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001840 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001844 user = jpake_server_id;
1845 user_len = sizeof(jpake_server_id);
1846 peer = jpake_client_id;
1847 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001849 user = jpake_client_id;
1850 user_len = sizeof(jpake_client_id);
1851 peer = jpake_server_id;
1852 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001854
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001855 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1856 if (status != PSA_SUCCESS) {
1857 return status;
1858 }
1859
1860 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001862 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 }
Valerio Setti016f6822022-12-09 14:17:50 +01001864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1866 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001867 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 }
Valerio Setti016f6822022-12-09 14:17:50 +01001869
1870 ssl->handshake->psa_pake_ctx_is_ok = 1;
1871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001873}
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1876 const unsigned char *pw,
1877 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001878{
1879 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1880 psa_status_t status;
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 if (ssl->handshake == NULL || ssl->conf == NULL) {
1883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001884 }
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 /* Empty password is not valid */
1887 if ((pw == NULL) || (pw_len == 0)) {
1888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1889 }
1890
1891 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1892 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1893 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1894
1895 status = psa_import_key(&attributes, pw, pw_len,
1896 &ssl->handshake->psa_pake_password);
1897 if (status != PSA_SUCCESS) {
1898 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1899 }
1900
1901 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1902 ssl->handshake->psa_pake_password);
1903 if (status != PSA_SUCCESS) {
1904 psa_destroy_key(ssl->handshake->psa_pake_password);
1905 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1906 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1907 }
1908
1909 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001910}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1913 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001914{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001915 psa_status_t status;
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (ssl->handshake == NULL || ssl->conf == NULL) {
1918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001919 }
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (mbedtls_svc_key_id_is_null(pwd)) {
1922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1923 }
1924
1925 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1926 if (status != PSA_SUCCESS) {
1927 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1928 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1929 }
1930
1931 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001932}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001933#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001934
Ronald Cron73fe8df2022-10-05 14:31:43 +02001935#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001936int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001937{
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (conf->psk_identity == NULL ||
1939 conf->psk_identity_len == 0) {
1940 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001941 }
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1944 return 1;
1945 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001946
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 if (conf->psk != NULL && conf->psk_len != 0) {
1948 return 1;
1949 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001952}
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001955{
1956 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958 /* The maintenance of the PSK key slot is the
1959 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001960 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001963 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001964 conf->psk = NULL;
1965 conf->psk_len = 0;
1966 }
1967
1968 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (conf->psk_identity != NULL) {
1970 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001971 conf->psk_identity = NULL;
1972 conf->psk_identity_len = 0;
1973 }
1974}
1975
Hanno Becker7390c712018-11-15 13:33:04 +00001976/* This function assumes that PSK identity in the SSL config is unset.
1977 * It checks that the provided identity is well-formed and attempts
1978 * to make a copy of it in the SSL config.
1979 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001980MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001981static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1982 unsigned char const *psk_identity,
1983 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001984{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001985 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001987 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 (psk_identity_len >> 16) != 0 ||
1989 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001991 }
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1994 if (conf->psk_identity == NULL) {
1995 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1996 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001997
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001998 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002000
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002002}
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2005 const unsigned char *psk, size_t psk_len,
2006 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002007{
Janos Follath865b3eb2019-12-16 11:46:15 +00002008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002009
2010 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2012 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2013 }
Hanno Becker7390c712018-11-15 13:33:04 +00002014
2015 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (psk == NULL) {
2017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2018 }
2019 if (psk_len == 0) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2024 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2027 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2028 }
Hanno Becker7390c712018-11-15 13:33:04 +00002029 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002031
2032 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2034 if (ret != 0) {
2035 ssl_conf_remove_psk(conf);
2036 }
Hanno Becker7390c712018-11-15 13:33:04 +00002037
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002039}
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002042{
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 /* The maintenance of the external PSK key slot is the
2045 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (ssl->handshake->psk_opaque_is_internal) {
2047 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002048 ssl->handshake->psk_opaque_is_internal = 0;
2049 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002050 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002051 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002052}
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2055 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056{
Neil Armstrong501c9322022-05-03 09:35:09 +02002057 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002058 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002059 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002060 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (psk == NULL || ssl->handshake == NULL) {
2063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2064 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2067 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2068 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002071
Jerry Yuccc68a42022-07-26 16:39:20 +08002072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2074 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2075 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2076 } else {
2077 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2078 }
2079 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002080 }
2081#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002082
Jerry Yu568ec252022-07-22 21:27:34 +08002083#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2085 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2086 psa_set_key_usage_flags(&key_attributes,
2087 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002088 }
2089#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 psa_set_key_algorithm(&key_attributes, alg);
2092 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2095 if (status != PSA_SUCCESS) {
2096 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2097 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002098
2099 /* Allow calling psa_destroy_key() on psk remove */
2100 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002102}
2103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2105 mbedtls_svc_key_id_t psk,
2106 const unsigned char *psk_identity,
2107 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002108{
Janos Follath865b3eb2019-12-16 11:46:15 +00002109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110
2111 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2113 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2114 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002115
Hanno Becker7390c712018-11-15 13:33:04 +00002116 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (mbedtls_svc_key_id_is_null(psk)) {
2118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2119 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002120 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002121
2122 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2124 psk_identity_len);
2125 if (ret != 0) {
2126 ssl_conf_remove_psk(conf);
2127 }
Hanno Becker7390c712018-11-15 13:33:04 +00002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130}
2131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2133 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002134{
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if ((mbedtls_svc_key_id_is_null(psk)) ||
2136 (ssl->handshake == NULL)) {
2137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2138 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002141 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002143}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144
Jerry Yu8897c072022-08-12 13:56:53 +08002145#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002146void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2147 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2148 size_t),
2149 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002150{
2151 conf->f_psk = f_psk;
2152 conf->p_psk = p_psk;
2153}
Jerry Yu8897c072022-08-12 13:56:53 +08002154#endif /* MBEDTLS_SSL_SRV_C */
2155
Ronald Cron73fe8df2022-10-05 14:31:43 +02002156#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002157
Gilles Peskine301711e2022-04-26 16:57:05 +02002158static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002160{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002161#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (alg == PSA_ALG_CBC_NO_PADDING) {
2163 return MBEDTLS_SSL_MODE_CBC;
2164 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002165#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (PSA_ALG_IS_AEAD(alg)) {
2167 return MBEDTLS_SSL_MODE_AEAD;
2168 }
2169 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002170}
2171
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002172
Gilles Peskinee108d982022-04-26 16:50:40 +02002173static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2174 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002176{
2177#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2179 base_mode == MBEDTLS_SSL_MODE_CBC) {
2180 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002181 }
2182#else
2183 (void) encrypt_then_mac;
2184#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002186}
2187
Neil Armstrongab555e02022-04-04 11:07:59 +02002188mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002190{
Gilles Peskinee108d982022-04-26 16:50:40 +02002191 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002193 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002194
Gilles Peskinee108d982022-04-26 16:50:40 +02002195 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002197 encrypt_then_mac = transform->encrypt_then_mac;
2198#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002200}
2201
Neil Armstrongab555e02022-04-04 11:07:59 +02002202mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002203#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002205#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002207{
Gilles Peskinee108d982022-04-26 16:50:40 +02002208 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2209
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210 psa_status_t status;
2211 psa_algorithm_t alg;
2212 psa_key_type_t type;
2213 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002214 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2215 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 if (status == PSA_SUCCESS) {
2217 base_mode = mbedtls_ssl_get_base_mode(alg);
2218 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002219
Gilles Peskinee108d982022-04-26 16:50:40 +02002220#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2221 int encrypt_then_mac = 0;
2222#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002224}
2225
Jerry Yu251a12e2022-07-13 15:15:48 +08002226
Ronald Cron8b592d22024-11-12 18:08:25 +01002227const mbedtls_error_pair_t psa_to_ssl_errors[] =
2228{
2229 { PSA_SUCCESS, 0 },
2230 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2231 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2232 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2233 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2234 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2235 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2236};
2237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2239 size_t taglen,
2240 psa_algorithm_t *alg,
2241 psa_key_type_t *key_type,
2242 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002243{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002244#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002245 (void) taglen;
2246#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002248#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249 case MBEDTLS_CIPHER_AES_128_CBC:
2250 *alg = PSA_ALG_CBC_NO_PADDING;
2251 *key_type = PSA_KEY_TYPE_AES;
2252 *key_size = 128;
2253 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002254#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002255#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002256 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002258 *key_type = PSA_KEY_TYPE_AES;
2259 *key_size = 128;
2260 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002261#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002262#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002263 case MBEDTLS_CIPHER_AES_128_GCM:
2264 *alg = PSA_ALG_GCM;
2265 *key_type = PSA_KEY_TYPE_AES;
2266 *key_size = 128;
2267 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002268#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002269#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002270 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002272 *key_type = PSA_KEY_TYPE_AES;
2273 *key_size = 192;
2274 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002275#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002276#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002277 case MBEDTLS_CIPHER_AES_192_GCM:
2278 *alg = PSA_ALG_GCM;
2279 *key_type = PSA_KEY_TYPE_AES;
2280 *key_size = 192;
2281 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002282#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002283#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002284 case MBEDTLS_CIPHER_AES_256_CBC:
2285 *alg = PSA_ALG_CBC_NO_PADDING;
2286 *key_type = PSA_KEY_TYPE_AES;
2287 *key_size = 256;
2288 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002289#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002290#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002291 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002293 *key_type = PSA_KEY_TYPE_AES;
2294 *key_size = 256;
2295 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002296#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002297#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002298 case MBEDTLS_CIPHER_AES_256_GCM:
2299 *alg = PSA_ALG_GCM;
2300 *key_type = PSA_KEY_TYPE_AES;
2301 *key_size = 256;
2302 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002303#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002304#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002305 case MBEDTLS_CIPHER_ARIA_128_CBC:
2306 *alg = PSA_ALG_CBC_NO_PADDING;
2307 *key_type = PSA_KEY_TYPE_ARIA;
2308 *key_size = 128;
2309 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002310#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002311#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002312 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002314 *key_type = PSA_KEY_TYPE_ARIA;
2315 *key_size = 128;
2316 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002317#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002318#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002319 case MBEDTLS_CIPHER_ARIA_128_GCM:
2320 *alg = PSA_ALG_GCM;
2321 *key_type = PSA_KEY_TYPE_ARIA;
2322 *key_size = 128;
2323 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002324#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002325#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002326 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002328 *key_type = PSA_KEY_TYPE_ARIA;
2329 *key_size = 192;
2330 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002331#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002332#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002333 case MBEDTLS_CIPHER_ARIA_192_GCM:
2334 *alg = PSA_ALG_GCM;
2335 *key_type = PSA_KEY_TYPE_ARIA;
2336 *key_size = 192;
2337 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002338#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002339#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002340 case MBEDTLS_CIPHER_ARIA_256_CBC:
2341 *alg = PSA_ALG_CBC_NO_PADDING;
2342 *key_type = PSA_KEY_TYPE_ARIA;
2343 *key_size = 256;
2344 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002345#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002346#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002347 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002349 *key_type = PSA_KEY_TYPE_ARIA;
2350 *key_size = 256;
2351 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002352#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002353#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002354 case MBEDTLS_CIPHER_ARIA_256_GCM:
2355 *alg = PSA_ALG_GCM;
2356 *key_type = PSA_KEY_TYPE_ARIA;
2357 *key_size = 256;
2358 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002359#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002360#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002361 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2362 *alg = PSA_ALG_CBC_NO_PADDING;
2363 *key_type = PSA_KEY_TYPE_CAMELLIA;
2364 *key_size = 128;
2365 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002366#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002367#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002368 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002370 *key_type = PSA_KEY_TYPE_CAMELLIA;
2371 *key_size = 128;
2372 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002373#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002374#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002375 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2376 *alg = PSA_ALG_GCM;
2377 *key_type = PSA_KEY_TYPE_CAMELLIA;
2378 *key_size = 128;
2379 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002380#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002381#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002382 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002384 *key_type = PSA_KEY_TYPE_CAMELLIA;
2385 *key_size = 192;
2386 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002387#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002388#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002389 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2390 *alg = PSA_ALG_GCM;
2391 *key_type = PSA_KEY_TYPE_CAMELLIA;
2392 *key_size = 192;
2393 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002394#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002395#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002396 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2397 *alg = PSA_ALG_CBC_NO_PADDING;
2398 *key_type = PSA_KEY_TYPE_CAMELLIA;
2399 *key_size = 256;
2400 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002401#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002402#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002403 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002405 *key_type = PSA_KEY_TYPE_CAMELLIA;
2406 *key_size = 256;
2407 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002408#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002409#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002410 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2411 *alg = PSA_ALG_GCM;
2412 *key_type = PSA_KEY_TYPE_CAMELLIA;
2413 *key_size = 256;
2414 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002415#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002416#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002417 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2418 *alg = PSA_ALG_CHACHA20_POLY1305;
2419 *key_type = PSA_KEY_TYPE_CHACHA20;
2420 *key_size = 256;
2421 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002422#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002423 case MBEDTLS_CIPHER_NULL:
2424 *alg = MBEDTLS_SSL_NULL_CIPHER;
2425 *key_type = 0;
2426 *key_size = 0;
2427 break;
2428 default:
2429 return PSA_ERROR_NOT_SUPPORTED;
2430 }
2431
2432 return PSA_SUCCESS;
2433}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002434
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002435#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002436int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2437 const unsigned char *dhm_P, size_t P_len,
2438 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002439{
Janos Follath865b3eb2019-12-16 11:46:15 +00002440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 mbedtls_mpi_free(&conf->dhm_P);
2443 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2446 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2447 mbedtls_mpi_free(&conf->dhm_P);
2448 mbedtls_mpi_free(&conf->dhm_G);
2449 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002450 }
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002453}
Paul Bakker5121ce52009-01-03 21:22:43 +00002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002456{
Janos Follath865b3eb2019-12-16 11:46:15 +00002457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 mbedtls_mpi_free(&conf->dhm_P);
2460 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2463 &conf->dhm_P)) != 0 ||
2464 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2465 &conf->dhm_G)) != 0) {
2466 mbedtls_mpi_free(&conf->dhm_P);
2467 mbedtls_mpi_free(&conf->dhm_G);
2468 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002469 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002472}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002473#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002474
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002475#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2476/*
2477 * Set the minimum length for Diffie-Hellman parameters
2478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002479void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2480 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002481{
2482 conf->dhm_min_bitlen = bitlen;
2483}
2484#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2485
Ronald Crone68ab4f2022-10-05 12:46:29 +02002486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002487#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002488/*
2489 * Set allowed/preferred hashes for handshake signatures
2490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002491void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2492 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002493{
2494 conf->sig_hashes = hashes;
2495}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002496#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002497
Jerry Yuf017ee42022-01-12 15:49:48 +08002498/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2500 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002501{
Jerry Yuf017ee42022-01-12 15:49:48 +08002502#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2503 conf->sig_hashes = NULL;
2504#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2505 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002506}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002507#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002508
Brett Warrene0edc842021-08-17 09:53:13 +01002509/*
2510 * Set the allowed groups
2511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2513 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002514{
Brett Warrene0edc842021-08-17 09:53:13 +01002515 conf->group_list = group_list;
2516}
2517
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002518#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002519int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002520{
Hanno Becker947194e2017-04-07 13:25:49 +01002521 /* Initialize to suppress unnecessary compiler warning */
2522 size_t hostname_len = 0;
2523
2524 /* Check if new hostname is valid before
2525 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (hostname != NULL) {
2527 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002528
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2530 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2531 }
Hanno Becker947194e2017-04-07 13:25:49 +01002532 }
2533
2534 /* Now it's clear that we will overwrite the old hostname,
2535 * so we can free it safely */
2536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002538 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002539 }
2540
2541 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002542
Gilles Peskine449bd832023-01-11 14:50:10 +01002543 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002544 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 } else {
2546 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2547 if (ssl->hostname == NULL) {
2548 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2549 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002552
Hanno Becker947194e2017-04-07 13:25:49 +01002553 ssl->hostname[hostname_len] = '\0';
2554 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002557}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002558#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002559
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002560#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002561void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2562 int (*f_sni)(void *, mbedtls_ssl_context *,
2563 const unsigned char *, size_t),
2564 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002565{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002566 conf->f_sni = f_sni;
2567 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002568}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002572int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002573{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002574 size_t cur_len, tot_len;
2575 const char **p;
2576
2577 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002578 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2579 * MUST NOT be truncated."
2580 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002581 */
2582 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 for (p = protos; *p != NULL; p++) {
2584 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002585 tot_len += cur_len;
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if ((cur_len == 0) ||
2588 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2589 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2591 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002592 }
2593
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002594 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002595
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002597}
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002600{
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002602}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002604
Johan Pascalb62bb512015-12-03 21:56:45 +01002605#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002606void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2607 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002608{
2609 conf->dtls_srtp_mki_support = support_mki_value;
2610}
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2613 unsigned char *mki_value,
2614 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002615{
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002618 }
Ron Eldor591f1622018-01-22 12:30:04 +02002619
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2621 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002622 }
Ron Eldor591f1622018-01-22 12:30:04 +02002623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002625 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002627}
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2630 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002631{
Johan Pascal253d0262020-09-22 13:04:45 +02002632 const mbedtls_ssl_srtp_profile *p;
2633 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002634
Johan Pascal253d0262020-09-22 13:04:45 +02002635 /* check the profiles list: all entry must be valid,
2636 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2638 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2639 p++) {
2640 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002641 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002643 /* unsupported value, stop parsing and set the size to an error value */
2644 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002645 }
2646 }
2647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2649 conf->dtls_srtp_profile_list = NULL;
2650 conf->dtls_srtp_profile_list_len = 0;
2651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002652 }
2653
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002654 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002655 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002656
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002658}
2659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2661 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002662{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002663 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2664 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002666 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002668 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2670 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002671 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002672}
Johan Pascalb62bb512015-12-03 21:56:45 +01002673#endif /* MBEDTLS_SSL_DTLS_SRTP */
2674
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302675#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002676void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002677{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002678 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002679}
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002682{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002683 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002684}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302685#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002686
Janos Follath088ce432017-04-10 12:42:31 +01002687#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002688void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2689 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002690{
2691 conf->cert_req_ca_list = cert_req_ca_list;
2692}
2693#endif
2694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002696void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002697{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002698 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002699}
2700#endif
2701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002703void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002704{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002705 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002706}
2707#endif
2708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002710int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002711{
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2713 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002715 }
2716
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002717 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002718
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002720}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002724{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002725 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002726}
2727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002729void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002730{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002731 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002732}
2733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002735{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002736 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002737}
2738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2740 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002741{
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002743}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002747#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002748void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002749{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002750 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002751}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002752#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002753
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002754#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002755
Jerry Yud0766ec2022-09-22 10:46:57 +08002756#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002757void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2758 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002759{
Jerry Yud0766ec2022-09-22 10:46:57 +08002760 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002761}
2762#endif
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2765 mbedtls_ssl_ticket_write_t *f_ticket_write,
2766 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2767 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002768{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002769 conf->f_ticket_write = f_ticket_write;
2770 conf->f_ticket_parse = f_ticket_parse;
2771 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002772}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002773#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2777 mbedtls_ssl_export_keys_t *f_export_keys,
2778 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002779{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002780 ssl->f_export_keys = f_export_keys;
2781 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002782}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002783
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002784#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002785void mbedtls_ssl_conf_async_private_cb(
2786 mbedtls_ssl_config *conf,
2787 mbedtls_ssl_async_sign_t *f_async_sign,
2788 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2789 mbedtls_ssl_async_resume_t *f_async_resume,
2790 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002792{
2793 conf->f_async_sign_start = f_async_sign;
2794 conf->f_async_decrypt_start = f_async_decrypt;
2795 conf->f_async_resume = f_async_resume;
2796 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002797 conf->p_async_config_data = async_config_data;
2798}
2799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002801{
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002803}
2804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002806{
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (ssl->handshake == NULL) {
2808 return NULL;
2809 } else {
2810 return ssl->handshake->user_async_ctx;
2811 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002812}
2813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2815 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002816{
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002818 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002820}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002821#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002822
Paul Bakker5121ce52009-01-03 21:22:43 +00002823/*
2824 * SSL get accessors
2825 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002826uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002827{
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (ssl->session != NULL) {
2829 return ssl->session->verify_result;
2830 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 if (ssl->session_negotiate != NULL) {
2833 return ssl->session_negotiate->verify_result;
2834 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002837}
2838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002840{
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 if (ssl == NULL || ssl->session == NULL) {
2842 return 0;
2843 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002846}
2847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002849{
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (ssl == NULL || ssl->session == NULL) {
2851 return NULL;
2852 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002855}
2856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002858{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2861 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002862 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002864 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002866 }
2867 }
2868#endif
2869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002871 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002873 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002875 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002877 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002878}
2879
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002880#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2881
2882size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2883{
2884 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2885 size_t record_size_limit = max_len;
2886
2887 if (ssl->session != NULL &&
2888 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2889 ssl->session->record_size_limit < max_len) {
2890 record_size_limit = ssl->session->record_size_limit;
2891 }
2892
2893 // TODO: this is currently untested
2894 /* During a handshake, use the value being negotiated */
2895 if (ssl->session_negotiate != NULL &&
2896 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2897 ssl->session_negotiate->record_size_limit < max_len) {
2898 record_size_limit = ssl->session_negotiate->record_size_limit;
2899 }
2900
2901 return record_size_limit;
2902}
2903#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2904
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002905#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002906size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002907{
David Horstmann95d516f2021-05-04 18:36:56 +01002908 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002909 size_t read_mfl;
2910
Jerry Yuddda0502022-12-01 19:43:12 +08002911#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002912 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2914 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2915 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002916 }
Jerry Yuddda0502022-12-01 19:43:12 +08002917#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002918
2919 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 if (ssl->session_out != NULL) {
2921 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2922 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002923 max_len = read_mfl;
2924 }
2925 }
2926
Jerry Yuddda0502022-12-01 19:43:12 +08002927 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 if (ssl->session_negotiate != NULL) {
2929 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2930 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002931 max_len = read_mfl;
2932 }
2933 }
2934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002936}
2937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002939{
2940 size_t max_len;
2941
2942 /*
2943 * Assume mfl_code is correct since it was checked when set
2944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002946
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002947 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 if (ssl->session_out != NULL &&
2949 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2950 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002951 }
2952
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002953 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 if (ssl->session_negotiate != NULL &&
2955 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2956 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002957 }
2958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002960}
2961#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2962
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002963#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002964size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002965{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002966 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2968 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2969 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2970 return 0;
2971 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2974 return ssl->mtu;
2975 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 if (ssl->mtu == 0) {
2978 return ssl->handshake->mtu;
2979 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 return ssl->mtu < ssl->handshake->mtu ?
2982 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002983}
2984#endif /* MBEDTLS_SSL_PROTO_DTLS */
2985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002987{
2988 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2989
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002990#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002991 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002992 !defined(MBEDTLS_SSL_PROTO_DTLS)
2993 (void) ssl;
2994#endif
2995
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002996#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002998
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003000 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003002#endif
3003
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003004#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3005 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3006
3007 if (max_len > record_size_limit) {
3008 max_len = record_size_limit;
3009 }
3010#endif
3011
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003012 if (ssl->transform_out != NULL &&
3013 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003014 /*
3015 * In TLS 1.3 case, when records are protected, `max_len` as computed
3016 * above is the maximum length of the TLSInnerPlaintext structure that
3017 * along the plaintext payload contains the inner content type (one byte)
3018 * and some zero padding. Given the algorithm used for padding
3019 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3020 * the plaintext payload. Round down to a multiple of
3021 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3022 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003023 */
3024 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3025 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3026 }
3027
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003028#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3030 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3031 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003032 const size_t overhead = (size_t) ret;
3033
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (ret < 0) {
3035 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003036 }
3037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (mtu <= overhead) {
3039 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3040 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3041 }
3042
3043 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003044 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003046 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003047#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003048
Hanno Becker0defedb2018-08-10 12:35:02 +01003049#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003050 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3051 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003052 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003053#endif
3054
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003056}
3057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003059{
3060 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3061
3062#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3063 (void) ssl;
3064#endif
3065
3066#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003070 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003072#endif
3073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003075}
3076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003078const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003079{
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (ssl == NULL || ssl->session == NULL) {
3081 return NULL;
3082 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003083
Hanno Beckere6824572019-02-07 13:18:46 +00003084#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003086#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003088#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003089}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003093int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3094 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003095{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003096 int ret;
3097
Gilles Peskine449bd832023-01-11 14:50:10 +01003098 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003099 dst == NULL ||
3100 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003103 }
3104
Hanno Beckere810bbc2021-05-14 16:01:05 +01003105 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3106 * idempotent: Each session can only be exported once.
3107 *
3108 * (This is in preparation for TLS 1.3 support where we will
3109 * need the ability to export multiple sessions (aka tickets),
3110 * which will be achieved by calling mbedtls_ssl_get_session()
3111 * multiple times until it fails.)
3112 *
3113 * Check whether we have already exported the current session,
3114 * and fail if so.
3115 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 if (ssl->session->exported == 1) {
3117 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3118 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3121 if (ret != 0) {
3122 return ret;
3123 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003124
3125 /* Remember that we've exported the session. */
3126 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003128}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003130
David Horstmanncb01b362024-02-29 17:31:46 +00003131#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3132
3133/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003134 *
David Horstmanncb01b362024-02-29 17:31:46 +00003135 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003136 */
3137static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3138 unsigned char *buf,
3139 size_t buf_len)
3140{
3141 unsigned char *p = buf;
3142 size_t used = 0;
3143
3144#if defined(MBEDTLS_HAVE_TIME)
3145 uint64_t start;
3146#endif
3147#if defined(MBEDTLS_X509_CRT_PARSE_C)
3148#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3149 size_t cert_len;
3150#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3151#endif /* MBEDTLS_X509_CRT_PARSE_C */
3152
3153 /*
3154 * Time
3155 */
3156#if defined(MBEDTLS_HAVE_TIME)
3157 used += 8;
3158
3159 if (used <= buf_len) {
3160 start = (uint64_t) session->start;
3161
3162 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3163 p += 8;
3164 }
3165#endif /* MBEDTLS_HAVE_TIME */
3166
3167 /*
3168 * Basic mandatory fields
3169 */
3170 used += 1 /* id_len */
3171 + sizeof(session->id)
3172 + sizeof(session->master)
3173 + 4; /* verify_result */
3174
3175 if (used <= buf_len) {
3176 *p++ = MBEDTLS_BYTE_0(session->id_len);
3177 memcpy(p, session->id, 32);
3178 p += 32;
3179
3180 memcpy(p, session->master, 48);
3181 p += 48;
3182
3183 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3184 p += 4;
3185 }
3186
3187 /*
3188 * Peer's end-entity certificate
3189 */
3190#if defined(MBEDTLS_X509_CRT_PARSE_C)
3191#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3192 if (session->peer_cert == NULL) {
3193 cert_len = 0;
3194 } else {
3195 cert_len = session->peer_cert->raw.len;
3196 }
3197
3198 used += 3 + cert_len;
3199
3200 if (used <= buf_len) {
3201 *p++ = MBEDTLS_BYTE_2(cert_len);
3202 *p++ = MBEDTLS_BYTE_1(cert_len);
3203 *p++ = MBEDTLS_BYTE_0(cert_len);
3204
3205 if (session->peer_cert != NULL) {
3206 memcpy(p, session->peer_cert->raw.p, cert_len);
3207 p += cert_len;
3208 }
3209 }
3210#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3211 if (session->peer_cert_digest != NULL) {
3212 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3213 if (used <= buf_len) {
3214 *p++ = (unsigned char) session->peer_cert_digest_type;
3215 *p++ = (unsigned char) session->peer_cert_digest_len;
3216 memcpy(p, session->peer_cert_digest,
3217 session->peer_cert_digest_len);
3218 p += session->peer_cert_digest_len;
3219 }
3220 } else {
3221 used += 2;
3222 if (used <= buf_len) {
3223 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3224 *p++ = 0;
3225 }
3226 }
3227#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3228#endif /* MBEDTLS_X509_CRT_PARSE_C */
3229
3230 /*
3231 * Session ticket if any, plus associated data
3232 */
3233#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3234#if defined(MBEDTLS_SSL_CLI_C)
3235 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3236 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3237
3238 if (used <= buf_len) {
3239 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3240 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3241 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3242
3243 if (session->ticket != NULL) {
3244 memcpy(p, session->ticket, session->ticket_len);
3245 p += session->ticket_len;
3246 }
3247
3248 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3249 p += 4;
3250 }
3251 }
3252#endif /* MBEDTLS_SSL_CLI_C */
3253#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3254 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3255 used += 8;
3256
3257 if (used <= buf_len) {
3258 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3259 p += 8;
3260 }
3261 }
3262#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3263#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3264
3265 /*
3266 * Misc extension-related info
3267 */
3268#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3269 used += 1;
3270
3271 if (used <= buf_len) {
3272 *p++ = session->mfl_code;
3273 }
3274#endif
3275
3276#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3277 used += 1;
3278
3279 if (used <= buf_len) {
3280 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3281 }
3282#endif
3283
3284 return used;
3285}
3286
3287MBEDTLS_CHECK_RETURN_CRITICAL
3288static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3289 const unsigned char *buf,
3290 size_t len)
3291{
3292#if defined(MBEDTLS_HAVE_TIME)
3293 uint64_t start;
3294#endif
3295#if defined(MBEDTLS_X509_CRT_PARSE_C)
3296#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3297 size_t cert_len;
3298#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3299#endif /* MBEDTLS_X509_CRT_PARSE_C */
3300
3301 const unsigned char *p = buf;
3302 const unsigned char * const end = buf + len;
3303
3304 /*
3305 * Time
3306 */
3307#if defined(MBEDTLS_HAVE_TIME)
3308 if (8 > (size_t) (end - p)) {
3309 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3310 }
3311
3312 start = MBEDTLS_GET_UINT64_BE(p, 0);
3313 p += 8;
3314
3315 session->start = (time_t) start;
3316#endif /* MBEDTLS_HAVE_TIME */
3317
3318 /*
3319 * Basic mandatory fields
3320 */
3321 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3323 }
3324
3325 session->id_len = *p++;
3326 memcpy(session->id, p, 32);
3327 p += 32;
3328
3329 memcpy(session->master, p, 48);
3330 p += 48;
3331
3332 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3333 p += 4;
3334
3335 /* Immediately clear invalid pointer values that have been read, in case
3336 * we exit early before we replaced them with valid ones. */
3337#if defined(MBEDTLS_X509_CRT_PARSE_C)
3338#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3339 session->peer_cert = NULL;
3340#else
3341 session->peer_cert_digest = NULL;
3342#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3343#endif /* MBEDTLS_X509_CRT_PARSE_C */
3344#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3345 session->ticket = NULL;
3346#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3347
3348 /*
3349 * Peer certificate
3350 */
3351#if defined(MBEDTLS_X509_CRT_PARSE_C)
3352#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3353 /* Deserialize CRT from the end of the ticket. */
3354 if (3 > (size_t) (end - p)) {
3355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3356 }
3357
3358 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3359 p += 3;
3360
3361 if (cert_len != 0) {
3362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3363
3364 if (cert_len > (size_t) (end - p)) {
3365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3366 }
3367
3368 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3369
3370 if (session->peer_cert == NULL) {
3371 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3372 }
3373
3374 mbedtls_x509_crt_init(session->peer_cert);
3375
3376 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3377 p, cert_len)) != 0) {
3378 mbedtls_x509_crt_free(session->peer_cert);
3379 mbedtls_free(session->peer_cert);
3380 session->peer_cert = NULL;
3381 return ret;
3382 }
3383
3384 p += cert_len;
3385 }
3386#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3387 /* Deserialize CRT digest from the end of the ticket. */
3388 if (2 > (size_t) (end - p)) {
3389 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3390 }
3391
3392 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3393 session->peer_cert_digest_len = (size_t) *p++;
3394
3395 if (session->peer_cert_digest_len != 0) {
3396 const mbedtls_md_info_t *md_info =
3397 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3398 if (md_info == NULL) {
3399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3400 }
3401 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3402 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3403 }
3404
3405 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3407 }
3408
3409 session->peer_cert_digest =
3410 mbedtls_calloc(1, session->peer_cert_digest_len);
3411 if (session->peer_cert_digest == NULL) {
3412 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3413 }
3414
3415 memcpy(session->peer_cert_digest, p,
3416 session->peer_cert_digest_len);
3417 p += session->peer_cert_digest_len;
3418 }
3419#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3420#endif /* MBEDTLS_X509_CRT_PARSE_C */
3421
3422 /*
3423 * Session ticket and associated data
3424 */
3425#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3426#if defined(MBEDTLS_SSL_CLI_C)
3427 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3428 if (3 > (size_t) (end - p)) {
3429 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3430 }
3431
3432 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3433 p += 3;
3434
3435 if (session->ticket_len != 0) {
3436 if (session->ticket_len > (size_t) (end - p)) {
3437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3438 }
3439
3440 session->ticket = mbedtls_calloc(1, session->ticket_len);
3441 if (session->ticket == NULL) {
3442 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3443 }
3444
3445 memcpy(session->ticket, p, session->ticket_len);
3446 p += session->ticket_len;
3447 }
3448
3449 if (4 > (size_t) (end - p)) {
3450 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3451 }
3452
3453 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3454 p += 4;
3455 }
3456#endif /* MBEDTLS_SSL_CLI_C */
3457#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3458 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3459 if (8 > (size_t) (end - p)) {
3460 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3461 }
3462 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3463 p += 8;
3464 }
3465#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3466#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3467
3468 /*
3469 * Misc extension-related info
3470 */
3471#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3472 if (1 > (size_t) (end - p)) {
3473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3474 }
3475
3476 session->mfl_code = *p++;
3477#endif
3478
3479#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3480 if (1 > (size_t) (end - p)) {
3481 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3482 }
3483
3484 session->encrypt_then_mac = *p++;
3485#endif
3486
3487 /* Done, should have consumed entire buffer */
3488 if (p != end) {
3489 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3490 }
3491
3492 return 0;
3493}
3494
3495#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3496
3497#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3498/* Serialization of TLS 1.3 sessions:
3499 *
David Horstmanncb01b362024-02-29 17:31:46 +00003500 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003501 */
3502#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3503MBEDTLS_CHECK_RETURN_CRITICAL
3504static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3505 unsigned char *buf,
3506 size_t buf_len,
3507 size_t *olen)
3508{
3509 unsigned char *p = buf;
3510#if defined(MBEDTLS_SSL_CLI_C) && \
3511 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3512 size_t hostname_len = (session->hostname == NULL) ?
3513 0 : strlen(session->hostname) + 1;
3514#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003515
3516#if defined(MBEDTLS_SSL_SRV_C) && \
3517 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003518 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003519 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003520#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003521 size_t needed = 4 /* ticket_age_add */
3522 + 1 /* ticket_flags */
3523 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003524
David Horstmanne59f9702024-02-29 16:08:57 +00003525 *olen = 0;
3526
3527 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3528 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3529 }
3530 needed += session->resumption_key_len; /* resumption_key */
3531
3532#if defined(MBEDTLS_SSL_EARLY_DATA)
3533 needed += 4; /* max_early_data_size */
3534#endif
3535#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3536 needed += 2; /* record_size_limit */
3537#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3538
3539#if defined(MBEDTLS_HAVE_TIME)
3540 needed += 8; /* ticket_creation_time or ticket_reception_time */
3541#endif
3542
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003543#if defined(MBEDTLS_SSL_SRV_C)
3544 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3545#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003546 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003547 + alpn_len; /* alpn */
3548#endif
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 needed += 2 /* hostname_len */
3556 + hostname_len; /* hostname */
3557#endif
3558
3559 needed += 4 /* ticket_lifetime */
3560 + 2; /* ticket_len */
3561
3562 /* Check size_t overflow */
3563 if (session->ticket_len > SIZE_MAX - needed) {
3564 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3565 }
3566
3567 needed += session->ticket_len; /* ticket */
3568 }
3569#endif /* MBEDTLS_SSL_CLI_C */
3570
3571 *olen = needed;
3572 if (needed > buf_len) {
3573 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3574 }
3575
3576 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3577 p[4] = session->ticket_flags;
3578
3579 /* save resumption_key */
3580 p[5] = session->resumption_key_len;
3581 p += 6;
3582 memcpy(p, session->resumption_key, session->resumption_key_len);
3583 p += session->resumption_key_len;
3584
3585#if defined(MBEDTLS_SSL_EARLY_DATA)
3586 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3587 p += 4;
3588#endif
3589#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3590 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3591 p += 2;
3592#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3593
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003594#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003595 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003596#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003597 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3598 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003599#endif /* MBEDTLS_HAVE_TIME */
3600
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003601#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003602 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3603 p += 2;
3604
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003605 if (alpn_len > 0) {
3606 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003607 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003608 p += alpn_len;
3609 }
3610#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3611 }
3612#endif /* MBEDTLS_SSL_SRV_C */
3613
David Horstmanne59f9702024-02-29 16:08:57 +00003614#if defined(MBEDTLS_SSL_CLI_C)
3615 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3616#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3617 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3618 p += 2;
3619 if (hostname_len > 0) {
3620 /* save host name */
3621 memcpy(p, session->hostname, hostname_len);
3622 p += hostname_len;
3623 }
3624#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3625
3626#if defined(MBEDTLS_HAVE_TIME)
3627 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3628 p += 8;
3629#endif
3630 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3631 p += 4;
3632
3633 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3634 p += 2;
3635
3636 if (session->ticket != NULL && session->ticket_len > 0) {
3637 memcpy(p, session->ticket, session->ticket_len);
3638 p += session->ticket_len;
3639 }
3640 }
3641#endif /* MBEDTLS_SSL_CLI_C */
3642 return 0;
3643}
3644
3645MBEDTLS_CHECK_RETURN_CRITICAL
3646static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3647 const unsigned char *buf,
3648 size_t len)
3649{
3650 const unsigned char *p = buf;
3651 const unsigned char *end = buf + len;
3652
3653 if (end - p < 6) {
3654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
3656 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3657 session->ticket_flags = p[4];
3658
3659 /* load resumption_key */
3660 session->resumption_key_len = p[5];
3661 p += 6;
3662
3663 if (end - p < session->resumption_key_len) {
3664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3665 }
3666
3667 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3669 }
3670 memcpy(session->resumption_key, p, session->resumption_key_len);
3671 p += session->resumption_key_len;
3672
3673#if defined(MBEDTLS_SSL_EARLY_DATA)
3674 if (end - p < 4) {
3675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3676 }
3677 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3678 p += 4;
3679#endif
3680#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3681 if (end - p < 2) {
3682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3683 }
3684 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3685 p += 2;
3686#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3687
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003688#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003689 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003690#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003691 if (end - p < 8) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3695 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003696#endif /* MBEDTLS_HAVE_TIME */
3697
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003698#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003699 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003700
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003701 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003702 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3703 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003704
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003705 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3706 p += 2;
3707
3708 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003709 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3710 }
3711
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003712 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003713 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3714 if (ret != 0) {
3715 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003716 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003717 p += alpn_len;
3718 }
3719#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3720 }
3721#endif /* MBEDTLS_SSL_SRV_C */
3722
David Horstmanne59f9702024-02-29 16:08:57 +00003723#if defined(MBEDTLS_SSL_CLI_C)
3724 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3725#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3726 size_t hostname_len;
3727 /* load host name */
3728 if (end - p < 2) {
3729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3730 }
3731 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3732 p += 2;
3733
3734 if (end - p < (long int) hostname_len) {
3735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3736 }
3737 if (hostname_len > 0) {
3738 session->hostname = mbedtls_calloc(1, hostname_len);
3739 if (session->hostname == NULL) {
3740 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3741 }
3742 memcpy(session->hostname, p, hostname_len);
3743 p += hostname_len;
3744 }
3745#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3746
3747#if defined(MBEDTLS_HAVE_TIME)
3748 if (end - p < 8) {
3749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3750 }
3751 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3752 p += 8;
3753#endif
3754 if (end - p < 4) {
3755 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3756 }
3757 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3758 p += 4;
3759
3760 if (end - p < 2) {
3761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3762 }
3763 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3764 p += 2;
3765
3766 if (end - p < (long int) session->ticket_len) {
3767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3768 }
3769 if (session->ticket_len > 0) {
3770 session->ticket = mbedtls_calloc(1, session->ticket_len);
3771 if (session->ticket == NULL) {
3772 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3773 }
3774 memcpy(session->ticket, p, session->ticket_len);
3775 p += session->ticket_len;
3776 }
3777 }
3778#endif /* MBEDTLS_SSL_CLI_C */
3779
3780 return 0;
3781
3782}
3783#else /* MBEDTLS_SSL_SESSION_TICKETS */
3784MBEDTLS_CHECK_RETURN_CRITICAL
3785static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3786 unsigned char *buf,
3787 size_t buf_len,
3788 size_t *olen)
3789{
3790 ((void) session);
3791 ((void) buf);
3792 ((void) buf_len);
3793 *olen = 0;
3794 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3795}
3796
3797static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003798 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003799 size_t buf_len)
3800{
3801 ((void) session);
3802 ((void) buf);
3803 ((void) buf_len);
3804 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3805}
3806#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3807#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3808
Paul Bakker5121ce52009-01-03 21:22:43 +00003809/*
Hanno Beckera835da52019-05-16 12:39:07 +01003810 * Define ticket header determining Mbed TLS version
3811 * and structure of the ticket.
3812 */
3813
Hanno Becker94ef3b32019-05-16 12:50:45 +01003814/*
Hanno Becker50b59662019-05-28 14:30:45 +01003815 * Define bitflag determining compile-time settings influencing
3816 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003817 */
3818
Hanno Becker50b59662019-05-28 14:30:45 +01003819#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003820#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003821#else
Hanno Becker3e088662019-05-29 11:10:18 +01003822#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003823#endif /* MBEDTLS_HAVE_TIME */
3824
3825#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003826#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003827#else
Hanno Becker3e088662019-05-29 11:10:18 +01003828#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003829#endif /* MBEDTLS_X509_CRT_PARSE_C */
3830
David Horstmann5c5a32f2024-02-13 17:53:35 +00003831#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003832#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003833#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003834#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003835#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3836
Hanno Becker94ef3b32019-05-16 12:50:45 +01003837#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003838#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003839#else
Hanno Becker3e088662019-05-29 11:10:18 +01003840#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003841#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3842
3843#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003844#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003845#else
Hanno Becker3e088662019-05-29 11:10:18 +01003846#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003847#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3848
Hanno Becker94ef3b32019-05-16 12:50:45 +01003849#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003850#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003851#else
Hanno Becker3e088662019-05-29 11:10:18 +01003852#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003853#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3854
Hanno Becker94ef3b32019-05-16 12:50:45 +01003855#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3856#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3857#else
3858#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3859#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3860
David Horstmann92b258b2024-02-13 17:23:34 +00003861#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3862#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3863#else
3864#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3865#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3866
3867#if defined(MBEDTLS_SSL_EARLY_DATA)
3868#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3869#else
3870#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3871#endif /* MBEDTLS_SSL_EARLY_DATA */
3872
3873#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3874#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3875#else
3876#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3877#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3878
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003879#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3880 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003881#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3882#else
3883#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3884#endif /* MBEDTLS_SSL_ALPN */
3885
Hanno Becker3e088662019-05-29 11:10:18 +01003886#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3887#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3888#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3889#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003890#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3891#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003892#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003893#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3894#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3895#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003896#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003897
Hanno Becker50b59662019-05-28 14:30:45 +01003898#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 ((uint16_t) ( \
3900 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3901 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3902 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3903 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3904 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3905 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003906 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003907 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3908 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003909 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3910 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3911 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3912 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003913 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003914 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003915 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003916
Chien Wong4e9683e2023-12-28 17:07:43 +08003917static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003918 MBEDTLS_VERSION_MAJOR,
3919 MBEDTLS_VERSION_MINOR,
3920 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3922 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003923};
Hanno Beckera835da52019-05-16 12:39:07 +01003924
3925/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003926 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003927 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003928 *
David Horstmanncb01b362024-02-29 17:31:46 +00003929 * TLS 1.2 session:
3930 *
3931 * struct {
3932 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3933 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3934 * uint32 ticket_lifetime;
3935 * #endif
3936 * } ClientOnlyData;
3937 *
3938 * struct {
3939 * #if defined(MBEDTLS_HAVE_TIME)
3940 * uint64 start_time;
3941 * #endif
3942 * uint8 session_id_len; // at most 32
3943 * opaque session_id[32];
3944 * opaque master[48]; // fixed length in the standard
3945 * uint32 verify_result;
3946 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3947 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3948 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003949 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003950 * opaque peer_cert_digest<0..2^8-1>
3951 * #endif
3952 * select (endpoint) {
3953 * case client: ClientOnlyData;
3954 * case server: uint64 ticket_creation_time;
3955 * };
3956 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3957 * uint8 mfl_code; // up to 255 according to standard
3958 * #endif
3959 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3960 * uint8 encrypt_then_mac; // 0 or 1
3961 * #endif
3962 * } serialized_session_tls12;
3963 *
3964 *
3965 * TLS 1.3 Session:
3966 *
3967 * struct {
3968 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3969 * opaque hostname<0..2^16-1>;
3970 * #endif
3971 * #if defined(MBEDTLS_HAVE_TIME)
3972 * uint64 ticket_reception_time;
3973 * #endif
3974 * uint32 ticket_lifetime;
3975 * opaque ticket<1..2^16-1>;
3976 * } ClientOnlyData;
3977 *
3978 * struct {
3979 * uint32 ticket_age_add;
3980 * uint8 ticket_flags;
3981 * opaque resumption_key<0..255>;
3982 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3983 * uint32 max_early_data_size;
3984 * #endif
3985 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3986 * uint16 record_size_limit;
3987 * #endif
3988 * select ( endpoint ) {
3989 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003990 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003991 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003992 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003993 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003994 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003995 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003996 * #endif
3997 * };
3998 * } serialized_session_tls13;
3999 *
4000 *
4001 * SSL session:
4002 *
4003 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004004 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004005 * opaque mbedtls_version[3]; // library version: major, minor, patch
4006 * opaque session_format[2]; // library-version specific 16-bit field
4007 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004008 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004009 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004010 * Note: When updating the format, remember to keep
4011 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004012 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004013 * // In this version, `session_format` determines
4014 * // the setting of those compile-time
4015 * // configuration options which influence
4016 * // the structure of mbedtls_ssl_session.
4017 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004018 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004019 * // - TLS 1.2 (0x0303)
4020 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004021 * uint8_t endpoint;
4022 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004023 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004024 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004025 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004026 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004027 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004028 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004029 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004030 *
4031 * };
4032 *
4033 * } serialized_session;
4034 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004035 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004036
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004037MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004038static int ssl_session_save(const mbedtls_ssl_session *session,
4039 unsigned char omit_header,
4040 unsigned char *buf,
4041 size_t buf_len,
4042 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004043{
4044 unsigned char *p = buf;
4045 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004046 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004047#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4048 size_t out_len;
4049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4050#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if (session == NULL) {
4052 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4053 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004054
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004056 /*
4057 * Add Mbed TLS version identifier
4058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004060
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 if (used <= buf_len) {
4062 memcpy(p, ssl_serialized_session_header,
4063 sizeof(ssl_serialized_session_header));
4064 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004065 }
4066 }
4067
4068 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004069 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004070 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004071 used += 1 /* TLS version */
4072 + 1 /* endpoint */
4073 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 if (used <= buf_len) {
4075 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004076 *p++ = session->endpoint;
4077 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4078 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004079 }
4080
4081 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004082 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004084#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 case MBEDTLS_SSL_VERSION_TLS1_2:
4086 used += ssl_tls12_session_save(session, p, remaining_len);
4087 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004088#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4089
Jerry Yu251a12e2022-07-13 15:15:48 +08004090#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 case MBEDTLS_SSL_VERSION_TLS1_3:
4092 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4093 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4094 return ret;
4095 }
4096 used += out_len;
4097 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004098#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4099
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 default:
4101 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004102 }
4103
4104 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004105 if (used > buf_len) {
4106 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4107 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004110}
4111
4112/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004113 * Public wrapper for ssl_session_save()
4114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004115int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4116 unsigned char *buf,
4117 size_t buf_len,
4118 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004119{
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004121}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004122
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004123/*
4124 * Deserialize session, see mbedtls_ssl_session_save() for format.
4125 *
4126 * This internal version is wrapped by a public function that cleans up in
4127 * case of error, and has an extra option omit_header.
4128 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004129MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004130static int ssl_session_load(mbedtls_ssl_session *session,
4131 unsigned char omit_header,
4132 const unsigned char *buf,
4133 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004134{
4135 const unsigned char *p = buf;
4136 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004137 size_t remaining_len;
4138
4139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 if (session == NULL) {
4141 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4142 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004145 /*
4146 * Check Mbed TLS version identifier
4147 */
4148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4150 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004151 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004152
4153 if (memcmp(p, ssl_serialized_session_header,
4154 sizeof(ssl_serialized_session_header)) != 0) {
4155 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4156 }
4157 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004158 }
4159
4160 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004161 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004162 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004163 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4165 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004166 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004167 session->endpoint = *p++;
4168 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4169 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004170
4171 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004172 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004174#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 case MBEDTLS_SSL_VERSION_TLS1_2:
4176 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004177#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4178
Jerry Yu438ddd82022-07-07 06:55:50 +00004179#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 case MBEDTLS_SSL_VERSION_TLS1_3:
4181 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004182#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4183
Gilles Peskine449bd832023-01-11 14:50:10 +01004184 default:
4185 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004186 }
4187}
4188
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004189/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004190 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004192int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4193 const unsigned char *buf,
4194 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004195{
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (ret != 0) {
4199 mbedtls_ssl_session_free(session);
4200 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004203}
4204
4205/*
Paul Bakker1961b702013-01-25 14:49:24 +01004206 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004207 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004208MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004209static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004210{
4211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4212
Ronald Cron66dbf912022-02-02 15:33:46 +01004213 /*
4214 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004215 * that were written into the output buffer by the previous handshake step,
4216 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004217 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4218 * We proceed to the next handshake step only when all data from the
4219 * previous one have been sent to the peer, thus we make sure that this is
4220 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4221 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4222 * we have to wait before to go ahead.
4223 * In the case of TLS 1.3, handshake step handlers do not send data to the
4224 * peer. Data are only sent here and through
4225 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004226 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004227 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4229 return ret;
4230 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004231
4232#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4234 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4235 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4236 return ret;
4237 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004238 }
4239#endif /* MBEDTLS_SSL_PROTO_DTLS */
4240
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004242}
4243
Gilles Peskine449bd832023-01-11 14:50:10 +01004244int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004245{
Hanno Becker41934dd2021-08-07 19:13:43 +01004246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004249 ssl->conf == NULL ||
4250 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4252 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004253 }
4254
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 ret = ssl_prepare_handshake_step(ssl);
4256 if (ret != 0) {
4257 return ret;
4258 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004259
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 ret = mbedtls_ssl_handle_pending_alert(ssl);
4261 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004262 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 }
Jerry Yue7047812021-09-13 19:26:39 +08004264
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004265 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4266 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4267 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004269#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4271 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004272 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004275 case MBEDTLS_SSL_HELLO_REQUEST:
4276 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004277 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004278 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004279
Ronald Cron9f0fba32022-02-10 16:45:15 +01004280 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004282 break;
4283
4284 default:
4285#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4287 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4288 } else {
4289 ret = mbedtls_ssl_handshake_client_step(ssl);
4290 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004291#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004293#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004295#endif
4296 }
Jerry Yub9930e72021-08-06 17:11:51 +08004297 }
Ronald Cron6291b232023-03-08 15:51:25 +01004298#endif /* MBEDTLS_SSL_CLI_C */
4299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004300#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004302#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4303 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004305 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 ret = mbedtls_ssl_handshake_server_step(ssl);
4307 }
Ronald Cron6291b232023-03-08 15:51:25 +01004308#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4309 ret = mbedtls_ssl_handshake_server_step(ssl);
4310#else
4311 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004312#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004313 }
4314#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004317 /* handshake_step return error. And it is same
4318 * with alert_reason.
4319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (ssl->send_alert) {
4321 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004322 goto cleanup;
4323 }
4324 }
4325
4326cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004328}
4329
4330/*
4331 * Perform the SSL handshake
4332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004333int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004334{
4335 int ret = 0;
4336
Hanno Beckera817ea42020-10-20 15:20:23 +01004337 /* Sanity checks */
4338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (ssl == NULL || ssl->conf == NULL) {
4340 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4341 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004342
Hanno Beckera817ea42020-10-20 15:20:23 +01004343#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4345 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4346 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4347 "mbedtls_ssl_set_timer_cb() for DTLS"));
4348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004349 }
4350#endif /* MBEDTLS_SSL_PROTO_DTLS */
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004353
Hanno Beckera817ea42020-10-20 15:20:23 +01004354 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4356 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004359 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 }
Paul Bakker1961b702013-01-25 14:49:24 +01004361 }
4362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004366}
4367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004368#if defined(MBEDTLS_SSL_RENEGOTIATION)
4369#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004370/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004371 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004372 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004373MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004374static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004375{
Janos Follath865b3eb2019-12-16 11:46:15 +00004376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004377
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004379
4380 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004381 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4382 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4385 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4386 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004387 }
4388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004392}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004393#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004394
4395/*
4396 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004397 * - any side: calling mbedtls_ssl_renegotiate(),
4398 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4399 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004400 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004401 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004402 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004403 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004404int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004405{
Janos Follath865b3eb2019-12-16 11:46:15 +00004406 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if ((ret = ssl_handshake_init(ssl)) != 0) {
4411 return ret;
4412 }
Paul Bakker48916f92012-09-16 19:57:18 +00004413
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004414 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4415 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004416#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4418 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4419 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004420 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004422 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004424 }
4425#endif
4426
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004427 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4428 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4431 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4432 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004433 }
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004438}
4439
4440/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004441 * Renegotiate current connection on client,
4442 * or request renegotiation on server
4443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004444int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004445{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004446 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (ssl == NULL || ssl->conf == NULL) {
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4450 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004453 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4455 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4457 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004459 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004460
4461 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (ssl->out_left != 0) {
4463 return mbedtls_ssl_flush_output(ssl);
4464 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004467 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004468#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004470#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004471 /*
4472 * On client, either start the renegotiation process or,
4473 * if already in progress, continue the handshake
4474 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4476 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4477 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004478 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004479
4480 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4481 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4482 return ret;
4483 }
4484 } else {
4485 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4486 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4487 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004488 }
4489 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004490#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004493}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004494#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004497{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004498 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004501 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004503
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004504#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004505#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (ssl->handshake->group_list_heap_allocated) {
4507 mbedtls_free((void *) handshake->group_list);
4508 }
Brett Warrene0edc842021-08-17 09:53:13 +01004509 handshake->group_list = NULL;
4510#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004511#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004512
Ronald Crone68ab4f2022-10-05 12:46:29 +02004513#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004514#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (ssl->handshake->sig_algs_heap_allocated) {
4516 mbedtls_free((void *) handshake->sig_algs);
4517 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004518 handshake->sig_algs = NULL;
4519#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004520#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->handshake->certificate_request_context) {
4522 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004523 }
4524#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004525#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004526
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004527#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4529 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004530 handshake->async_in_progress = 0;
4531 }
4532#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4533
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004534#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004536#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004537#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004539#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004543#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004544
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004545#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004547 /*
4548 * Opaque keys are not stored in the handshake's data and it's the user
4549 * responsibility to destroy them. Clear ones, instead, are created by
4550 * the TLS library and should be destroyed at the same level
4551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4553 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004554 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004555 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004556#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004558 handshake->ecjpake_cache = NULL;
4559 handshake->ecjpake_cache_len = 0;
4560#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004561#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004562
Valerio Setti7aeec542023-07-05 18:57:21 +02004563#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004564 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004565 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004566 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004568#endif
4569
Ronald Cron73fe8df2022-10-05 14:31:43 +02004570#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004572 /* The maintenance of the external PSK key slot is the
4573 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (ssl->handshake->psk_opaque_is_internal) {
4575 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004576 ssl->handshake->psk_opaque_is_internal = 0;
4577 }
4578 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4579 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004580#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004582#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4583 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004584 /*
4585 * Free only the linked list wrapper, not the keys themselves
4586 * since the belong to the SNI callback
4587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004589#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004590
Gilles Peskineeccd8882020-03-10 12:19:08 +01004591#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4593 if (handshake->ecrs_peer_cert != NULL) {
4594 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4595 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004596 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004597#endif
4598
Hanno Becker75173122019-02-06 16:18:31 +00004599#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4600 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004602#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4603
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004604#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4606 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004607#endif /* MBEDTLS_SSL_CLI_C &&
4608 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004609
4610#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 mbedtls_ssl_flight_free(handshake->flight);
4612 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004613#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004614
Valerio Settiea59c432023-07-25 11:14:03 +02004615#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004616 if (handshake->xxdh_psa_privkey_is_external == 0) {
4617 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 }
Valerio Settiea59c432023-07-25 11:14:03 +02004619#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004620
Ronald Cron6f135e12021-12-08 16:57:54 +01004621#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 mbedtls_ssl_transform_free(handshake->transform_handshake);
4623 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004624#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4626 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004627#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004628#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004629
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004630
4631#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4632 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4633 * processes datagrams and the fact that a datagram is allowed to have
4634 * several records in it, it is possible that the I/O buffers are not
4635 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4637 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004638#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004639
Jerry Yuba9c7272021-10-30 11:54:10 +08004640 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004641 mbedtls_platform_zeroize(handshake,
4642 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004643}
4644
Gilles Peskine449bd832023-01-11 14:50:10 +01004645void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004646{
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004648 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004651#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004653#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004654
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004655#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004656#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4657 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004659#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004661#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004662
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004663#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4664 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004665 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004666#endif
4667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004669}
4670
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004671#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004672
4673#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4674#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4675#else
4676#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4677#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4678
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004679#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004680
4681#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4682#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4683#else
4684#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4685#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4686
4687#if defined(MBEDTLS_SSL_ALPN)
4688#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4689#else
4690#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4691#endif /* MBEDTLS_SSL_ALPN */
4692
4693#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4694#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4695#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4696#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4697
4698#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 ((uint32_t) ( \
4700 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4701 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4702 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4703 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4704 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4705 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4706 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4707 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004708
Chien Wong4e9683e2023-12-28 17:07:43 +08004709static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004710 MBEDTLS_VERSION_MAJOR,
4711 MBEDTLS_VERSION_MINOR,
4712 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4714 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4715 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4716 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4717 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004718};
4719
Paul Bakker5121ce52009-01-03 21:22:43 +00004720/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004721 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004722 *
4723 * The format of the serialized data is:
4724 * (in the presentation language of TLS, RFC 8446 section 3)
4725 *
4726 * // header
4727 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004728 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004729 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004730 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004731 * Note: When updating the format, remember to keep these
4732 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004733 *
4734 * // session sub-structure
4735 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4736 * // transform sub-structure
4737 * uint8 random[64]; // ServerHello.random+ClientHello.random
4738 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4739 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4740 * // fields from ssl_context
4741 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4742 * uint64 in_window_top; // DTLS: last validated record seq_num
4743 * uint64 in_window; // DTLS: bitmask for replay protection
4744 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4745 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4746 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4747 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4748 *
4749 * Note that many fields of the ssl_context or sub-structures are not
4750 * serialized, as they fall in one of the following categories:
4751 *
4752 * 1. forced value (eg in_left must be 0)
4753 * 2. pointer to dynamically-allocated memory (eg session, transform)
4754 * 3. value can be re-derived from other data (eg session keys from MS)
4755 * 4. value was temporary (eg content of input buffer)
4756 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004758int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4759 unsigned char *buf,
4760 size_t buf_len,
4761 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004762{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004763 unsigned char *p = buf;
4764 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004765 size_t session_len;
4766 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004767
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004768 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004769 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4770 * this function's documentation.
4771 *
4772 * These are due to assumptions/limitations in the implementation. Some of
4773 * them are likely to stay (no handshake in progress) some might go away
4774 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004775 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004776 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4778 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004780 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 if (ssl->handshake != NULL) {
4782 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4783 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004784 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004785 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (ssl->transform == NULL || ssl->session == NULL) {
4787 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4788 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004789 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004790 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 if (mbedtls_ssl_check_pending(ssl) != 0) {
4792 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4793 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004794 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if (ssl->out_left != 0) {
4796 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4797 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004798 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004799 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4801 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4802 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004803 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004804 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4806 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004808 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004809 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4811 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4812 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004813 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004814 /* Renegotiation must not be enabled */
4815#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4817 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4818 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004819 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004820#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004821
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004822 /*
4823 * Version and format identifier
4824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (used <= buf_len) {
4828 memcpy(p, ssl_serialized_context_header,
4829 sizeof(ssl_serialized_context_header));
4830 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004831 }
4832
4833 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004834 * Session (length + data)
4835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4837 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4838 return ret;
4839 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004840
4841 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (used <= buf_len) {
4843 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004844 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 ret = ssl_session_save(ssl->session, 1,
4847 p, session_len, &session_len);
4848 if (ret != 0) {
4849 return ret;
4850 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004851
4852 p += session_len;
4853 }
4854
4855 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004856 * Transform
4857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 used += sizeof(ssl->transform->randbytes);
4859 if (used <= buf_len) {
4860 memcpy(p, ssl->transform->randbytes,
4861 sizeof(ssl->transform->randbytes));
4862 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004863 }
4864
4865#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004866 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004868 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004870 p += ssl->transform->in_cid_len;
4871
4872 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004874 p += ssl->transform->out_cid_len;
4875 }
4876#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4877
4878 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879 * Saved fields from top-level ssl_context structure
4880 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004881 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (used <= buf_len) {
4883 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004884 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004885 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004886
4887#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4888 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (used <= buf_len) {
4890 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004891 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004892
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004894 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004895 }
4896#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4897
4898#if defined(MBEDTLS_SSL_PROTO_DTLS)
4899 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004900 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004901 *p++ = ssl->disable_datagram_packing;
4902 }
4903#endif /* MBEDTLS_SSL_PROTO_DTLS */
4904
Jerry Yuae0b2e22021-10-08 15:21:19 +08004905 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (used <= buf_len) {
4907 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004908 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004909 }
4910
4911#if defined(MBEDTLS_SSL_PROTO_DTLS)
4912 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (used <= buf_len) {
4914 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004915 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004916 }
4917#endif /* MBEDTLS_SSL_PROTO_DTLS */
4918
4919#if defined(MBEDTLS_SSL_ALPN)
4920 {
4921 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004923 : 0;
4924
4925 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004927 *p++ = alpn_len;
4928
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 if (ssl->alpn_chosen != NULL) {
4930 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004931 p += alpn_len;
4932 }
4933 }
4934 }
4935#endif /* MBEDTLS_SSL_ALPN */
4936
4937 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004938 * Done
4939 */
4940 *olen = used;
4941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (used > buf_len) {
4943 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4944 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004945
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004947
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004949}
4950
4951/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004952 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953 *
4954 * This internal version is wrapped by a public function that cleans up in
4955 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004956 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004957MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004958static int ssl_context_load(mbedtls_ssl_context *ssl,
4959 const unsigned char *buf,
4960 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004961{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004962 const unsigned char *p = buf;
4963 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004964 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004967 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004968#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004969
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004970 /*
4971 * The context should have been freshly setup or reset.
4972 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004973 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004974 * renegotiating, or if the user mistakenly loaded a session first.)
4975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4977 ssl->session != NULL) {
4978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004979 }
4980
4981 /*
4982 * We can't check that the config matches the initial one, but we can at
4983 * least check it matches the requirements for serializing.
4984 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004985 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004986#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004987 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004988#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004989 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4990 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4991 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4992 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004994 }
4995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004997
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004998 /*
4999 * Check version identifier
5000 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005003 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005004
5005 if (memcmp(p, ssl_serialized_context_header,
5006 sizeof(ssl_serialized_context_header)) != 0) {
5007 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5008 }
5009 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005010
5011 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005012 * Session
5013 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 if ((size_t) (end - p) < 4) {
5015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5016 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005017
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005018 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005019 p += 4;
5020
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005021 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005022 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005023 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005024 ssl->session_in = ssl->session;
5025 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005026 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 if ((size_t) (end - p) < session_len) {
5029 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5030 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 ret = ssl_session_load(ssl->session, 1, p, session_len);
5033 if (ret != 0) {
5034 mbedtls_ssl_session_free(ssl->session);
5035 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005036 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005037
5038 p += session_len;
5039
5040 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005041 * Transform
5042 */
5043
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005044 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005045 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005046#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005047 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005048 ssl->transform_in = ssl->transform;
5049 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005050 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005051#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005052
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5055 if (prf_func == NULL) {
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5057 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005058
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005059 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5062 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 ret = ssl_tls12_populate_transform(ssl->transform,
5065 ssl->session->ciphersuite,
5066 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005067#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005069#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 prf_func,
5071 p, /* currently pointing to randbytes */
5072 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5073 ssl->conf->endpoint,
5074 ssl);
5075 if (ret != 0) {
5076 return ret;
5077 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005078#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005080
5081#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5082 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if ((size_t) (end - p) < 1) {
5084 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5085 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005086
5087 ssl->transform->in_cid_len = *p++;
5088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5091 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005094 p += ssl->transform->in_cid_len;
5095
5096 ssl->transform->out_cid_len = *p++;
5097
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5099 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5100 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005103 p += ssl->transform->out_cid_len;
5104#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5105
5106 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107 * Saved fields from top-level ssl_context structure
5108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if ((size_t) (end - p) < 4) {
5110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5111 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005112
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005113 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005114 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005115
5116#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if ((size_t) (end - p) < 16) {
5118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5119 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005120
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005121 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005122 p += 8;
5123
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005124 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005125 p += 8;
5126#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5127
5128#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if ((size_t) (end - p) < 1) {
5130 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5131 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005132
5133 ssl->disable_datagram_packing = *p++;
5134#endif /* MBEDTLS_SSL_PROTO_DTLS */
5135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5138 }
5139 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5140 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005141
5142#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 if ((size_t) (end - p) < 2) {
5144 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5145 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005146
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005147 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005148 p += 2;
5149#endif /* MBEDTLS_SSL_PROTO_DTLS */
5150
5151#if defined(MBEDTLS_SSL_ALPN)
5152 {
5153 uint8_t alpn_len;
5154 const char **cur;
5155
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if ((size_t) (end - p) < 1) {
5157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5158 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005159
5160 alpn_len = *p++;
5161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005163 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5165 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005166 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005167 ssl->alpn_chosen = *cur;
5168 break;
5169 }
5170 }
5171 }
5172
5173 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5176 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005177
5178 p += alpn_len;
5179 }
5180#endif /* MBEDTLS_SSL_ALPN */
5181
5182 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005183 * Forced fields from top-level ssl_context structure
5184 *
5185 * Most of them already set to the correct value by mbedtls_ssl_init() and
5186 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5187 */
5188 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005189 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005190
Hanno Becker361b10d2019-08-30 10:42:49 +01005191 /* Adjust pointers for header fields of outgoing records to
5192 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005194
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005195#if defined(MBEDTLS_SSL_PROTO_DTLS)
5196 ssl->in_epoch = 1;
5197#endif
5198
5199 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5200 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005201 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5202 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (ssl->handshake != NULL) {
5204 mbedtls_ssl_handshake_free(ssl);
5205 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005206 ssl->handshake = NULL;
5207 }
5208
5209 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005210 * Done - should have consumed entire buffer
5211 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (p != end) {
5213 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5214 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005215
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005217}
5218
5219/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005220 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005221 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005222int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5223 const unsigned char *buf,
5224 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005225{
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ret != 0) {
5229 mbedtls_ssl_free(context);
5230 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005233}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005234#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005235
5236/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005237 * Free an SSL context
5238 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005239void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005240{
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005242 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005244
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005248#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5249 size_t out_buf_len = ssl->out_buf_len;
5250#else
5251 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5252#endif
5253
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005254 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005255 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 }
5257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005259#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5260 size_t in_buf_len = ssl->in_buf_len;
5261#else
5262 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5263#endif
5264
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005265 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005266 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005267 }
5268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if (ssl->transform) {
5270 mbedtls_ssl_transform_free(ssl->transform);
5271 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005272 }
5273
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (ssl->handshake) {
5275 mbedtls_ssl_handshake_free(ssl);
5276 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005277
5278#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5280 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005281#endif
5282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 mbedtls_ssl_session_free(ssl->session_negotiate);
5284 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005285 }
5286
Ronald Cron6f135e12021-12-08 16:57:54 +01005287#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 mbedtls_ssl_transform_free(ssl->transform_application);
5289 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005290#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 if (ssl->session) {
5293 mbedtls_ssl_session_free(ssl->session);
5294 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005295 }
5296
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005297#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005299 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005300 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005301#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005302
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005303#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005305#endif
5306
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005308
Paul Bakker86f04f42013-02-14 11:20:09 +01005309 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005311}
5312
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005313/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005314 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005317{
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005319}
5320
Gilles Peskineae270bf2021-06-02 00:05:29 +02005321/* The selection should be the same as mbedtls_x509_crt_profile_default in
5322 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005323 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005324 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005325 * about this list.
5326 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005327static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005328#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005329 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005330#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005331#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005332 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005333#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005334#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005335 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005336#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005337#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005338 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005339#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005340#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005341 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005342#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005343#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005344 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005345#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005346#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005347 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005348#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005349#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005350 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005351#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005352#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005353 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5354 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5355 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5356 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5357 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5358#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005359 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005360};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005361
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005362static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005363 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5364 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5365 0
5366};
5367
Ronald Crone68ab4f2022-10-05 12:46:29 +02005368#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005369
Jerry Yu909df7b2022-01-22 11:56:27 +08005370/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005371 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005372 * rules SHOULD be upheld.
5373 * - No duplicate entries.
5374 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005375 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005376 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005377 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005378static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005379
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005380#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005381 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005382 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005383 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005384 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5385#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005386
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005387#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005388 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005389 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005390 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005391 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5392#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005393
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005394#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005395 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005396 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005397 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005398 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5399#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005400
Gabor Mezeic15ef932024-06-13 12:53:54 +02005401#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005402 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005403#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005404
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005405#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005406 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005407#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005408
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005409#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005410 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005411#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005412
Gabor Mezeic15ef932024-06-13 12:53:54 +02005413#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005414 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005415#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005416
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005417#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005418 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005419#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005420
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005421#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005422 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005423#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005424
Gabor Mezei15b95a62022-05-09 16:37:58 +02005425 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005426};
5427
5428/* NOTICE: see above */
5429#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5430static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005431
Gabor Mezeic15ef932024-06-13 12:53:54 +02005432#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005433#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005435#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005436#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5437 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005438#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005439#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005441#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005442#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005443
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005444#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005445#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005447#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005448#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5449 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005450#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005451#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005453#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005454#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005455
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005456#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005457#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005459#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005460#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5461 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005462#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005463#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005465#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005466#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005467
Gabor Mezei15b95a62022-05-09 16:37:58 +02005468 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005469};
5470#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005471
Jerry Yu909df7b2022-01-22 11:56:27 +08005472/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005473static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005474
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005475#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005476 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005477 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005478 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005479 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5480#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005481
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005482#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005483 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005484 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005485 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005486 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5487#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005488
Gabor Mezei15b95a62022-05-09 16:37:58 +02005489 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005490};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005491
Jerry Yu909df7b2022-01-22 11:56:27 +08005492/* NOTICE: see above */
5493#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5494static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005495
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005496#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005497#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005499#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005500#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005501
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005502#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005503#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005505#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005506#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005507
Gabor Mezei15b95a62022-05-09 16:37:58 +02005508 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005509};
Jerry Yu909df7b2022-01-22 11:56:27 +08005510#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5511
Ronald Crone68ab4f2022-10-05 12:46:29 +02005512#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005513
Chien Wong4e9683e2023-12-28 17:07:43 +08005514static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005515#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005516 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005517#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005518#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005519 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005520#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005521 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005522};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005523
Ronald Crone68ab4f2022-10-05 12:46:29 +02005524#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005525/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005526 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005527MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005528static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005529{
5530 size_t i, j;
5531 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5534 for (j = 0; j < i; j++) {
5535 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005536 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 }
5538 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5539 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5540 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005541 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005542 }
5543 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005545}
5546
Ronald Crone68ab4f2022-10-05 12:46:29 +02005547#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005548
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005549/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005550 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005551 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005552int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5553 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005554{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005555#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005556 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005557#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005558
Ronald Crone68ab4f2022-10-05 12:46:29 +02005559#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5561 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5562 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005563 }
5564
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5566 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5567 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005568 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005569
5570#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5572 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5573 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005574 }
5575
Gilles Peskine449bd832023-01-11 14:50:10 +01005576 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5577 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5578 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005579 }
5580#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005581#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005582
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005583 /* Use the functions here so that they are covered in tests,
5584 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 mbedtls_ssl_conf_endpoint(conf, endpoint);
5586 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005587
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005588 /*
5589 * Things that are common to all presets
5590 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005591#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005593 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5594#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5595 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5596#endif
5597 }
5598#endif
5599
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005600#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5601 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5602#endif
5603
5604#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5605 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5606#endif
5607
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005608#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005609 conf->f_cookie_write = ssl_cookie_write_dummy;
5610 conf->f_cookie_check = ssl_cookie_check_dummy;
5611#endif
5612
5613#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5614 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5615#endif
5616
Janos Follath088ce432017-04-10 12:42:31 +01005617#if defined(MBEDTLS_SSL_SRV_C)
5618 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005619 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005620#endif
5621
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005622#if defined(MBEDTLS_SSL_PROTO_DTLS)
5623 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5624 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5625#endif
5626
5627#if defined(MBEDTLS_SSL_RENEGOTIATION)
5628 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 memset(conf->renego_period, 0x00, 2);
5630 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005631#endif
5632
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005633#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005635 const unsigned char dhm_p[] =
5636 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5637 const unsigned char dhm_g[] =
5638 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005639
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5641 dhm_p, sizeof(dhm_p),
5642 dhm_g, sizeof(dhm_g))) != 0) {
5643 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005644 }
5645 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005646#endif
5647
Ronald Cron6f135e12021-12-08 16:57:54 +01005648#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005649
5650#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005651 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005652#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005653 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005654#endif
5655#endif /* MBEDTLS_SSL_EARLY_DATA */
5656
Jerry Yud0766ec2022-09-22 10:46:57 +08005657#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005658 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005660#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005661 /*
5662 * Allow all TLS 1.3 key exchange modes by default.
5663 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005664 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005665#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005668#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005669 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005670 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005671#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005673#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005675#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005676 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5677 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005678#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5679 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5680 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5681#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5682 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5683 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5684#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005686#endif
5687 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005688
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005689 /*
5690 * Preset-specific defaults
5691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005693 /*
5694 * NSA Suite B
5695 */
5696 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005697
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005698 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005699
5700#if defined(MBEDTLS_X509_CRT_PARSE_C)
5701 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005702#endif
5703
Ronald Crone68ab4f2022-10-05 12:46:29 +02005704#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005705#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005707 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005709#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005711#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005712
Brett Warrene0edc842021-08-17 09:53:13 +01005713 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005714 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005715
5716 /*
5717 * Default
5718 */
5719 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005720
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005721 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005722
5723#if defined(MBEDTLS_X509_CRT_PARSE_C)
5724 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5725#endif
5726
Ronald Crone68ab4f2022-10-05 12:46:29 +02005727#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005728#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005730 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005734#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005735
Brett Warrene0edc842021-08-17 09:53:13 +01005736 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005737
5738#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
5739 conf->dhm_min_bitlen = 1024;
5740#endif
5741 }
5742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005744}
5745
5746/*
5747 * Free mbedtls_ssl_config
5748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005749void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005750{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005751 if (conf == NULL) {
5752 return;
5753 }
5754
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005755#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 mbedtls_mpi_free(&conf->dhm_P);
5757 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005758#endif
5759
Ronald Cron73fe8df2022-10-05 14:31:43 +02005760#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005762 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5763 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005765 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005766 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005767 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005768 }
5769
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005771 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005772 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005773 conf->psk_identity_len = 0;
5774 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005775#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005776
5777#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005779#endif
5780
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005782}
5783
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005784#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005785 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005786/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005787 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005789unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005790{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5793 return MBEDTLS_SSL_SIG_RSA;
5794 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005795#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005796#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5798 return MBEDTLS_SSL_SIG_ECDSA;
5799 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005800#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005802}
5803
Gilles Peskine449bd832023-01-11 14:50:10 +01005804unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005805{
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005807 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005809 case MBEDTLS_PK_ECDSA:
5810 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005812 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005814 }
5815}
5816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005818{
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005820#if defined(MBEDTLS_RSA_C)
5821 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005823#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005824#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005825 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005827#endif
5828 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005830 }
5831}
Valerio Settie9646ec2023-08-02 20:02:28 +02005832#endif /* MBEDTLS_PK_C &&
5833 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005834
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005835/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005836 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005838mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005839{
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005841#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005842 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005844#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005845#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005846 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005848#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005849#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005850 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005852#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005853#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005854 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005856#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005857#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005858 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005860#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005861#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005862 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005864#endif
5865 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005867 }
5868}
5869
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005870/*
5871 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005873unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005874{
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005876#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005877 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005879#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005880#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005881 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005883#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005884#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005885 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005887#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005888#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005889 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005891#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005892#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005893 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005895#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005896#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005897 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005899#endif
5900 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005902 }
5903}
5904
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005905/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005906 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005907 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005909int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005910{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005911 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if (group_list == NULL) {
5914 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005915 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005916
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 for (; *group_list != 0; group_list++) {
5918 if (*group_list == tls_id) {
5919 return 0;
5920 }
5921 }
5922
5923 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005924}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005925
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005926#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005927/*
5928 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005930int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005931{
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005933
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005935 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005939}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005940#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005941
Valerio Setti18c9fed2022-12-30 17:44:24 +01005942static const struct {
5943 uint16_t tls_id;
5944 mbedtls_ecp_group_id ecp_group_id;
5945 psa_ecc_family_t psa_family;
5946 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005947} tls_id_match_table[] =
5948{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005949#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005950 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005951#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005952#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005953 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005954#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005955#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005956 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005957#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005958#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005959 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005960#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005961#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005962 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005963#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005964#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005965 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005966#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005967#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005968 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005969#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005970#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005971 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005972#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005973#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005974 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005975#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005976#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005977 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005978#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005979#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005980 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005981#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005982#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005983 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005984#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005985 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005986};
5987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005989 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005991{
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5993 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005994 if (type != NULL) {
5995 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 }
5997 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005998 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006000 return PSA_SUCCESS;
6001 }
6002 }
6003
6004 return PSA_ERROR_NOT_SUPPORTED;
6005}
6006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006008{
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6010 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006011 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006013 }
6014
6015 return MBEDTLS_ECP_DP_NONE;
6016}
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006019{
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6021 i++) {
6022 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006023 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006025 }
6026
6027 return 0;
6028}
6029
Valerio Setti67419f02023-01-04 16:12:42 +01006030#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006031static const struct {
6032 uint16_t tls_id;
6033 const char *name;
6034} tls_id_curve_name_table[] =
6035{
Valerio Setti54e23792023-07-07 10:49:27 +02006036 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6037 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6038 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6039 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6040 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6041 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6042 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6043 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6044 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6045 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6046 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6047 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6048 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006049 { 0, NULL },
6050};
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006053{
Valerio Settiacd32c02023-06-29 18:06:29 +02006054 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6055 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6056 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006058 }
6059
6060 return NULL;
6061}
Valerio Setti67419f02023-01-04 16:12:42 +01006062#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6065 const mbedtls_md_type_t md,
6066 unsigned char *dst,
6067 size_t dst_len,
6068 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006069{
Ronald Cronf6893e12022-01-07 22:09:01 +01006070 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6071 psa_hash_operation_t *hash_operation_to_clone;
6072 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6073
Jerry Yu148165c2021-09-24 23:20:59 +08006074 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006077#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 case MBEDTLS_MD_SHA384:
6079 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6080 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006081#endif
6082
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006083#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 case MBEDTLS_MD_SHA256:
6085 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6086 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006087#endif
6088
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 default:
6090 goto exit;
6091 }
6092
6093 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6094 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006095 goto exit;
6096 }
6097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6099 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006100 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006102
6103exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006104#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006105 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006106 (void) ssl;
6107#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006108 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006109}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006110
Ronald Crone68ab4f2022-10-05 12:46:29 +02006111#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006112/* mbedtls_ssl_parse_sig_alg_ext()
6113 *
6114 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6115 * value (TLS 1.3 RFC8446):
6116 * enum {
6117 * ....
6118 * ecdsa_secp256r1_sha256( 0x0403 ),
6119 * ecdsa_secp384r1_sha384( 0x0503 ),
6120 * ecdsa_secp521r1_sha512( 0x0603 ),
6121 * ....
6122 * } SignatureScheme;
6123 *
6124 * struct {
6125 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6126 * } SignatureSchemeList;
6127 *
6128 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6129 * value (TLS 1.2 RFC5246):
6130 * enum {
6131 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6132 * sha512(6), (255)
6133 * } HashAlgorithm;
6134 *
6135 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6136 * SignatureAlgorithm;
6137 *
6138 * struct {
6139 * HashAlgorithm hash;
6140 * SignatureAlgorithm signature;
6141 * } SignatureAndHashAlgorithm;
6142 *
6143 * SignatureAndHashAlgorithm
6144 * supported_signature_algorithms<2..2^16-2>;
6145 *
6146 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6147 * generalization of the TLS 1.2 signature algorithm extension.
6148 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6149 * `SignatureScheme` field of TLS 1.3
6150 *
6151 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006152int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6153 const unsigned char *buf,
6154 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006155{
6156 const unsigned char *p = buf;
6157 size_t supported_sig_algs_len = 0;
6158 const unsigned char *supported_sig_algs_end;
6159 uint16_t sig_alg;
6160 uint32_t common_idx = 0;
6161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6163 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006164 p += 2;
6165
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 memset(ssl->handshake->received_sig_algs, 0,
6167 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006168
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006170 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 while (p < supported_sig_algs_end) {
6172 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6173 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006174 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6176 sig_alg,
6177 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006178#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6180 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6181 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006182 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006183 }
6184#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006185
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6187 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006190 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6191 common_idx += 1;
6192 }
6193 }
6194 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 if (p != end) {
6196 MBEDTLS_SSL_DEBUG_MSG(1,
6197 ("Signature algorithms extension length misaligned"));
6198 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6199 MBEDTLS_ERR_SSL_DECODE_ERROR);
6200 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006201 }
6202
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 if (common_idx == 0) {
6204 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6205 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6206 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6207 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006208 }
6209
Gabor Mezei15b95a62022-05-09 16:37:58 +02006210 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006212}
6213
Ronald Crone68ab4f2022-10-05 12:46:29 +02006214#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006215
Jerry Yudc7bd172022-02-17 13:44:15 +08006216#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6217
Jerry Yudc7bd172022-02-17 13:44:15 +08006218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6220 mbedtls_svc_key_id_t key,
6221 psa_algorithm_t alg,
6222 const unsigned char *raw_psk, size_t raw_psk_length,
6223 const unsigned char *seed, size_t seed_length,
6224 const unsigned char *label, size_t label_length,
6225 const unsigned char *other_secret,
6226 size_t other_secret_length,
6227 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006228{
6229 psa_status_t status;
6230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 status = psa_key_derivation_setup(derivation, alg);
6232 if (status != PSA_SUCCESS) {
6233 return status;
6234 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6237 status = psa_key_derivation_input_bytes(derivation,
6238 PSA_KEY_DERIVATION_INPUT_SEED,
6239 seed, seed_length);
6240 if (status != PSA_SUCCESS) {
6241 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006242 }
6243
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 if (other_secret != NULL) {
6245 status = psa_key_derivation_input_bytes(derivation,
6246 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6247 other_secret, other_secret_length);
6248 if (status != PSA_SUCCESS) {
6249 return status;
6250 }
6251 }
6252
6253 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006254 status = psa_key_derivation_input_bytes(
6255 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 raw_psk, raw_psk_length);
6257 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006258 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006260 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 if (status != PSA_SUCCESS) {
6262 return status;
6263 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006264
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 status = psa_key_derivation_input_bytes(derivation,
6266 PSA_KEY_DERIVATION_INPUT_LABEL,
6267 label, label_length);
6268 if (status != PSA_SUCCESS) {
6269 return status;
6270 }
6271 } else {
6272 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006273 }
6274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 status = psa_key_derivation_set_capacity(derivation, capacity);
6276 if (status != PSA_SUCCESS) {
6277 return status;
6278 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006281}
6282
Andrzej Kurek57d10632022-10-24 10:32:01 -04006283#if defined(PSA_WANT_ALG_SHA_384) || \
6284 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006286static int tls_prf_generic(mbedtls_md_type_t md_type,
6287 const unsigned char *secret, size_t slen,
6288 const char *label,
6289 const unsigned char *random, size_t rlen,
6290 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006291{
6292 psa_status_t status;
6293 psa_algorithm_t alg;
6294 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6295 psa_key_derivation_operation_t derivation =
6296 PSA_KEY_DERIVATION_OPERATION_INIT;
6297
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006299 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006300 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006301 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006303
6304 /* Normally a "secret" should be long enough to be impossible to
6305 * find by brute force, and in particular should not be empty. But
6306 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6307 * and for this use case it makes sense to have a 0-length "secret".
6308 * Since the key API doesn't allow importing a key of length 0,
6309 * keep master_key=0, which setup_psa_key_derivation() understands
6310 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006312 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6314 psa_set_key_algorithm(&key_attributes, alg);
6315 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006316
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6318 if (status != PSA_SUCCESS) {
6319 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6320 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006321 }
6322
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 status = setup_psa_key_derivation(&derivation,
6324 master_key, alg,
6325 NULL, 0,
6326 random, rlen,
6327 (unsigned char const *) label,
6328 (size_t) strlen(label),
6329 NULL, 0,
6330 dlen);
6331 if (status != PSA_SUCCESS) {
6332 psa_key_derivation_abort(&derivation);
6333 psa_destroy_key(master_key);
6334 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006335 }
6336
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6338 if (status != PSA_SUCCESS) {
6339 psa_key_derivation_abort(&derivation);
6340 psa_destroy_key(master_key);
6341 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006342 }
6343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 status = psa_key_derivation_abort(&derivation);
6345 if (status != PSA_SUCCESS) {
6346 psa_destroy_key(master_key);
6347 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006348 }
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 if (!mbedtls_svc_key_id_is_null(master_key)) {
6351 status = psa_destroy_key(master_key);
6352 }
6353 if (status != PSA_SUCCESS) {
6354 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6355 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006358}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006359#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006360
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006361#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006362MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006363static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6364 const char *label,
6365 const unsigned char *random, size_t rlen,
6366 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006367{
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6369 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006370}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006371#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006372
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006373#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006374MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006375static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6376 const char *label,
6377 const unsigned char *random, size_t rlen,
6378 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006379{
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6381 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006382}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006383#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006384
Jerry Yuf009d862022-02-17 14:01:37 +08006385/*
6386 * Set appropriate PRF function and other SSL / TLS1.2 functions
6387 *
6388 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006389 * - hash associated with the ciphersuite (only used by TLS 1.2)
6390 *
6391 * Outputs:
6392 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6393 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006395static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6396 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006397{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006398#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006400 handshake->tls_prf = tls_prf_sha384;
6401 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6402 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006404#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006405#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006406 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006407 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006408 handshake->tls_prf = tls_prf_sha256;
6409 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6410 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6411 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006412#else
Jerry Yuf009d862022-02-17 14:01:37 +08006413 {
Jerry Yuf009d862022-02-17 14:01:37 +08006414 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006415 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006417 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006418#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006421}
Jerry Yud6ab2352022-02-17 14:03:43 +08006422
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423/*
6424 * Compute master secret if needed
6425 *
6426 * Parameters:
6427 * [in/out] handshake
6428 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6429 * (PSA-PSK) ciphersuite_info, psk_opaque
6430 * [out] premaster (cleared)
6431 * [out] master
6432 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6433 * debug: conf->f_dbg, conf->p_dbg
6434 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006435 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006437MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006438static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6439 unsigned char *master,
6440 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006441{
6442 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6443
6444 /* cf. RFC 5246, Section 8.1:
6445 * "The master secret is always exactly 48 bytes in length." */
6446 size_t const master_secret_len = 48;
6447
6448#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6449 unsigned char session_hash[48];
6450#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6451
6452 /* The label for the KDF used for key expansion.
6453 * This is either "master secret" or "extended master secret"
6454 * depending on whether the Extended Master Secret extension
6455 * is used. */
6456 char const *lbl = "master secret";
6457
Przemek Stekielae4ed302022-04-05 17:15:55 +02006458 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459 * - If the Extended Master Secret extension is not used,
6460 * this is ClientHello.Random + ServerHello.Random
6461 * (see Sect. 8.1 in RFC 5246).
6462 * - If the Extended Master Secret extension is used,
6463 * this is the transcript of the handshake so far.
6464 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006465 unsigned char const *seed = handshake->randbytes;
6466 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006467
6468#if !defined(MBEDTLS_DEBUG_C) && \
6469 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006470 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006471 ssl = NULL; /* make sure we don't use it except for those cases */
6472 (void) ssl;
6473#endif
6474
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 if (handshake->resume != 0) {
6476 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6477 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478 }
6479
6480#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006482 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006483 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006484 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6485 if (ret != 0) {
6486 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6487 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6490 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006491 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006492#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006493
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006494#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006496 /* Perform PSK-to-MS expansion in a single step. */
6497 psa_status_t status;
6498 psa_algorithm_t alg;
6499 mbedtls_svc_key_id_t psk;
6500 psa_key_derivation_operation_t derivation =
6501 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006502 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006509 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006511 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006513
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006514 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006518 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006519 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006520 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006521 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006522 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6523 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6524 other_secret = handshake->premaster + 2;
6525 break;
6526 default:
6527 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006528 }
6529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 status = setup_psa_key_derivation(&derivation, psk, alg,
6531 ssl->conf->psk, ssl->conf->psk_len,
6532 seed, seed_len,
6533 (unsigned char const *) lbl,
6534 (size_t) strlen(lbl),
6535 other_secret, other_secret_len,
6536 master_secret_len);
6537 if (status != PSA_SUCCESS) {
6538 psa_key_derivation_abort(&derivation);
6539 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006540 }
6541
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 status = psa_key_derivation_output_bytes(&derivation,
6543 master,
6544 master_secret_len);
6545 if (status != PSA_SUCCESS) {
6546 psa_key_derivation_abort(&derivation);
6547 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006548 }
6549
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 status = psa_key_derivation_abort(&derivation);
6551 if (status != PSA_SUCCESS) {
6552 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6553 }
6554 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006555#endif
6556 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006557#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006559 psa_status_t status;
6560 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6561 psa_key_derivation_operation_t derivation =
6562 PSA_KEY_DERIVATION_OPERATION_INIT;
6563
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006565
6566 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6567
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 status = psa_key_derivation_setup(&derivation, alg);
6569 if (status != PSA_SUCCESS) {
6570 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006571 }
6572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 status = psa_key_derivation_set_capacity(&derivation,
6574 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6575 if (status != PSA_SUCCESS) {
6576 psa_key_derivation_abort(&derivation);
6577 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006578 }
6579
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6581 &derivation);
6582 if (status != PSA_SUCCESS) {
6583 psa_key_derivation_abort(&derivation);
6584 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006585 }
6586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 status = psa_key_derivation_output_bytes(&derivation,
6588 handshake->premaster,
6589 handshake->pmslen);
6590 if (status != PSA_SUCCESS) {
6591 psa_key_derivation_abort(&derivation);
6592 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6593 }
6594
6595 status = psa_key_derivation_abort(&derivation);
6596 if (status != PSA_SUCCESS) {
6597 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006598 }
6599 }
6600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6602 lbl, seed, seed_len,
6603 master,
6604 master_secret_len);
6605 if (ret != 0) {
6606 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6607 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006608 }
6609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6611 handshake->premaster,
6612 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006613
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 mbedtls_platform_zeroize(handshake->premaster,
6615 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006616 }
6617
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006619}
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006622{
6623 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6624 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6625 ssl->handshake->ciphersuite_info;
6626
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006628
6629 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006631 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 if (ret != 0) {
6633 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6634 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006635 }
6636
6637 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 ret = ssl_compute_master(ssl->handshake,
6639 ssl->session_negotiate->master,
6640 ssl);
6641 if (ret != 0) {
6642 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6643 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006644 }
6645
6646 /* Swap the client and server random values:
6647 * - MS derivation wanted client+server (RFC 5246 8.1)
6648 * - key derivation wants server+client (RFC 5246 6.3) */
6649 {
6650 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 memcpy(tmp, ssl->handshake->randbytes, 64);
6652 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6653 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6654 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006655 }
6656
6657 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6659 ssl->session_negotiate->ciphersuite,
6660 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006661#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006663#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006664 ssl->handshake->tls_prf,
6665 ssl->handshake->randbytes,
6666 ssl->tls_version,
6667 ssl->conf->endpoint,
6668 ssl);
6669 if (ret != 0) {
6670 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6671 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006672 }
6673
6674 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6676 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006679
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006681}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006684{
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006686#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006687 case MBEDTLS_SSL_HASH_SHA384:
6688 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6689 break;
6690#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006691#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006692 case MBEDTLS_SSL_HASH_SHA256:
6693 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6694 break;
6695#endif
6696 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006698 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006699#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006700 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006701 (void) ssl;
6702#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006704}
6705
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006706static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6707 const psa_hash_operation_t *hs_op,
6708 size_t buffer_size,
6709 unsigned char *hash,
6710 size_t *hlen)
6711{
6712 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006713 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006714
6715#if !defined(MBEDTLS_DEBUG_C)
6716 (void) ssl;
6717#endif
6718 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006719 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006720 if (status != PSA_SUCCESS) {
6721 goto exit;
6722 }
6723
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006724 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006725 if (status != PSA_SUCCESS) {
6726 goto exit;
6727 }
6728
6729 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6730 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6731
6732exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006733 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006734 return mbedtls_md_error_from_psa(status);
6735}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006736
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006737#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006738int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6739 unsigned char *hash,
6740 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006741{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006742 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6743 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006744}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006745#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006746
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006747#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006748int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6749 unsigned char *hash,
6750 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006751{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006752 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6753 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006754}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006755#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006756
Jerry Yuc2c673d2022-02-17 14:20:39 +08006757#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006759static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006760
6761#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006762int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006763{
6764 /* If renegotiation is not enforced, retransmit until we would reach max
6765 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006767 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6768 unsigned char doublings = 1;
6769
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006771 ++doublings;
6772 ratio >>= 1;
6773 }
6774
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (++ssl->renego_records_seen > doublings) {
6776 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6777 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006778 }
6779 }
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006782}
6783#endif
6784#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006785
Jerry Yud9526692022-02-17 14:23:47 +08006786/*
6787 * Handshake functions
6788 */
6789#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6790/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006791int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006792{
6793 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6794 ssl->handshake->ciphersuite_info;
6795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6799 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006800 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006802 }
6803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6805 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006806}
6807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006809{
6810 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6811 ssl->handshake->ciphersuite_info;
6812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6816 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006817 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006819 }
6820
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6822 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006823}
6824
6825#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6826/* Some certificate support -> implement write and parse */
6827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006829{
6830 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6831 size_t i, n;
6832 const mbedtls_x509_crt *crt;
6833 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6834 ssl->handshake->ciphersuite_info;
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6839 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006840 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006842 }
6843
6844#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6846 if (ssl->handshake->client_auth == 0) {
6847 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006848 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006850 }
6851 }
6852#endif /* MBEDTLS_SSL_CLI_C */
6853#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6855 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006856 /* Should never happen because we shouldn't have picked the
6857 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006859 }
6860 }
6861#endif
6862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006864
6865 /*
6866 * 0 . 0 handshake type
6867 * 1 . 3 handshake length
6868 * 4 . 6 length of all certs
6869 * 7 . 9 length of cert. 1
6870 * 10 . n-1 peer certificate
6871 * n . n+2 length of cert. 2
6872 * n+3 . ... upper level cert, etc.
6873 */
6874 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006878 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6880 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6881 " > %" MBEDTLS_PRINTF_SIZET,
6882 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6883 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006884 }
6885
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6887 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6888 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006891 i += n; crt = crt->next;
6892 }
6893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6895 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6896 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006897
6898 ssl->out_msglen = i;
6899 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6900 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6901
6902 ssl->state++;
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6905 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6906 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006907 }
6908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006912}
6913
6914#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6915
6916#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006917MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006918static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6919 unsigned char *crt_buf,
6920 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006921{
6922 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 if (peer_crt == NULL) {
6925 return -1;
6926 }
Jerry Yud9526692022-02-17 14:23:47 +08006927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 if (peer_crt->raw.len != crt_buf_len) {
6929 return -1;
6930 }
Jerry Yud9526692022-02-17 14:23:47 +08006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006933}
6934#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006935MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006936static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6937 unsigned char *crt_buf,
6938 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006939{
6940 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6941 unsigned char const * const peer_cert_digest =
6942 ssl->session->peer_cert_digest;
6943 mbedtls_md_type_t const peer_cert_digest_type =
6944 ssl->session->peer_cert_digest_type;
6945 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006947 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6948 size_t digest_len;
6949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (peer_cert_digest == NULL || digest_info == NULL) {
6951 return -1;
6952 }
Jerry Yud9526692022-02-17 14:23:47 +08006953
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 digest_len = mbedtls_md_get_size(digest_info);
6955 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6956 return -1;
6957 }
Jerry Yud9526692022-02-17 14:23:47 +08006958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6960 if (ret != 0) {
6961 return -1;
6962 }
Jerry Yud9526692022-02-17 14:23:47 +08006963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006965}
6966#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6967#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6968
6969/*
6970 * Once the certificate message is read, parse it into a cert chain and
6971 * perform basic checks, but leave actual verification to the caller
6972 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006973MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006974static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6975 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006976{
6977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6978#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006980#endif
6981 size_t i, n;
6982 uint8_t alert;
6983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6985 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6986 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6987 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6988 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006989 }
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6992 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6993 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6994 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006995 }
6996
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6998 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6999 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7000 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7001 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007002 }
7003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007005
7006 /*
7007 * Same message structure as in mbedtls_ssl_write_certificate()
7008 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007009 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007010
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 if (ssl->in_msg[i] != 0 ||
7012 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7013 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7014 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7015 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7016 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007017 }
7018
7019 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7020 i += 3;
7021
7022 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007024 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 if (i + 3 > ssl->in_hslen) {
7026 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7027 mbedtls_ssl_send_alert_message(ssl,
7028 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7029 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7030 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007031 }
7032 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7033 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (ssl->in_msg[i] != 0) {
7035 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7036 mbedtls_ssl_send_alert_message(ssl,
7037 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7038 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7039 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007040 }
7041
7042 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007043 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007044 i += 3;
7045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (n < 128 || i + n > ssl->in_hslen) {
7047 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7048 mbedtls_ssl_send_alert_message(ssl,
7049 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7050 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7051 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007052 }
7053
7054 /* Check if we're handling the first CRT in the chain. */
7055#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007057 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007059 /* During client-side renegotiation, check that the server's
7060 * end-CRTs hasn't changed compared to the initial handshake,
7061 * mitigating the triple handshake attack. On success, reuse
7062 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7064 if (ssl_check_peer_crt_unchanged(ssl,
7065 &ssl->in_msg[i],
7066 n) != 0) {
7067 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7068 mbedtls_ssl_send_alert_message(ssl,
7069 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7070 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7071 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007072 }
7073
7074 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007076 }
7077#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7078
7079 /* Parse the next certificate in the chain. */
7080#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007082#else
7083 /* If we don't need to store the CRT chain permanently, parse
7084 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007086#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007088 case 0: /*ok*/
7089 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7090 /* Ignore certificate with an unknown algorithm: maybe a
7091 prior certificate was already trusted. */
7092 break;
7093
7094 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7095 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7096 goto crt_parse_der_failed;
7097
7098 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7099 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7100 goto crt_parse_der_failed;
7101
7102 default:
7103 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007104crt_parse_der_failed:
7105 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7106 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7107 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007108 }
7109
7110 i += n;
7111 }
7112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7114 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007115}
7116
7117#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007118MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007119static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007120{
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7122 return -1;
7123 }
Jerry Yud9526692022-02-17 14:23:47 +08007124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007126 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7127 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7129 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7130 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007131 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007133}
7134#endif /* MBEDTLS_SSL_SRV_C */
7135
7136/* Check if a certificate message is expected.
7137 * Return either
7138 * - SSL_CERTIFICATE_EXPECTED, or
7139 * - SSL_CERTIFICATE_SKIP
7140 * indicating whether a Certificate message is expected or not.
7141 */
7142#define SSL_CERTIFICATE_EXPECTED 0
7143#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007145static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7146 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007147{
7148 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7149 ssl->handshake->ciphersuite_info;
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7152 return SSL_CERTIFICATE_SKIP;
7153 }
Jerry Yud9526692022-02-17 14:23:47 +08007154
7155#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007156 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007158 ssl->session_negotiate->verify_result =
7159 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007161 }
7162 }
7163#else
7164 ((void) authmode);
7165#endif /* MBEDTLS_SSL_SRV_C */
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007168}
7169
Jerry Yud9526692022-02-17 14:23:47 +08007170#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007171MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007172static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7173 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007174{
7175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7176 /* Remember digest of the peer's end-CRT. */
7177 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7179 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7180 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7181 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7182 mbedtls_ssl_send_alert_message(ssl,
7183 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7184 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007185
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007187 }
7188
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 ret = mbedtls_md(mbedtls_md_info_from_type(
7190 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7191 start, len,
7192 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007193
7194 ssl->session_negotiate->peer_cert_digest_type =
7195 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7196 ssl->session_negotiate->peer_cert_digest_len =
7197 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007200}
7201
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007202MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007203static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7204 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007205{
7206 unsigned char *end = start + len;
7207 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7208
7209 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7211 ret = mbedtls_pk_parse_subpubkey(&start, end,
7212 &ssl->handshake->peer_pubkey);
7213 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007214 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007216 }
7217
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007219}
7220#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7221
Gilles Peskine449bd832023-01-11 14:50:10 +01007222int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007223{
7224 int ret = 0;
7225 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007226 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007227#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7228 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7229 ? ssl->handshake->sni_authmode
7230 : ssl->conf->authmode;
7231#else
7232 const int authmode = ssl->conf->authmode;
7233#endif
7234 void *rs_ctx = NULL;
7235 mbedtls_x509_crt *chain = NULL;
7236
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007238
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7240 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7241 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007242 goto exit;
7243 }
7244
7245#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007246 if (ssl->handshake->ecrs_enabled &&
7247 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007248 chain = ssl->handshake->ecrs_peer_cert;
7249 ssl->handshake->ecrs_peer_cert = NULL;
7250 goto crt_verify;
7251 }
7252#endif
7253
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007255 /* mbedtls_ssl_read_record may have sent an alert already. We
7256 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007258 goto exit;
7259 }
7260
7261#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007263 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007266 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 }
Jerry Yud9526692022-02-17 14:23:47 +08007268
7269 goto exit;
7270 }
7271#endif /* MBEDTLS_SSL_SRV_C */
7272
7273 /* Clear existing peer CRT structure in case we tried to
7274 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7278 if (chain == NULL) {
7279 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7280 sizeof(mbedtls_x509_crt)));
7281 mbedtls_ssl_send_alert_message(ssl,
7282 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7283 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007284
7285 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7286 goto exit;
7287 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007288 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 ret = ssl_parse_certificate_chain(ssl, chain);
7291 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007292 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 }
Jerry Yud9526692022-02-17 14:23:47 +08007294
7295#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007297 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 }
Jerry Yud9526692022-02-17 14:23:47 +08007299
7300crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007302 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 }
Jerry Yud9526692022-02-17 14:23:47 +08007304#endif
7305
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007306 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7307 ssl->handshake->ciphersuite_info,
7308 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007310 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 }
Jerry Yud9526692022-02-17 14:23:47 +08007312
7313#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7314 {
7315 unsigned char *crt_start, *pk_start;
7316 size_t crt_len, pk_len;
7317
7318 /* We parse the CRT chain without copying, so
7319 * these pointers point into the input buffer,
7320 * and are hence still valid after freeing the
7321 * CRT chain. */
7322
7323 crt_start = chain->raw.p;
7324 crt_len = chain->raw.len;
7325
7326 pk_start = chain->pk_raw.p;
7327 pk_len = chain->pk_raw.len;
7328
7329 /* Free the CRT structures before computing
7330 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 mbedtls_x509_crt_free(chain);
7332 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007333 chain = NULL;
7334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7336 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007337 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 }
Jerry Yud9526692022-02-17 14:23:47 +08007339
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7341 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 }
Jerry Yud9526692022-02-17 14:23:47 +08007344 }
7345#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7346 /* Pass ownership to session structure. */
7347 ssl->session_negotiate->peer_cert = chain;
7348 chain = NULL;
7349#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7350
Gilles Peskine449bd832023-01-11 14:50:10 +01007351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007352
7353exit:
7354
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007356 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 }
Jerry Yud9526692022-02-17 14:23:47 +08007358
7359#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007361 ssl->handshake->ecrs_peer_cert = chain;
7362 chain = NULL;
7363 }
7364#endif
7365
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (chain != NULL) {
7367 mbedtls_x509_crt_free(chain);
7368 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007369 }
7370
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007372}
7373#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7374
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007375static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7376 unsigned char *padbuf, size_t hlen,
7377 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007378{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007379 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007380 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007381 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007382 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007383 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007384 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007385
7386 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007388 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007392 ? "client finished"
7393 : "server finished";
7394
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007395 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007396
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007397 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007399 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007400 }
7401
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007402 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007404 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007405 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007406 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007407
7408 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7409
Jerry Yu615bd6f2022-02-17 14:25:15 +08007410 /*
7411 * TLSv1.2:
7412 * hash = PRF( master, finished_label,
7413 * Hash( handshake ) )[0.11]
7414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007416 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007417
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007419
Paul Elliottecb95be2023-08-11 16:41:04 +01007420 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007421
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007422 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007423
7424exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007425 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007426 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007427}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007428
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007429#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007430static int ssl_calc_finished_tls_sha256(
7431 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7432{
7433 unsigned char padbuf[32];
7434 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007435 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007436 padbuf, sizeof(padbuf),
7437 buf, from);
7438}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007439#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007440
Jerry Yub7ba49e2022-02-17 14:25:53 +08007441
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007442#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007443static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007445{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007446 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007447 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007448 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007449 padbuf, sizeof(padbuf),
7450 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007451}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007452#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007455{
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007457
7458 /*
7459 * Free our handshake params
7460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 mbedtls_ssl_handshake_free(ssl);
7462 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007463 ssl->handshake = NULL;
7464
7465 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007466 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 if (ssl->transform) {
7469 mbedtls_ssl_transform_free(ssl->transform);
7470 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007471 }
7472 ssl->transform = ssl->transform_negotiate;
7473 ssl->transform_negotiate = NULL;
7474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007476}
7477
Gilles Peskine449bd832023-01-11 14:50:10 +01007478void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007479{
7480 int resume = ssl->handshake->resume;
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007483
7484#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007486 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7487 ssl->renego_records_seen = 0;
7488 }
7489#endif
7490
7491 /*
7492 * Free the previous session and switch in the current one
7493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007495#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7496 /* RFC 7366 3.1: keep the EtM state */
7497 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007499#endif
7500
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 mbedtls_ssl_session_free(ssl->session);
7502 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007503 }
7504 ssl->session = ssl->session_negotiate;
7505 ssl->session_negotiate = NULL;
7506
7507 /*
7508 * Add cache entry
7509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007511 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 resume == 0) {
7513 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7514 ssl->session->id,
7515 ssl->session->id_len,
7516 ssl->session) != 0) {
7517 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7518 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007519 }
7520
7521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7523 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007524 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007526
7527 /* Keep last flight around in case we need to resend it:
7528 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7530 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007531#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007533
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007534 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007537}
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007540{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007541 int ret;
7542 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007547
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007548 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7549 if (ret != 0) {
7550 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7551 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007552
7553 /*
7554 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7555 * may define some other value. Currently (early 2016), no defined
7556 * ciphersuite does this (and this is unlikely to change as activity has
7557 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7558 */
7559 hash_len = 12;
7560
7561#if defined(MBEDTLS_SSL_RENEGOTIATION)
7562 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007564#endif
7565
7566 ssl->out_msglen = 4 + hash_len;
7567 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7568 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7569
7570 /*
7571 * In case of session resuming, invert the client and server
7572 * ChangeCipherSpec messages order.
7573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007575#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007577 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007579#endif
7580#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007582 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007586 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007588
7589 /*
7590 * Switch to our negotiated transform and session parameters for outbound
7591 * data.
7592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007594
7595#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007597 unsigned char i;
7598
7599 /* Remember current epoch settings for resending */
7600 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7602 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007603
7604 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007606
7607
7608 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 for (i = 2; i > 0; i--) {
7610 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007611 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 }
7613 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007614
7615 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 if (i == 0) {
7617 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7618 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007619 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007620 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007621#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007623
7624 ssl->transform_out = ssl->transform_negotiate;
7625 ssl->session_out = ssl->session_negotiate;
7626
7627#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7629 mbedtls_ssl_send_flight_completed(ssl);
7630 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007631#endif
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7634 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7635 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007636 }
7637
7638#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7640 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7641 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7642 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007643 }
7644#endif
7645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007649}
7650
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007651#define SSL_MAX_HASH_LEN 12
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007654{
7655 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7656 unsigned int hash_len = 12;
7657 unsigned char buf[SSL_MAX_HASH_LEN];
7658
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007660
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007661 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7662 if (ret != 0) {
7663 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7664 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7667 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007668 goto exit;
7669 }
7670
Gilles Peskine449bd832023-01-11 14:50:10 +01007671 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7672 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7673 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7674 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007675 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7676 goto exit;
7677 }
7678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7680 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7681 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007682 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7683 goto exit;
7684 }
7685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7687 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7688 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7689 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007690 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7691 goto exit;
7692 }
7693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7695 buf, hash_len) != 0) {
7696 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7697 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7698 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007699 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7700 goto exit;
7701 }
7702
7703#if defined(MBEDTLS_SSL_RENEGOTIATION)
7704 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007706#endif
7707
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007709#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007711 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007713#endif
7714#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007716 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007718#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007720 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007722
7723#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7725 mbedtls_ssl_recv_flight_completed(ssl);
7726 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007727#endif
7728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007730
7731exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 mbedtls_platform_zeroize(buf, hash_len);
7733 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007734}
7735
Jerry Yu392112c2022-02-17 14:34:10 +08007736#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7737/*
7738 * Helper to get TLS 1.2 PRF from ciphersuite
7739 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007741static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007742{
Jerry Yu392112c2022-02-17 14:34:10 +08007743 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007745#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7747 return tls_prf_sha384;
7748 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007749#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007750#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007751 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007752 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7753 return tls_prf_sha256;
7754 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007755 }
7756#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007757#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007758 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007759 (void) ciphersuite_info;
7760#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007763}
7764#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007765
Gilles Peskine449bd832023-01-11 14:50:10 +01007766static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007767{
7768 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007769#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 if (tls_prf == tls_prf_sha384) {
7771 return MBEDTLS_SSL_TLS_PRF_SHA384;
7772 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007773#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007774#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 if (tls_prf == tls_prf_sha256) {
7776 return MBEDTLS_SSL_TLS_PRF_SHA256;
7777 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007778#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007780}
7781
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007782/*
7783 * Populate a transform structure with session keys and all the other
7784 * necessary information.
7785 *
7786 * Parameters:
7787 * - [in/out]: transform: structure to populate
7788 * [in] must be just initialised with mbedtls_ssl_transform_init()
7789 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7790 * - [in] ciphersuite
7791 * - [in] master
7792 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007793 * - [in] tls_prf: pointer to PRF to use for key derivation
7794 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007795 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007796 * - [in] endpoint: client or server
7797 * - [in] ssl: used for:
7798 * - ssl->conf->{f,p}_export_keys
7799 * [in] optionally used for:
7800 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7801 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007802MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007803static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7804 int ciphersuite,
7805 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007806#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007808#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 ssl_tls_prf_t tls_prf,
7810 const unsigned char randbytes[64],
7811 mbedtls_ssl_protocol_version tls_version,
7812 unsigned endpoint,
7813 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007814{
7815 int ret = 0;
7816 unsigned char keyblk[256];
7817 unsigned char *key1;
7818 unsigned char *key2;
7819 unsigned char *mac_enc;
7820 unsigned char *mac_dec;
7821 size_t mac_key_len = 0;
7822 size_t iv_copy_len;
7823 size_t keylen;
7824 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007825 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007826
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007827 psa_key_type_t key_type;
7828 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7829 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007830 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007831 size_t key_bits;
7832 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007833
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007834 /*
7835 * Some data just needs copying into the structure
7836 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007837#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007839#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007840 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007841
7842#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007844#endif
7845
7846#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007848 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7849 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007850 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851 }
7852#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7853
7854 /*
7855 * Get various info structures
7856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7858 if (ciphersuite_info == NULL) {
7859 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7860 ciphersuite));
7861 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007862 }
7863
Neil Armstrongab555e02022-04-04 11:07:59 +02007864 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007865#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007867#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007871 transform->taglen =
7872 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007874
Dave Rodgman2eab4622023-10-05 13:30:37 +01007875 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 transform->taglen,
7877 &alg,
7878 &key_type,
7879 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007880 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007882 goto end;
7883 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007884
Dave Rodgman2eab4622023-10-05 13:30:37 +01007885 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007887 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 (unsigned) ciphersuite_info->mac));
7889 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007890 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891
7892#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7893 /* Copy own and peer's CID if the use of the CID
7894 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7896 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007897
7898 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7900 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7901 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007902
7903 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7905 ssl->handshake->peer_cid_len);
7906 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7907 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908 }
7909#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7910
7911 /*
7912 * Compute key block using the PRF
7913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7915 if (ret != 0) {
7916 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7917 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007918 }
7919
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7921 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7922 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7923 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7924 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007925
7926 /*
7927 * Determine the appropriate key, IV and MAC length.
7928 */
7929
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007930 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931
Valerio Settie5707042023-10-11 11:54:42 +02007932#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007934 size_t explicit_ivlen;
7935
7936 transform->maclen = 0;
7937 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007938
7939 /* All modes haves 96-bit IVs, but the length of the static parts vary
7940 * with mode and version:
7941 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7942 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7943 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7944 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7945 * sequence number).
7946 */
7947 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007948
7949 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007951
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007953 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007955 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007957
7958 /* Minimum length of encrypted record */
7959 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7960 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 } else
Valerio Settie5707042023-10-11 11:54:42 +02007962#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007963#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007964 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007965 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007968
Neil Armstronge4512952022-03-08 09:08:22 +01007969 /* Get MAC length */
7970 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007971 transform->maclen = mac_key_len;
7972
7973 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007974 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007975
7976 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007978 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007980 /*
7981 * GenericBlockCipher:
7982 * 1. if EtM is in use: one block plus MAC
7983 * otherwise: * first multiple of blocklen greater than maclen
7984 * 2. IV
7985 */
7986#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007988 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 + block_size;
7990 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007991#endif
7992 {
7993 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 + block_size
7995 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007996 }
7997
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007999 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 } else {
8001 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008002 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8003 goto end;
8004 }
8005 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008007#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8008 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8010 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008011 }
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8014 (unsigned) keylen,
8015 (unsigned) transform->minlen,
8016 (unsigned) transform->ivlen,
8017 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008018
8019 /*
8020 * Finally setup the cipher contexts, IVs and MAC secrets.
8021 */
8022#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008024 key1 = keyblk + mac_key_len * 2;
8025 key2 = keyblk + mac_key_len * 2 + keylen;
8026
8027 mac_enc = keyblk;
8028 mac_dec = keyblk + mac_key_len;
8029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 iv_copy_len = (transform->fixed_ivlen) ?
8031 transform->fixed_ivlen : transform->ivlen;
8032 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8033 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8034 iv_copy_len);
8035 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008036#endif /* MBEDTLS_SSL_CLI_C */
8037#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008039 key1 = keyblk + mac_key_len * 2 + keylen;
8040 key2 = keyblk + mac_key_len * 2;
8041
8042 mac_enc = keyblk + mac_key_len;
8043 mac_dec = keyblk;
8044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 iv_copy_len = (transform->fixed_ivlen) ?
8046 transform->fixed_ivlen : transform->ivlen;
8047 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8048 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8049 iv_copy_len);
8050 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008051#endif /* MBEDTLS_SSL_SRV_C */
8052 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008054 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8055 goto end;
8056 }
8057
Paul Elliott4fb19552023-10-18 12:15:30 +01008058 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 ssl->f_export_keys(ssl->p_export_keys,
8060 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8061 master, 48,
8062 randbytes + 32,
8063 randbytes,
8064 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008065 }
8066
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008067 transform->psa_alg = alg;
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8070 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8071 psa_set_key_algorithm(&attributes, alg);
8072 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008073
Gilles Peskine449bd832023-01-11 14:50:10 +01008074 if ((status = psa_import_key(&attributes,
8075 key1,
8076 PSA_BITS_TO_BYTES(key_bits),
8077 &transform->psa_key_enc)) != PSA_SUCCESS) {
8078 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008079 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008081 goto end;
8082 }
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008085
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 if ((status = psa_import_key(&attributes,
8087 key2,
8088 PSA_BITS_TO_BYTES(key_bits),
8089 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008090 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008092 goto end;
8093 }
8094 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008095
Neil Armstrong29c0c042022-03-17 17:47:28 +01008096#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8097 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8098 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008101
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8103 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8104 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 if ((status = psa_import_key(&attributes,
8107 mac_enc, mac_key_len,
8108 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008109 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008111 goto end;
8112 }
8113
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8115 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008116#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008118#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008120 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8122 PSA_KEY_USAGE_VERIFY_HASH);
8123 } else {
8124 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8125 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 if ((status = psa_import_key(&attributes,
8128 mac_dec, mac_key_len,
8129 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008130 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008132 goto end;
8133 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008134 }
8135#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8136
8137 ((void) mac_dec);
8138 ((void) mac_enc);
8139
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008140end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008141 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8142 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008143}
8144
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008145#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008146int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 psa_pake_operation_t *pake_ctx,
8148 const unsigned char *buf,
8149 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008150{
8151 psa_status_t status;
8152 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008153 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008154 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8155 * At round two perform a single cycle
8156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008158
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 for (; remaining_steps > 0; remaining_steps--) {
8160 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008161 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008162 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008163 /* Length is stored at the first byte */
8164 size_t length = buf[input_offset];
8165 input_offset += 1;
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008168 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8169 }
8170
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 status = psa_pake_input(pake_ctx, step,
8172 buf + input_offset, length);
8173 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008174 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008175 }
8176
8177 input_offset += length;
8178 }
8179 }
8180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008182 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008184
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008186}
8187
Valerio Setti6b3dab02022-11-17 17:14:54 +01008188int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 psa_pake_operation_t *pake_ctx,
8190 unsigned char *buf,
8191 size_t len, size_t *olen,
8192 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008193{
8194 psa_status_t status;
8195 size_t output_offset = 0;
8196 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008197 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008198 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8199 * At round two perform a single cycle
8200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008202
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 for (; remaining_steps > 0; remaining_steps--) {
8204 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8205 step <= PSA_PAKE_STEP_ZK_PROOF;
8206 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008207 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008208 * For each step, prepend 1 byte with the length of the data as
8209 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008210 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 status = psa_pake_output(pake_ctx, step,
8212 buf + output_offset + 1,
8213 len - output_offset - 1,
8214 &output_len);
8215 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008216 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008217 }
8218
Valerio Setti99d88c12022-11-22 16:03:43 +01008219 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008220
8221 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008222 }
8223 }
8224
8225 *olen = output_offset;
8226
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008228}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008229#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008230
Gilles Peskine449bd832023-01-11 14:50:10 +01008231int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8232 unsigned char *hash, size_t *hashlen,
8233 unsigned char *data, size_t data_len,
8234 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008235{
8236 psa_status_t status;
8237 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008238 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008239
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008241
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 if ((status = psa_hash_setup(&hash_operation,
8243 hash_alg)) != PSA_SUCCESS) {
8244 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008245 goto exit;
8246 }
8247
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8249 64)) != PSA_SUCCESS) {
8250 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008251 goto exit;
8252 }
8253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if ((status = psa_hash_update(&hash_operation,
8255 data, data_len)) != PSA_SUCCESS) {
8256 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008257 goto exit;
8258 }
8259
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8261 hashlen)) != PSA_SUCCESS) {
8262 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8263 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008264 }
8265
8266exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 if (status != PSA_SUCCESS) {
8268 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8269 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8270 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008271 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008273 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8274 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008275 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008276 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008277 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008278 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008280 }
8281 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008283}
8284
Jerry Yuee40f9d2022-02-17 14:55:16 +08008285
Jerry Yud9d91da2022-02-17 14:57:06 +08008286#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8287
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008288/* Find the preferred hash for a given signature algorithm. */
8289unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 mbedtls_ssl_context *ssl,
8291 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008292{
Gabor Mezei078e8032022-04-27 21:17:56 +02008293 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008294 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008295
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8297 return MBEDTLS_SSL_HASH_NONE;
8298 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008299
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008301 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8303 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008304 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8306 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008307
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008308 mbedtls_md_type_t md_alg =
8309 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8310 if (md_alg == MBEDTLS_MD_NONE) {
8311 continue;
8312 }
8313
Gilles Peskine449bd832023-01-11 14:50:10 +01008314 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008315 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008316 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008317 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008318
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8320 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8321 PSA_ALG_ECDSA(psa_hash_alg),
8322 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008323 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008325
Gilles Peskine449bd832023-01-11 14:50:10 +01008326 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8327 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8328 PSA_ALG_RSA_PKCS1V15_SIGN(
8329 psa_hash_alg),
8330 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008331 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008333 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008334
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008336 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008337 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008338
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008340}
8341
8342#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8343
Jerry Yudc7bd172022-02-17 13:44:15 +08008344#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8345
XiaokangQian75d40ef2022-04-20 11:05:24 +00008346int mbedtls_ssl_validate_ciphersuite(
8347 const mbedtls_ssl_context *ssl,
8348 const mbedtls_ssl_ciphersuite_t *suite_info,
8349 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008351{
8352 (void) ssl;
8353
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 if (suite_info == NULL) {
8355 return -1;
8356 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008357
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 if ((suite_info->min_tls_version > max_tls_version) ||
8359 (suite_info->max_tls_version < min_tls_version)) {
8360 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008361 }
8362
XiaokangQian060d8672022-04-21 09:24:56 +00008363#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008364#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008366 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008367 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008368 }
8369#endif
8370
8371 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8372#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8374 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8375 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008376 }
8377#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8378#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8379
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008381}
8382
Ronald Crone68ab4f2022-10-05 12:46:29 +02008383#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008384/*
8385 * Function for writing a signature algorithm extension.
8386 *
8387 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8388 * value (TLS 1.3 RFC8446):
8389 * enum {
8390 * ....
8391 * ecdsa_secp256r1_sha256( 0x0403 ),
8392 * ecdsa_secp384r1_sha384( 0x0503 ),
8393 * ecdsa_secp521r1_sha512( 0x0603 ),
8394 * ....
8395 * } SignatureScheme;
8396 *
8397 * struct {
8398 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8399 * } SignatureSchemeList;
8400 *
8401 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8402 * value (TLS 1.2 RFC5246):
8403 * enum {
8404 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8405 * sha512(6), (255)
8406 * } HashAlgorithm;
8407 *
8408 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8409 * SignatureAlgorithm;
8410 *
8411 * struct {
8412 * HashAlgorithm hash;
8413 * SignatureAlgorithm signature;
8414 * } SignatureAndHashAlgorithm;
8415 *
8416 * SignatureAndHashAlgorithm
8417 * supported_signature_algorithms<2..2^16-2>;
8418 *
8419 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8420 * generalization of the TLS 1.2 signature algorithm extension.
8421 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8422 * `SignatureScheme` field of TLS 1.3
8423 *
8424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008425int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8426 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008427{
8428 unsigned char *p = buf;
8429 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8430 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8431
8432 *out_len = 0;
8433
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008435
8436 /* Check if we have space for header and length field:
8437 * - extension_type (2 bytes)
8438 * - extension_data_length (2 bytes)
8439 * - supported_signature_algorithms_length (2 bytes)
8440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008442 p += 6;
8443
8444 /*
8445 * Write supported_signature_algorithms
8446 */
8447 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8449 if (sig_alg == NULL) {
8450 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8451 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008452
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8454 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8455 *sig_alg,
8456 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8457 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008458 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 }
8460 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8461 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008462 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8464 *sig_alg,
8465 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008466 }
8467
8468 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008469 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 if (supported_sig_alg_len == 0) {
8471 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008473 }
8474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8476 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8477 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008478
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008479 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008480
8481#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008483#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008484
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008486}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008487#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008488
XiaokangQian40a35232022-05-07 09:02:40 +00008489#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008490/*
8491 * mbedtls_ssl_parse_server_name_ext
8492 *
8493 * Structure of server_name extension:
8494 *
8495 * enum {
8496 * host_name(0), (255)
8497 * } NameType;
8498 * opaque HostName<1..2^16-1>;
8499 *
8500 * struct {
8501 * NameType name_type;
8502 * select (name_type) {
8503 * case host_name: HostName;
8504 * } name;
8505 * } ServerName;
8506 * struct {
8507 * ServerName server_name_list<1..2^16-1>
8508 * } ServerNameList;
8509 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008511int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8512 const unsigned char *buf,
8513 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008514{
8515 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8516 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008517 size_t server_name_list_len, hostname_len;
8518 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008519
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008521
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8523 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008524 p += 2;
8525
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008527 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 while (p < server_name_list_end) {
8529 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8530 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8531 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8532 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008535 /* sni_name is intended to be used only during the parsing of the
8536 * ClientHello message (it is reset to NULL before the end of
8537 * the message parsing). Thus it is ok to just point to the
8538 * reception buffer and not make a copy of it.
8539 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008540 ssl->handshake->sni_name = p + 3;
8541 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 if (ssl->conf->f_sni == NULL) {
8543 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008544 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8546 ssl, p + 3, hostname_len);
8547 if (ret != 0) {
8548 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8549 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8550 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8551 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8552 }
8553 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008554 }
8555
8556 p += hostname_len + 3;
8557 }
8558
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008560}
8561#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8562
XiaokangQianacb39922022-06-17 10:18:48 +00008563#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008565int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8566 const unsigned char *buf,
8567 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008568{
8569 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008570 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008571 const unsigned char *protocol_name_list;
8572 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008573 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008574
8575 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (ssl->conf->alpn_list == NULL) {
8577 return 0;
8578 }
XiaokangQianacb39922022-06-17 10:18:48 +00008579
8580 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008581 * RFC7301, section 3.1
8582 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008583 *
XiaokangQianc7403452022-06-23 03:24:12 +00008584 * struct {
8585 * ProtocolName protocol_name_list<2..2^16-1>
8586 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008587 */
8588
XiaokangQianc7403452022-06-23 03:24:12 +00008589 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008590 * protocol_name_list_len 2 bytes
8591 * protocol_name_len 1 bytes
8592 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008595
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008597 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008598 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008599 protocol_name_list = p;
8600 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008601
8602 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008604 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8606 protocol_name_len);
8607 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008608 MBEDTLS_SSL_PEND_FATAL_ALERT(
8609 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8611 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008612 }
8613
8614 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008615 }
8616
8617 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8619 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008620 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008622 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 if (protocol_name_len == alpn_len &&
8624 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008625 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008627 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008628
8629 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008630 }
8631 }
8632
XiaokangQian95d5f542022-06-24 02:29:26 +00008633 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008634 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8636 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8637 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008638}
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8641 unsigned char *buf,
8642 unsigned char *end,
8643 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008644{
8645 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008646 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008647 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008648
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 if (ssl->alpn_chosen == NULL) {
8650 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008651 }
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 protocol_name_len = strlen(ssl->alpn_chosen);
8654 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008657 /*
8658 * 0 . 1 ext identifier
8659 * 2 . 3 ext length
8660 * 4 . 5 protocol list length
8661 * 6 . 6 protocol name length
8662 * 7 . 7+n protocol name
8663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008665
XiaokangQian95d5f542022-06-24 02:29:26 +00008666 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008667
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8669 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008670 /* Note: the length of the chosen protocol has been checked to be less
8671 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008673 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008674
Gilles Peskine449bd832023-01-11 14:50:10 +01008675 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008676
8677#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008678 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008679#endif
8680
Gilles Peskine449bd832023-01-11 14:50:10 +01008681 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008682}
8683#endif /* MBEDTLS_SSL_ALPN */
8684
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008685#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008686 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008687 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008688 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008689int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8690 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008691{
8692 /* Initialize to suppress unnecessary compiler warning */
8693 size_t hostname_len = 0;
8694
8695 /* Check if new hostname is valid before
8696 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008697 if (hostname != NULL) {
8698 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008699
Gilles Peskine449bd832023-01-11 14:50:10 +01008700 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8702 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008703 }
8704
8705 /* Now it's clear that we will overwrite the old hostname,
8706 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008707 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008708 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008709 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008710 }
8711
8712 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008713 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008714 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 } else {
8716 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8717 if (session->hostname == NULL) {
8718 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8719 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008720
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008722 }
8723
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008725}
Xiaokang Qian03409292022-10-12 02:49:52 +00008726#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8727 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008728 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008729 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008730
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008731#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8732 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008733int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8734 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008735{
8736 size_t alpn_len = 0;
8737
8738 if (alpn != NULL) {
8739 alpn_len = strlen(alpn);
8740
8741 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8743 }
8744 }
8745
8746 if (session->ticket_alpn != NULL) {
8747 mbedtls_zeroize_and_free(session->ticket_alpn,
8748 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008749 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008750 }
8751
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008752 if (alpn != NULL) {
8753 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008754 if (session->ticket_alpn == NULL) {
8755 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8756 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008757 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008758 }
8759
8760 return 0;
8761}
8762#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008763
8764/*
8765 * The following functions are used by 1.2 and 1.3, client and server.
8766 */
8767#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8768int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8769 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8770 int recv_endpoint,
8771 mbedtls_ssl_protocol_version tls_version,
8772 uint32_t *flags)
8773{
8774 int ret = 0;
8775 unsigned int usage = 0;
8776 const char *ext_oid;
8777 size_t ext_len;
8778
8779 /*
8780 * keyUsage
8781 */
8782
8783 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8784 * to check what a compliant client will think while choosing which cert
8785 * to send to the client. */
8786#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8787 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8788 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8789 /* TLS 1.2 server part of the key exchange */
8790 switch (ciphersuite->key_exchange) {
8791 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008792 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8793 break;
8794
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008795 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8796 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8797 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8798 break;
8799
8800 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8801 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8802 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8803 break;
8804
8805 /* Don't use default: we want warnings when adding new values */
8806 case MBEDTLS_KEY_EXCHANGE_NONE:
8807 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008808 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8809 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8810 usage = 0;
8811 }
8812 } else
8813#endif
8814 {
8815 /* This is either TLS 1.3 authentication, which always uses signatures,
8816 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8817 * options we implement, both using signatures. */
8818 (void) tls_version;
8819 (void) ciphersuite;
8820 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8821 }
8822
8823 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8824 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8825 ret = -1;
8826 }
8827
8828 /*
8829 * extKeyUsage
8830 */
8831
8832 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8833 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8834 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8835 } else {
8836 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8837 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8838 }
8839
8840 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8841 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8842 ret = -1;
8843 }
8844
8845 return ret;
8846}
8847
8848int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8849 int authmode,
8850 mbedtls_x509_crt *chain,
8851 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8852 void *rs_ctx)
8853{
8854 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8855 return 0;
8856 }
8857
8858 /*
8859 * Primary check: use the appropriate X.509 verification function
8860 */
8861 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8862 void *p_vrfy;
8863 if (ssl->f_vrfy != NULL) {
8864 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8865 f_vrfy = ssl->f_vrfy;
8866 p_vrfy = ssl->p_vrfy;
8867 } else {
8868 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8869 f_vrfy = ssl->conf->f_vrfy;
8870 p_vrfy = ssl->conf->p_vrfy;
8871 }
8872
8873 int ret = 0;
8874 int have_ca_chain_or_callback = 0;
8875#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8876 if (ssl->conf->f_ca_cb != NULL) {
8877 ((void) rs_ctx);
8878 have_ca_chain_or_callback = 1;
8879
8880 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8881 ret = mbedtls_x509_crt_verify_with_ca_cb(
8882 chain,
8883 ssl->conf->f_ca_cb,
8884 ssl->conf->p_ca_cb,
8885 ssl->conf->cert_profile,
8886 ssl->hostname,
8887 &ssl->session_negotiate->verify_result,
8888 f_vrfy, p_vrfy);
8889 } else
8890#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8891 {
8892 mbedtls_x509_crt *ca_chain;
8893 mbedtls_x509_crl *ca_crl;
8894#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8895 if (ssl->handshake->sni_ca_chain != NULL) {
8896 ca_chain = ssl->handshake->sni_ca_chain;
8897 ca_crl = ssl->handshake->sni_ca_crl;
8898 } else
8899#endif
8900 {
8901 ca_chain = ssl->conf->ca_chain;
8902 ca_crl = ssl->conf->ca_crl;
8903 }
8904
8905 if (ca_chain != NULL) {
8906 have_ca_chain_or_callback = 1;
8907 }
8908
8909 ret = mbedtls_x509_crt_verify_restartable(
8910 chain,
8911 ca_chain, ca_crl,
8912 ssl->conf->cert_profile,
8913 ssl->hostname,
8914 &ssl->session_negotiate->verify_result,
8915 f_vrfy, p_vrfy, rs_ctx);
8916 }
8917
8918 if (ret != 0) {
8919 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8920 }
8921
8922#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8923 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8924 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8925 }
8926#endif
8927
8928 /*
8929 * Secondary checks: always done, but change 'ret' only if it was 0
8930 */
8931
8932 /* With TLS 1.2 and ECC certs, check that the curve used by the
8933 * certificate is on our list of acceptable curves.
8934 *
8935 * With TLS 1.3 this is not needed because the curve is part of the
8936 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8937 * we validate the signature made with the key associated to this cert.
8938 */
8939#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8940 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8941 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8942 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8943 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8944 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8945 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8946 if (ret == 0) {
8947 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8948 }
8949 }
8950 }
8951#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8952
8953 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8954 if (mbedtls_ssl_check_cert_usage(chain,
8955 ciphersuite_info,
8956 ssl->conf->endpoint,
8957 ssl->tls_version,
8958 &ssl->session_negotiate->verify_result) != 0) {
8959 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8960 if (ret == 0) {
8961 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8962 }
8963 }
8964
8965 /* With authmode optional, we want to keep going if the certificate was
8966 * unacceptable, but still fail on other errors (out of memory etc),
8967 * including fatal errors from the f_vrfy callback.
8968 *
8969 * The only acceptable errors are:
8970 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8971 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8972 * Anything else is a fatal error. */
8973 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8974 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8975 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8976 ret = 0;
8977 }
8978
8979 /* Return a specific error as this is a user error: inconsistent
8980 * configuration - can't verify without trust anchors. */
8981 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8982 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8983 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8984 }
8985
8986 if (ret != 0) {
8987 uint8_t alert;
8988
8989 /* The certificate may have been rejected for several reasons.
8990 Pick one and send the corresponding alert. Which alert to send
8991 may be a subject of debate in some cases. */
8992 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8993 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8994 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8995 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8996 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8997 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8998 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8999 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9000 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9001 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9002 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9003 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9004 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9005 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9006 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9007 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9008 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9009 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9010 } else {
9011 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9012 }
9013 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9014 alert);
9015 }
9016
9017#if defined(MBEDTLS_DEBUG_C)
9018 if (ssl->session_negotiate->verify_result != 0) {
9019 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9020 (unsigned int) ssl->session_negotiate->verify_result));
9021 } else {
9022 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9023 }
9024#endif /* MBEDTLS_DEBUG_C */
9025
9026 return ret;
9027}
9028#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009030#endif /* MBEDTLS_SSL_TLS_C */