blob: ec4272a05f81e805658c1bf146b308f779d76d5a [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é-Gonnardeef142d2015-09-16 10:05:04 +0200914#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200915 handshake->psa_pake_ctx = psa_pake_operation_init();
916 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200917#if defined(MBEDTLS_SSL_CLI_C)
918 handshake->ecjpake_cache = NULL;
919 handshake->ecjpake_cache_len = 0;
920#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200921#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200922
Gilles Peskineeccd8882020-03-10 12:19:08 +0100923#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200925#endif
926
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200927#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
928 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
929#endif
Hanno Becker75173122019-02-06 16:18:31 +0000930
931#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
932 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000934#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200935}
936
Gilles Peskine449bd832023-01-11 14:50:10 +0100937void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200938{
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200940
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100941 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
942 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100943
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000944#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100945 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
946 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100947#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200948}
949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200951{
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953}
954
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200955MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100956static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000957{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
959
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200960 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800961#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 if (ssl->transform_negotiate) {
963 mbedtls_ssl_transform_free(ssl->transform_negotiate);
964 }
Jerry Yu2e199812022-12-01 18:57:19 +0800965#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 if (ssl->session_negotiate) {
967 mbedtls_ssl_session_free(ssl->session_negotiate);
968 }
969 if (ssl->handshake) {
970 mbedtls_ssl_handshake_free(ssl);
971 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200972
Jerry Yu2e199812022-12-01 18:57:19 +0800973#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974 /*
975 * Either the pointers are now NULL or cleared properly and can be freed.
976 * Now allocate missing structures.
977 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 if (ssl->transform_negotiate == NULL) {
979 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200980 }
Jerry Yu2e199812022-12-01 18:57:19 +0800981#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000982
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if (ssl->session_negotiate == NULL) {
984 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Paul Bakker48916f92012-09-16 19:57:18 +0000986
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if (ssl->handshake == NULL) {
988 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200989 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500990#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
991 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400992
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
994 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500995#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000996
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200997 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +0800999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001000 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001001#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 ssl->session_negotiate == NULL) {
1003 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001006 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001007
1008#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001010 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001011#endif
1012
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001014 ssl->session_negotiate = NULL;
1015
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001017 }
1018
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001019#if defined(MBEDTLS_SSL_EARLY_DATA)
1020#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001021 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001022#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001023#if defined(MBEDTLS_SSL_SRV_C)
1024 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1025#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001026 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001027#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001028
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001029 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 mbedtls_ssl_session_init(ssl->session_negotiate);
1031 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001032
Jerry Yu2e199812022-12-01 18:57:19 +08001033#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001035#endif
1036
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001037 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001038 ret = mbedtls_ssl_reset_checksum(ssl);
1039 if (ret != 0) {
1040 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1041 return ret;
1042 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001043
Jerry Yud0766ec2022-09-22 10:46:57 +08001044#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1045 defined(MBEDTLS_SSL_SRV_C) && \
1046 defined(MBEDTLS_SSL_SESSION_TICKETS)
1047 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001049#endif
1050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001053 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001056 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001058 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001062 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001063#endif
1064
Ronald Crone68ab4f2022-10-05 12:46:29 +02001065#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001066#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001067#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001068 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1069 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1071 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001072 const int *md;
1073 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001074 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001075 uint16_t *p;
1076
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001077 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1078 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1079 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1082 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001083 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001085#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001087#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001088
Jerry Yub476a442022-01-21 18:14:45 +08001089#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001091#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1093 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1094 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001095 }
1096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1098 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1099 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1102 sizeof(uint16_t));
1103 if (ssl->handshake->sig_algs == NULL) {
1104 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1105 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 p = (uint16_t *) ssl->handshake->sig_algs;
1108 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1109 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1110 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001111 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001113#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001115 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001116#endif
1117#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001119 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001120#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001121 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001122 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001123 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001125#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001127 ssl->handshake->sig_algs_heap_allocated = 0;
1128 }
Jerry Yucc539102022-06-27 16:27:35 +08001129#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001130#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001132}
1133
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001134#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001135/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001136MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001137static int ssl_cookie_write_dummy(void *ctx,
1138 unsigned char **p, unsigned char *end,
1139 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001140{
1141 ((void) ctx);
1142 ((void) p);
1143 ((void) end);
1144 ((void) cli_id);
1145 ((void) cli_id_len);
1146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001148}
1149
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001150MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001151static int ssl_cookie_check_dummy(void *ctx,
1152 const unsigned char *cookie, size_t cookie_len,
1153 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001154{
1155 ((void) ctx);
1156 ((void) cookie);
1157 ((void) cookie_len);
1158 ((void) cli_id);
1159 ((void) cli_id_len);
1160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001162}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001163#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001164
Paul Bakker5121ce52009-01-03 21:22:43 +00001165/*
1166 * Initialize an SSL context
1167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001168void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001169{
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001171}
1172
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001173MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001174static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001175{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001176 const mbedtls_ssl_config *conf = ssl->conf;
1177
Ronald Cron6f135e12021-12-08 16:57:54 +01001178#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1180 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1181 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1182 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001183 }
1184
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1186 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001187 }
1188#endif
1189
1190#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1192 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1193 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001194 }
1195#endif
1196
Ronald Cron6f135e12021-12-08 16:57:54 +01001197#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1199 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1200 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1201 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001202 }
1203
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1205 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001206 }
1207#endif
1208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1210 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001211}
1212
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001214static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1215{
1216 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 ret = ssl_conf_version_check(ssl);
1218 if (ret != 0) {
1219 return ret;
1220 }
Jerry Yu60835a82021-08-04 10:13:52 +08001221
Yanray Wangb422cab2023-12-01 16:18:10 +08001222 if (ssl->conf->f_rng == NULL) {
1223 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1224 return MBEDTLS_ERR_SSL_NO_RNG;
1225 }
1226
Jerry Yu60835a82021-08-04 10:13:52 +08001227 /* Space for further checks */
1228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001230}
1231
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001232/*
1233 * Setup an SSL context
1234 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1237 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001238{
Janos Follath865b3eb2019-12-16 11:46:15 +00001239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001240 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1241 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001242
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001243 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if ((ret = ssl_conf_check(ssl)) != 0) {
1246 return ret;
1247 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001248 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001249
Paul Bakker62f2dee2012-09-28 07:31:51 +00001250 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001251 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001252 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001253
1254 /* Set to NULL in case of an error condition */
1255 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001256
Darryl Greenb33cc762019-11-28 14:29:44 +00001257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1258 ssl->in_buf_len = in_buf_len;
1259#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1261 if (ssl->in_buf == NULL) {
1262 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001263 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001264 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001265 }
1266
Darryl Greenb33cc762019-11-28 14:29:44 +00001267#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1268 ssl->out_buf_len = out_buf_len;
1269#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1271 if (ssl->out_buf == NULL) {
1272 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001273 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001274 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 }
1276
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001278
Johan Pascalb62bb512015-12-03 21:56:45 +01001279#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001281#endif
1282
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001284 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001286
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001288
1289error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 mbedtls_free(ssl->in_buf);
1291 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001292
1293 ssl->conf = NULL;
1294
Darryl Greenb33cc762019-11-28 14:29:44 +00001295#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1296 ssl->in_buf_len = 0;
1297 ssl->out_buf_len = 0;
1298#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001299 ssl->in_buf = NULL;
1300 ssl->out_buf = NULL;
1301
1302 ssl->in_hdr = NULL;
1303 ssl->in_ctr = NULL;
1304 ssl->in_len = NULL;
1305 ssl->in_iv = NULL;
1306 ssl->in_msg = NULL;
1307
1308 ssl->out_hdr = NULL;
1309 ssl->out_ctr = NULL;
1310 ssl->out_len = NULL;
1311 ssl->out_iv = NULL;
1312 ssl->out_msg = NULL;
1313
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001315}
1316
1317/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001318 * Reset an initialized and used SSL context for re-use while retaining
1319 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001320 *
1321 * If partial is non-zero, keep data in the input buffer and client ID.
1322 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001324void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1325 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326{
Darryl Greenb33cc762019-11-28 14:29:44 +00001327#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1328 size_t in_buf_len = ssl->in_buf_len;
1329 size_t out_buf_len = ssl->out_buf_len;
1330#else
1331 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1332 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1333#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001334
Hanno Beckerb0302c42021-08-03 09:39:42 +01001335#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1336 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001337#endif
1338
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001339 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001343
1344 /* Reset incoming message parsing */
1345 ssl->in_offt = NULL;
1346 ssl->nb_zero = 0;
1347 ssl->in_msgtype = 0;
1348 ssl->in_msglen = 0;
1349 ssl->in_hslen = 0;
1350 ssl->keep_current_message = 0;
1351 ssl->transform_in = NULL;
1352
1353#if defined(MBEDTLS_SSL_PROTO_DTLS)
1354 ssl->next_record_offset = 0;
1355 ssl->in_epoch = 0;
1356#endif
1357
1358 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001360 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001362 }
1363
Ronald Cronad8c17b2022-06-10 17:18:09 +02001364 ssl->send_alert = 0;
1365
Hanno Beckerb0302c42021-08-03 09:39:42 +01001366 /* Reset outgoing message writing */
1367 ssl->out_msgtype = 0;
1368 ssl->out_msglen = 0;
1369 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 memset(ssl->out_buf, 0, out_buf_len);
1371 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001372 ssl->transform_out = NULL;
1373
1374#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001375 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001376#endif
1377
XiaokangQian2b01dc32022-01-21 02:53:13 +00001378#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 if (ssl->transform) {
1380 mbedtls_ssl_transform_free(ssl->transform);
1381 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001382 ssl->transform = NULL;
1383 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001384#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1385
XiaokangQian2b01dc32022-01-21 02:53:13 +00001386#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 mbedtls_ssl_transform_free(ssl->transform_application);
1388 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389 ssl->transform_application = NULL;
1390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001392#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1394 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001395 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001396#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1399 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400 ssl->handshake->transform_handshake = NULL;
1401 }
1402
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001404}
1405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407{
1408 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1409
1410 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001411 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001414
1415 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416#if defined(MBEDTLS_SSL_RENEGOTIATION)
1417 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001418 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001419
1420 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1422 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001423#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001425
Hanno Beckerb0302c42021-08-03 09:39:42 +01001426 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001427 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 if (ssl->session) {
1429 mbedtls_ssl_session_free(ssl->session);
1430 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001431 ssl->session = NULL;
1432 }
1433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001435 ssl->alpn_chosen = NULL;
1436#endif
1437
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001438#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001439 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001440#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001442#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 if (free_cli_id) {
1444 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001445 ssl->cli_id = NULL;
1446 ssl->cli_id_len = 0;
1447 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001448#endif
1449
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 if ((ret = ssl_handshake_init(ssl)) != 0) {
1451 return ret;
1452 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001455}
1456
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001457/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001458 * Reset an initialized and used SSL context for re-use while retaining
1459 * all application-set variables, function pointers and data.
1460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001461int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462{
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001464}
1465
1466/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001467 * SSL set accessors
1468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001470{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001471 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001472}
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001475{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001476 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001477}
1478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001480void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001481{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001482 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001483}
1484#endif
1485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001487{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001488 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001489}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001492
Gilles Peskine449bd832023-01-11 14:50:10 +01001493void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1494 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001495{
1496 ssl->disable_datagram_packing = !allow_packing;
1497}
1498
Gilles Peskine449bd832023-01-11 14:50:10 +01001499void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1500 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001501{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001502 conf->hs_timeout_min = min;
1503 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001504}
1505#endif
1506
Gilles Peskine449bd832023-01-11 14:50:10 +01001507void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001508{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001509 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001510}
1511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001513void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1514 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1515 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001516{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001517 conf->f_vrfy = f_vrfy;
1518 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001519}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001521
Gilles Peskine449bd832023-01-11 14:50:10 +01001522void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1523 int (*f_rng)(void *, unsigned char *, size_t),
1524 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001525{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001526 conf->f_rng = f_rng;
1527 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001528}
1529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1531 void (*f_dbg)(void *, int, const char *, int, const char *),
1532 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001533{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001534 conf->f_dbg = f_dbg;
1535 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001536}
1537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1539 void *p_bio,
1540 mbedtls_ssl_send_t *f_send,
1541 mbedtls_ssl_recv_t *f_recv,
1542 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001543{
1544 ssl->p_bio = p_bio;
1545 ssl->f_send = f_send;
1546 ssl->f_recv = f_recv;
1547 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001548}
1549
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001550#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001551void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001552{
1553 ssl->mtu = mtu;
1554}
1555#endif
1556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001558{
1559 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001560}
1561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1563 void *p_timer,
1564 mbedtls_ssl_set_timer_t *f_set_timer,
1565 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001566{
1567 ssl->p_timer = p_timer;
1568 ssl->f_set_timer = f_set_timer;
1569 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001570
1571 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001573}
1574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001575#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001576void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1577 void *p_cache,
1578 mbedtls_ssl_cache_get_t *f_get_cache,
1579 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001580{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001581 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001582 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001583 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001584}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001588int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001589{
Janos Follath865b3eb2019-12-16 11:46:15 +00001590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001593 session == NULL ||
1594 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001597 }
1598
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (ssl->handshake->resume == 1) {
1600 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1601 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001602
Jerry Yu21092062022-10-10 21:21:31 +08001603#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001605#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001606 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001610 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1612 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1613 session->ciphersuite));
1614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001615 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001616#else
1617 /*
1618 * If session tickets are not enabled, it is not possible to resume a
1619 * TLS 1.3 session, thus do not make any change to the SSL context in
1620 * the first place.
1621 */
1622 return 0;
1623#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001624 }
Jerry Yu21092062022-10-10 21:21:31 +08001625#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1628 session)) != 0) {
1629 return ret;
1630 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001631
Paul Bakker0a597072012-09-25 21:55:46 +00001632 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001635}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001636#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001637
Gilles Peskine449bd832023-01-11 14:50:10 +01001638void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1639 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001640{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001641 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001642}
1643
Ronald Cron6f135e12021-12-08 16:57:54 +01001644#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001645void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1646 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001647{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001648 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001649}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001650
1651#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001652void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1653 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001654{
1655 conf->early_data_enabled = early_data_enabled;
1656}
Jerry Yucc4e0072022-11-22 17:22:22 +08001657
1658#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001659void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001661{
Jerry Yu39da9852022-12-06 16:58:36 +08001662 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001663}
1664#endif /* MBEDTLS_SSL_SRV_C */
1665
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001666#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001667#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001670void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1671 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001672{
1673 conf->cert_profile = profile;
1674}
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001677{
1678 mbedtls_ssl_key_cert *cur = key_cert, *next;
1679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001681 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001683 cur = next;
1684 }
1685}
1686
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001687/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001688MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001689static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1690 mbedtls_x509_crt *cert,
1691 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001692{
niisato8ee24222018-06-25 19:05:48 +09001693 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001696 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001698 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001700 }
1701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1703 if (new_cert == NULL) {
1704 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1705 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001706
niisato8ee24222018-06-25 19:05:48 +09001707 new_cert->cert = cert;
1708 new_cert->key = key;
1709 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001710
Glenn Strauss36872db2022-01-22 05:06:31 -05001711 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001713 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001715 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001717 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 }
niisato8ee24222018-06-25 19:05:48 +09001719 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001720 }
1721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001723}
1724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001726 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001728{
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001730}
1731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001733 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001735{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001736 conf->ca_chain = ca_chain;
1737 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001738
1739#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1740 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1741 * cannot be used together. */
1742 conf->f_ca_cb = NULL;
1743 conf->p_ca_cb = NULL;
1744#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001745}
Hanno Becker5adaad92019-03-27 16:54:37 +00001746
1747#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001748void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1749 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1750 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001751{
1752 conf->f_ca_cb = f_ca_cb;
1753 conf->p_ca_cb = p_ca_cb;
1754
1755 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1756 * cannot be used together. */
1757 conf->ca_chain = NULL;
1758 conf->ca_crl = NULL;
1759}
1760#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001762
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001763#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001764const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1765 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001766{
1767 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001769}
1770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1772 mbedtls_x509_crt *own_cert,
1773 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001774{
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1776 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001777}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001778
Gilles Peskine449bd832023-01-11 14:50:10 +01001779void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1780 mbedtls_x509_crt *ca_chain,
1781 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001782{
1783 ssl->handshake->sni_ca_chain = ca_chain;
1784 ssl->handshake->sni_ca_crl = ca_crl;
1785}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001786
Glenn Strauss999ef702022-03-11 01:37:23 -05001787#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001788void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1789 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001790{
1791 ssl->handshake->dn_hints = crt;
1792}
1793#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1796 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001797{
1798 ssl->handshake->sni_authmode = authmode;
1799}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001800#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1801
Hanno Becker8927c832019-04-03 12:52:50 +01001802#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1804 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1805 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001806{
1807 ssl->f_vrfy = f_vrfy;
1808 ssl->p_vrfy = p_vrfy;
1809}
1810#endif
1811
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001812#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001813
Przemek Stekielfde11282023-03-13 16:06:09 +01001814static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1815static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1816
Valerio Setti016f6822022-12-09 14:17:50 +01001817static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 mbedtls_ssl_context *ssl,
1819 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001820{
1821 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001822 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001823 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001824 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001825 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001826 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1828 psa_pake_cs_set_primitive(&cipher_suite,
1829 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1830 PSA_ECC_FAMILY_SECP_R1,
1831 256));
1832 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1835 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001836 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001838
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001840 user = jpake_server_id;
1841 user_len = sizeof(jpake_server_id);
1842 peer = jpake_client_id;
1843 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001845 user = jpake_client_id;
1846 user_len = sizeof(jpake_client_id);
1847 peer = jpake_server_id;
1848 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001850
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001851 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1852 if (status != PSA_SUCCESS) {
1853 return status;
1854 }
1855
1856 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001858 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 }
Valerio Setti016f6822022-12-09 14:17:50 +01001860
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1862 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001863 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 }
Valerio Setti016f6822022-12-09 14:17:50 +01001865
1866 ssl->handshake->psa_pake_ctx_is_ok = 1;
1867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001869}
1870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1872 const unsigned char *pw,
1873 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001874{
1875 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1876 psa_status_t status;
1877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 if (ssl->handshake == NULL || ssl->conf == NULL) {
1879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001880 }
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 /* Empty password is not valid */
1883 if ((pw == NULL) || (pw_len == 0)) {
1884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1885 }
1886
1887 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1888 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1889 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1890
1891 status = psa_import_key(&attributes, pw, pw_len,
1892 &ssl->handshake->psa_pake_password);
1893 if (status != PSA_SUCCESS) {
1894 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1895 }
1896
1897 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1898 ssl->handshake->psa_pake_password);
1899 if (status != PSA_SUCCESS) {
1900 psa_destroy_key(ssl->handshake->psa_pake_password);
1901 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1902 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1903 }
1904
1905 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001906}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1909 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001910{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001911 psa_status_t status;
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (ssl->handshake == NULL || ssl->conf == NULL) {
1914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001915 }
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (mbedtls_svc_key_id_is_null(pwd)) {
1918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1919 }
1920
1921 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1922 if (status != PSA_SUCCESS) {
1923 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1924 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1925 }
1926
1927 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001928}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001929#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001930
Ronald Cron73fe8df2022-10-05 14:31:43 +02001931#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001932int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001933{
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 if (conf->psk_identity == NULL ||
1935 conf->psk_identity_len == 0) {
1936 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001937 }
1938
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1940 return 1;
1941 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (conf->psk != NULL && conf->psk_len != 0) {
1944 return 1;
1945 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001946
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001948}
1949
Gilles Peskine449bd832023-01-11 14:50:10 +01001950static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001951{
1952 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001954 /* The maintenance of the PSK key slot is the
1955 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001956 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001957 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001959 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001960 conf->psk = NULL;
1961 conf->psk_len = 0;
1962 }
1963
1964 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (conf->psk_identity != NULL) {
1966 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001967 conf->psk_identity = NULL;
1968 conf->psk_identity_len = 0;
1969 }
1970}
1971
Hanno Becker7390c712018-11-15 13:33:04 +00001972/* This function assumes that PSK identity in the SSL config is unset.
1973 * It checks that the provided identity is well-formed and attempts
1974 * to make a copy of it in the SSL config.
1975 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001976MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001977static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1978 unsigned char const *psk_identity,
1979 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001980{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001981 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001983 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 (psk_identity_len >> 16) != 0 ||
1985 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1986 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001987 }
1988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1990 if (conf->psk_identity == NULL) {
1991 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1992 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001993
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001994 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001996
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001998}
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2001 const unsigned char *psk, size_t psk_len,
2002 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002003{
Janos Follath865b3eb2019-12-16 11:46:15 +00002004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002005
2006 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2008 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2009 }
Hanno Becker7390c712018-11-15 13:33:04 +00002010
2011 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 if (psk == NULL) {
2013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2014 }
2015 if (psk_len == 0) {
2016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2017 }
2018 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002021
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2023 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2024 }
Hanno Becker7390c712018-11-15 13:33:04 +00002025 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002027
2028 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2030 if (ret != 0) {
2031 ssl_conf_remove_psk(conf);
2032 }
Hanno Becker7390c712018-11-15 13:33:04 +00002033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002035}
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002038{
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002040 /* The maintenance of the external PSK key slot is the
2041 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (ssl->handshake->psk_opaque_is_internal) {
2043 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 ssl->handshake->psk_opaque_is_internal = 0;
2045 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002046 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002047 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002048}
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2051 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002052{
Neil Armstrong501c9322022-05-03 09:35:09 +02002053 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002054 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002055 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002056 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (psk == NULL || ssl->handshake == NULL) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
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 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002067
Jerry Yuccc68a42022-07-26 16:39:20 +08002068#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2070 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2071 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2072 } else {
2073 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2074 }
2075 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002076 }
2077#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002078
Jerry Yu568ec252022-07-22 21:27:34 +08002079#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2081 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2082 psa_set_key_usage_flags(&key_attributes,
2083 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002084 }
2085#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 psa_set_key_algorithm(&key_attributes, alg);
2088 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2091 if (status != PSA_SUCCESS) {
2092 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2093 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002094
2095 /* Allow calling psa_destroy_key() on psk remove */
2096 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002098}
2099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2101 mbedtls_svc_key_id_t psk,
2102 const unsigned char *psk_identity,
2103 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002104{
Janos Follath865b3eb2019-12-16 11:46:15 +00002105 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002106
2107 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2109 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2110 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111
Hanno Becker7390c712018-11-15 13:33:04 +00002112 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (mbedtls_svc_key_id_is_null(psk)) {
2114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2115 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002116 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002117
2118 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2120 psk_identity_len);
2121 if (ret != 0) {
2122 ssl_conf_remove_psk(conf);
2123 }
Hanno Becker7390c712018-11-15 13:33:04 +00002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002126}
2127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2129 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002130{
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 if ((mbedtls_svc_key_id_is_null(psk)) ||
2132 (ssl->handshake == NULL)) {
2133 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2134 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002137 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002139}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002140
Jerry Yu8897c072022-08-12 13:56:53 +08002141#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002142void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2143 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2144 size_t),
2145 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002146{
2147 conf->f_psk = f_psk;
2148 conf->p_psk = p_psk;
2149}
Jerry Yu8897c072022-08-12 13:56:53 +08002150#endif /* MBEDTLS_SSL_SRV_C */
2151
Ronald Cron73fe8df2022-10-05 14:31:43 +02002152#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002153
Gilles Peskine301711e2022-04-26 16:57:05 +02002154static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002156{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002157#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (alg == PSA_ALG_CBC_NO_PADDING) {
2159 return MBEDTLS_SSL_MODE_CBC;
2160 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002161#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if (PSA_ALG_IS_AEAD(alg)) {
2163 return MBEDTLS_SSL_MODE_AEAD;
2164 }
2165 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002166}
2167
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002168
Gilles Peskinee108d982022-04-26 16:50:40 +02002169static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2170 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002172{
2173#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2175 base_mode == MBEDTLS_SSL_MODE_CBC) {
2176 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002177 }
2178#else
2179 (void) encrypt_then_mac;
2180#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002182}
2183
Neil Armstrongab555e02022-04-04 11:07:59 +02002184mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002186{
Gilles Peskinee108d982022-04-26 16:50:40 +02002187 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002189 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002190
Gilles Peskinee108d982022-04-26 16:50:40 +02002191 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002192#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002193 encrypt_then_mac = transform->encrypt_then_mac;
2194#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002196}
2197
Neil Armstrongab555e02022-04-04 11:07:59 +02002198mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002199#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002201#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002203{
Gilles Peskinee108d982022-04-26 16:50:40 +02002204 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2205
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002206 psa_status_t status;
2207 psa_algorithm_t alg;
2208 psa_key_type_t type;
2209 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002210 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2211 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 if (status == PSA_SUCCESS) {
2213 base_mode = mbedtls_ssl_get_base_mode(alg);
2214 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002215
Gilles Peskinee108d982022-04-26 16:50:40 +02002216#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2217 int encrypt_then_mac = 0;
2218#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002220}
2221
Jerry Yu251a12e2022-07-13 15:15:48 +08002222
Ronald Cron8b592d22024-11-12 18:08:25 +01002223const mbedtls_error_pair_t psa_to_ssl_errors[] =
2224{
2225 { PSA_SUCCESS, 0 },
2226 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2227 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2228 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2229 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2230 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2231 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2232};
2233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2235 size_t taglen,
2236 psa_algorithm_t *alg,
2237 psa_key_type_t *key_type,
2238 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002239{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002240#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002241 (void) taglen;
2242#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002244#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002245 case MBEDTLS_CIPHER_AES_128_CBC:
2246 *alg = PSA_ALG_CBC_NO_PADDING;
2247 *key_type = PSA_KEY_TYPE_AES;
2248 *key_size = 128;
2249 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002250#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002251#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002252 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002254 *key_type = PSA_KEY_TYPE_AES;
2255 *key_size = 128;
2256 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002257#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002258#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 case MBEDTLS_CIPHER_AES_128_GCM:
2260 *alg = PSA_ALG_GCM;
2261 *key_type = PSA_KEY_TYPE_AES;
2262 *key_size = 128;
2263 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002264#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002265#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002266 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002268 *key_type = PSA_KEY_TYPE_AES;
2269 *key_size = 192;
2270 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002271#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002272#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002273 case MBEDTLS_CIPHER_AES_192_GCM:
2274 *alg = PSA_ALG_GCM;
2275 *key_type = PSA_KEY_TYPE_AES;
2276 *key_size = 192;
2277 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002278#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002279#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 case MBEDTLS_CIPHER_AES_256_CBC:
2281 *alg = PSA_ALG_CBC_NO_PADDING;
2282 *key_type = PSA_KEY_TYPE_AES;
2283 *key_size = 256;
2284 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002285#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002286#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002287 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002289 *key_type = PSA_KEY_TYPE_AES;
2290 *key_size = 256;
2291 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002292#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002293#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002294 case MBEDTLS_CIPHER_AES_256_GCM:
2295 *alg = PSA_ALG_GCM;
2296 *key_type = PSA_KEY_TYPE_AES;
2297 *key_size = 256;
2298 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002299#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002300#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 case MBEDTLS_CIPHER_ARIA_128_CBC:
2302 *alg = PSA_ALG_CBC_NO_PADDING;
2303 *key_type = PSA_KEY_TYPE_ARIA;
2304 *key_size = 128;
2305 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002306#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002307#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002308 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002310 *key_type = PSA_KEY_TYPE_ARIA;
2311 *key_size = 128;
2312 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002313#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002314#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 case MBEDTLS_CIPHER_ARIA_128_GCM:
2316 *alg = PSA_ALG_GCM;
2317 *key_type = PSA_KEY_TYPE_ARIA;
2318 *key_size = 128;
2319 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002320#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002321#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002322 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002324 *key_type = PSA_KEY_TYPE_ARIA;
2325 *key_size = 192;
2326 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002327#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002328#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002329 case MBEDTLS_CIPHER_ARIA_192_GCM:
2330 *alg = PSA_ALG_GCM;
2331 *key_type = PSA_KEY_TYPE_ARIA;
2332 *key_size = 192;
2333 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002334#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002335#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 case MBEDTLS_CIPHER_ARIA_256_CBC:
2337 *alg = PSA_ALG_CBC_NO_PADDING;
2338 *key_type = PSA_KEY_TYPE_ARIA;
2339 *key_size = 256;
2340 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002341#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002342#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002343 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002345 *key_type = PSA_KEY_TYPE_ARIA;
2346 *key_size = 256;
2347 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002348#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002349#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002350 case MBEDTLS_CIPHER_ARIA_256_GCM:
2351 *alg = PSA_ALG_GCM;
2352 *key_type = PSA_KEY_TYPE_ARIA;
2353 *key_size = 256;
2354 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002355#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002356#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002357 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2358 *alg = PSA_ALG_CBC_NO_PADDING;
2359 *key_type = PSA_KEY_TYPE_CAMELLIA;
2360 *key_size = 128;
2361 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002362#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002363#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002364 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002366 *key_type = PSA_KEY_TYPE_CAMELLIA;
2367 *key_size = 128;
2368 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002369#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002370#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002371 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2372 *alg = PSA_ALG_GCM;
2373 *key_type = PSA_KEY_TYPE_CAMELLIA;
2374 *key_size = 128;
2375 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002376#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002377#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002378 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002380 *key_type = PSA_KEY_TYPE_CAMELLIA;
2381 *key_size = 192;
2382 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002383#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002384#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002385 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2386 *alg = PSA_ALG_GCM;
2387 *key_type = PSA_KEY_TYPE_CAMELLIA;
2388 *key_size = 192;
2389 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002390#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002391#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002392 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2393 *alg = PSA_ALG_CBC_NO_PADDING;
2394 *key_type = PSA_KEY_TYPE_CAMELLIA;
2395 *key_size = 256;
2396 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002397#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002398#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002399 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002401 *key_type = PSA_KEY_TYPE_CAMELLIA;
2402 *key_size = 256;
2403 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002404#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002405#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002406 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2407 *alg = PSA_ALG_GCM;
2408 *key_type = PSA_KEY_TYPE_CAMELLIA;
2409 *key_size = 256;
2410 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002411#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002412#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002413 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2414 *alg = PSA_ALG_CHACHA20_POLY1305;
2415 *key_type = PSA_KEY_TYPE_CHACHA20;
2416 *key_size = 256;
2417 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002418#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002419 case MBEDTLS_CIPHER_NULL:
2420 *alg = MBEDTLS_SSL_NULL_CIPHER;
2421 *key_type = 0;
2422 *key_size = 0;
2423 break;
2424 default:
2425 return PSA_ERROR_NOT_SUPPORTED;
2426 }
2427
2428 return PSA_SUCCESS;
2429}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002430
Ronald Crone68ab4f2022-10-05 12:46:29 +02002431#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002432#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002433/*
2434 * Set allowed/preferred hashes for handshake signatures
2435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2437 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002438{
2439 conf->sig_hashes = hashes;
2440}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002441#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002442
Jerry Yuf017ee42022-01-12 15:49:48 +08002443/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2445 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002446{
Jerry Yuf017ee42022-01-12 15:49:48 +08002447#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2448 conf->sig_hashes = NULL;
2449#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2450 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002451}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002452#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002453
Brett Warrene0edc842021-08-17 09:53:13 +01002454/*
2455 * Set the allowed groups
2456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002457void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2458 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002459{
Brett Warrene0edc842021-08-17 09:53:13 +01002460 conf->group_list = group_list;
2461}
2462
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002463#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002464int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002465{
Hanno Becker947194e2017-04-07 13:25:49 +01002466 /* Initialize to suppress unnecessary compiler warning */
2467 size_t hostname_len = 0;
2468
2469 /* Check if new hostname is valid before
2470 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 if (hostname != NULL) {
2472 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2476 }
Hanno Becker947194e2017-04-07 13:25:49 +01002477 }
2478
2479 /* Now it's clear that we will overwrite the old hostname,
2480 * so we can free it safely */
2481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002483 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002484 }
2485
2486 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002487
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002489 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 } else {
2491 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2492 if (ssl->hostname == NULL) {
2493 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2494 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002497
Hanno Becker947194e2017-04-07 13:25:49 +01002498 ssl->hostname[hostname_len] = '\0';
2499 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002502}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002503#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002504
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002505#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002506void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2507 int (*f_sni)(void *, mbedtls_ssl_context *,
2508 const unsigned char *, size_t),
2509 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002510{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002511 conf->f_sni = f_sni;
2512 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002513}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002517int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002518{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002519 size_t cur_len, tot_len;
2520 const char **p;
2521
2522 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002523 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2524 * MUST NOT be truncated."
2525 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002526 */
2527 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 for (p = protos; *p != NULL; p++) {
2529 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002530 tot_len += cur_len;
2531
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if ((cur_len == 0) ||
2533 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2534 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2535 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2536 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002537 }
2538
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002539 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002542}
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002545{
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002547}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002549
Johan Pascalb62bb512015-12-03 21:56:45 +01002550#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002551void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2552 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002553{
2554 conf->dtls_srtp_mki_support = support_mki_value;
2555}
2556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2558 unsigned char *mki_value,
2559 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002560{
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2562 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002563 }
Ron Eldor591f1622018-01-22 12:30:04 +02002564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2566 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002567 }
Ron Eldor591f1622018-01-22 12:30:04 +02002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002570 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002572}
2573
Gilles Peskine449bd832023-01-11 14:50:10 +01002574int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2575 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002576{
Johan Pascal253d0262020-09-22 13:04:45 +02002577 const mbedtls_ssl_srtp_profile *p;
2578 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002579
Johan Pascal253d0262020-09-22 13:04:45 +02002580 /* check the profiles list: all entry must be valid,
2581 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2583 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2584 p++) {
2585 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002586 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002588 /* unsupported value, stop parsing and set the size to an error value */
2589 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002590 }
2591 }
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2594 conf->dtls_srtp_profile_list = NULL;
2595 conf->dtls_srtp_profile_list_len = 0;
2596 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002597 }
2598
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002599 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002600 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002603}
2604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2606 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002607{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002608 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2609 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002611 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002613 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2615 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002616 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002617}
Johan Pascalb62bb512015-12-03 21:56:45 +01002618#endif /* MBEDTLS_SSL_DTLS_SRTP */
2619
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302620#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002621void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002622{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002623 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002624}
2625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002627{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002628 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002629}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302630#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002631
Janos Follath088ce432017-04-10 12:42:31 +01002632#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2634 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002635{
2636 conf->cert_req_ca_list = cert_req_ca_list;
2637}
2638#endif
2639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002641void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002642{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002643 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002644}
2645#endif
2646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002648void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002650 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002651}
2652#endif
2653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002656{
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2658 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002660 }
2661
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002662 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002665}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002669{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002670 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002671}
2672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002674void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002675{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002676 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002677}
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002680{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002681 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002682}
2683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2685 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002686{
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002688}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002692#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002693void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002694{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002695 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002696}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002697#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002698
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002699#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002700
Jerry Yud0766ec2022-09-22 10:46:57 +08002701#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002702void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2703 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002704{
Jerry Yud0766ec2022-09-22 10:46:57 +08002705 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002706}
2707#endif
2708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2710 mbedtls_ssl_ticket_write_t *f_ticket_write,
2711 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2712 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002713{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002714 conf->f_ticket_write = f_ticket_write;
2715 conf->f_ticket_parse = f_ticket_parse;
2716 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002717}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002718#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2722 mbedtls_ssl_export_keys_t *f_export_keys,
2723 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002724{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002725 ssl->f_export_keys = f_export_keys;
2726 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002727}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002728
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002729#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002730void mbedtls_ssl_conf_async_private_cb(
2731 mbedtls_ssl_config *conf,
2732 mbedtls_ssl_async_sign_t *f_async_sign,
2733 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2734 mbedtls_ssl_async_resume_t *f_async_resume,
2735 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002737{
2738 conf->f_async_sign_start = f_async_sign;
2739 conf->f_async_decrypt_start = f_async_decrypt;
2740 conf->f_async_resume = f_async_resume;
2741 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002742 conf->p_async_config_data = async_config_data;
2743}
2744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002746{
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002748}
2749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002751{
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 if (ssl->handshake == NULL) {
2753 return NULL;
2754 } else {
2755 return ssl->handshake->user_async_ctx;
2756 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002757}
2758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2760 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002761{
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002763 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002765}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002766#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002767
Paul Bakker5121ce52009-01-03 21:22:43 +00002768/*
2769 * SSL get accessors
2770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002772{
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 if (ssl->session != NULL) {
2774 return ssl->session->verify_result;
2775 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 if (ssl->session_negotiate != NULL) {
2778 return ssl->session_negotiate->verify_result;
2779 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002780
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002782}
2783
Gilles Peskine449bd832023-01-11 14:50:10 +01002784int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002785{
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 if (ssl == NULL || ssl->session == NULL) {
2787 return 0;
2788 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002791}
2792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002794{
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (ssl == NULL || ssl->session == NULL) {
2796 return NULL;
2797 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002800}
2801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002803{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2806 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002807 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002809 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002811 }
2812 }
2813#endif
2814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002816 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002818 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002820 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002822 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002823}
2824
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002825#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2826
2827size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2828{
2829 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2830 size_t record_size_limit = max_len;
2831
2832 if (ssl->session != NULL &&
2833 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2834 ssl->session->record_size_limit < max_len) {
2835 record_size_limit = ssl->session->record_size_limit;
2836 }
2837
2838 // TODO: this is currently untested
2839 /* During a handshake, use the value being negotiated */
2840 if (ssl->session_negotiate != NULL &&
2841 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2842 ssl->session_negotiate->record_size_limit < max_len) {
2843 record_size_limit = ssl->session_negotiate->record_size_limit;
2844 }
2845
2846 return record_size_limit;
2847}
2848#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2849
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002850#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002851size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002852{
David Horstmann95d516f2021-05-04 18:36:56 +01002853 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002854 size_t read_mfl;
2855
Jerry Yuddda0502022-12-01 19:43:12 +08002856#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002857 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2859 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2860 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002861 }
Jerry Yuddda0502022-12-01 19:43:12 +08002862#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002863
2864 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (ssl->session_out != NULL) {
2866 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2867 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002868 max_len = read_mfl;
2869 }
2870 }
2871
Jerry Yuddda0502022-12-01 19:43:12 +08002872 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if (ssl->session_negotiate != NULL) {
2874 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2875 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002876 max_len = read_mfl;
2877 }
2878 }
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002881}
2882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002884{
2885 size_t max_len;
2886
2887 /*
2888 * Assume mfl_code is correct since it was checked when set
2889 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002891
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002892 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 if (ssl->session_out != NULL &&
2894 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2895 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002896 }
2897
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002898 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 if (ssl->session_negotiate != NULL &&
2900 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2901 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002902 }
2903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002905}
2906#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2907
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002908#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002909size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002910{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002911 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2913 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2914 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2915 return 0;
2916 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2919 return ssl->mtu;
2920 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 if (ssl->mtu == 0) {
2923 return ssl->handshake->mtu;
2924 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 return ssl->mtu < ssl->handshake->mtu ?
2927 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002928}
2929#endif /* MBEDTLS_SSL_PROTO_DTLS */
2930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002932{
2933 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2934
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002935#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002936 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002937 !defined(MBEDTLS_SSL_PROTO_DTLS)
2938 (void) ssl;
2939#endif
2940
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002941#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002945 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002947#endif
2948
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002949#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2950 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2951
2952 if (max_len > record_size_limit) {
2953 max_len = record_size_limit;
2954 }
2955#endif
2956
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002957 if (ssl->transform_out != NULL &&
2958 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002959 /*
2960 * In TLS 1.3 case, when records are protected, `max_len` as computed
2961 * above is the maximum length of the TLSInnerPlaintext structure that
2962 * along the plaintext payload contains the inner content type (one byte)
2963 * and some zero padding. Given the algorithm used for padding
2964 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2965 * the plaintext payload. Round down to a multiple of
2966 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2967 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002968 */
2969 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2970 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2971 }
2972
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002973#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2975 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2976 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002977 const size_t overhead = (size_t) ret;
2978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (ret < 0) {
2980 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002981 }
2982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (mtu <= overhead) {
2984 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2985 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2986 }
2987
2988 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002989 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002991 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002992#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002993
Hanno Becker0defedb2018-08-10 12:35:02 +01002994#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002995 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2996 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002997 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002998#endif
2999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003004{
3005 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3006
3007#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3008 (void) ssl;
3009#endif
3010
3011#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003015 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003017#endif
3018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003020}
3021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003023const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003024{
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 if (ssl == NULL || ssl->session == NULL) {
3026 return NULL;
3027 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003028
Hanno Beckere6824572019-02-07 13:18:46 +00003029#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003031#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003033#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003034}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003038int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3039 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003040{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003041 int ret;
3042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003044 dst == NULL ||
3045 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3047 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003048 }
3049
Hanno Beckere810bbc2021-05-14 16:01:05 +01003050 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3051 * idempotent: Each session can only be exported once.
3052 *
3053 * (This is in preparation for TLS 1.3 support where we will
3054 * need the ability to export multiple sessions (aka tickets),
3055 * which will be achieved by calling mbedtls_ssl_get_session()
3056 * multiple times until it fails.)
3057 *
3058 * Check whether we have already exported the current session,
3059 * and fail if so.
3060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (ssl->session->exported == 1) {
3062 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3063 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3066 if (ret != 0) {
3067 return ret;
3068 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003069
3070 /* Remember that we've exported the session. */
3071 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003073}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003075
David Horstmanncb01b362024-02-29 17:31:46 +00003076#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3077
3078/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003079 *
David Horstmanncb01b362024-02-29 17:31:46 +00003080 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003081 */
3082static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3083 unsigned char *buf,
3084 size_t buf_len)
3085{
3086 unsigned char *p = buf;
3087 size_t used = 0;
3088
3089#if defined(MBEDTLS_HAVE_TIME)
3090 uint64_t start;
3091#endif
3092#if defined(MBEDTLS_X509_CRT_PARSE_C)
3093#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3094 size_t cert_len;
3095#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3096#endif /* MBEDTLS_X509_CRT_PARSE_C */
3097
3098 /*
3099 * Time
3100 */
3101#if defined(MBEDTLS_HAVE_TIME)
3102 used += 8;
3103
3104 if (used <= buf_len) {
3105 start = (uint64_t) session->start;
3106
3107 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3108 p += 8;
3109 }
3110#endif /* MBEDTLS_HAVE_TIME */
3111
3112 /*
3113 * Basic mandatory fields
3114 */
3115 used += 1 /* id_len */
3116 + sizeof(session->id)
3117 + sizeof(session->master)
3118 + 4; /* verify_result */
3119
3120 if (used <= buf_len) {
3121 *p++ = MBEDTLS_BYTE_0(session->id_len);
3122 memcpy(p, session->id, 32);
3123 p += 32;
3124
3125 memcpy(p, session->master, 48);
3126 p += 48;
3127
3128 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3129 p += 4;
3130 }
3131
3132 /*
3133 * Peer's end-entity certificate
3134 */
3135#if defined(MBEDTLS_X509_CRT_PARSE_C)
3136#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3137 if (session->peer_cert == NULL) {
3138 cert_len = 0;
3139 } else {
3140 cert_len = session->peer_cert->raw.len;
3141 }
3142
3143 used += 3 + cert_len;
3144
3145 if (used <= buf_len) {
3146 *p++ = MBEDTLS_BYTE_2(cert_len);
3147 *p++ = MBEDTLS_BYTE_1(cert_len);
3148 *p++ = MBEDTLS_BYTE_0(cert_len);
3149
3150 if (session->peer_cert != NULL) {
3151 memcpy(p, session->peer_cert->raw.p, cert_len);
3152 p += cert_len;
3153 }
3154 }
3155#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3156 if (session->peer_cert_digest != NULL) {
3157 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3158 if (used <= buf_len) {
3159 *p++ = (unsigned char) session->peer_cert_digest_type;
3160 *p++ = (unsigned char) session->peer_cert_digest_len;
3161 memcpy(p, session->peer_cert_digest,
3162 session->peer_cert_digest_len);
3163 p += session->peer_cert_digest_len;
3164 }
3165 } else {
3166 used += 2;
3167 if (used <= buf_len) {
3168 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3169 *p++ = 0;
3170 }
3171 }
3172#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3173#endif /* MBEDTLS_X509_CRT_PARSE_C */
3174
3175 /*
3176 * Session ticket if any, plus associated data
3177 */
3178#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3179#if defined(MBEDTLS_SSL_CLI_C)
3180 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3181 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3182
3183 if (used <= buf_len) {
3184 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3185 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3186 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3187
3188 if (session->ticket != NULL) {
3189 memcpy(p, session->ticket, session->ticket_len);
3190 p += session->ticket_len;
3191 }
3192
3193 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3194 p += 4;
3195 }
3196 }
3197#endif /* MBEDTLS_SSL_CLI_C */
3198#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3199 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3200 used += 8;
3201
3202 if (used <= buf_len) {
3203 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3204 p += 8;
3205 }
3206 }
3207#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3208#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3209
3210 /*
3211 * Misc extension-related info
3212 */
3213#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3214 used += 1;
3215
3216 if (used <= buf_len) {
3217 *p++ = session->mfl_code;
3218 }
3219#endif
3220
3221#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3222 used += 1;
3223
3224 if (used <= buf_len) {
3225 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3226 }
3227#endif
3228
3229 return used;
3230}
3231
3232MBEDTLS_CHECK_RETURN_CRITICAL
3233static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3234 const unsigned char *buf,
3235 size_t len)
3236{
3237#if defined(MBEDTLS_HAVE_TIME)
3238 uint64_t start;
3239#endif
3240#if defined(MBEDTLS_X509_CRT_PARSE_C)
3241#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3242 size_t cert_len;
3243#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3244#endif /* MBEDTLS_X509_CRT_PARSE_C */
3245
3246 const unsigned char *p = buf;
3247 const unsigned char * const end = buf + len;
3248
3249 /*
3250 * Time
3251 */
3252#if defined(MBEDTLS_HAVE_TIME)
3253 if (8 > (size_t) (end - p)) {
3254 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3255 }
3256
3257 start = MBEDTLS_GET_UINT64_BE(p, 0);
3258 p += 8;
3259
3260 session->start = (time_t) start;
3261#endif /* MBEDTLS_HAVE_TIME */
3262
3263 /*
3264 * Basic mandatory fields
3265 */
3266 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3267 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3268 }
3269
3270 session->id_len = *p++;
3271 memcpy(session->id, p, 32);
3272 p += 32;
3273
3274 memcpy(session->master, p, 48);
3275 p += 48;
3276
3277 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3278 p += 4;
3279
3280 /* Immediately clear invalid pointer values that have been read, in case
3281 * we exit early before we replaced them with valid ones. */
3282#if defined(MBEDTLS_X509_CRT_PARSE_C)
3283#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3284 session->peer_cert = NULL;
3285#else
3286 session->peer_cert_digest = NULL;
3287#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3288#endif /* MBEDTLS_X509_CRT_PARSE_C */
3289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3290 session->ticket = NULL;
3291#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3292
3293 /*
3294 * Peer certificate
3295 */
3296#if defined(MBEDTLS_X509_CRT_PARSE_C)
3297#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3298 /* Deserialize CRT from the end of the ticket. */
3299 if (3 > (size_t) (end - p)) {
3300 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3301 }
3302
3303 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3304 p += 3;
3305
3306 if (cert_len != 0) {
3307 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3308
3309 if (cert_len > (size_t) (end - p)) {
3310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3311 }
3312
3313 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3314
3315 if (session->peer_cert == NULL) {
3316 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3317 }
3318
3319 mbedtls_x509_crt_init(session->peer_cert);
3320
3321 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3322 p, cert_len)) != 0) {
3323 mbedtls_x509_crt_free(session->peer_cert);
3324 mbedtls_free(session->peer_cert);
3325 session->peer_cert = NULL;
3326 return ret;
3327 }
3328
3329 p += cert_len;
3330 }
3331#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3332 /* Deserialize CRT digest from the end of the ticket. */
3333 if (2 > (size_t) (end - p)) {
3334 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3335 }
3336
3337 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3338 session->peer_cert_digest_len = (size_t) *p++;
3339
3340 if (session->peer_cert_digest_len != 0) {
3341 const mbedtls_md_info_t *md_info =
3342 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3343 if (md_info == NULL) {
3344 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3345 }
3346 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3348 }
3349
3350 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3351 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3352 }
3353
3354 session->peer_cert_digest =
3355 mbedtls_calloc(1, session->peer_cert_digest_len);
3356 if (session->peer_cert_digest == NULL) {
3357 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3358 }
3359
3360 memcpy(session->peer_cert_digest, p,
3361 session->peer_cert_digest_len);
3362 p += session->peer_cert_digest_len;
3363 }
3364#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3365#endif /* MBEDTLS_X509_CRT_PARSE_C */
3366
3367 /*
3368 * Session ticket and associated data
3369 */
3370#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3371#if defined(MBEDTLS_SSL_CLI_C)
3372 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3373 if (3 > (size_t) (end - p)) {
3374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3375 }
3376
3377 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3378 p += 3;
3379
3380 if (session->ticket_len != 0) {
3381 if (session->ticket_len > (size_t) (end - p)) {
3382 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3383 }
3384
3385 session->ticket = mbedtls_calloc(1, session->ticket_len);
3386 if (session->ticket == NULL) {
3387 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3388 }
3389
3390 memcpy(session->ticket, p, session->ticket_len);
3391 p += session->ticket_len;
3392 }
3393
3394 if (4 > (size_t) (end - p)) {
3395 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3396 }
3397
3398 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3399 p += 4;
3400 }
3401#endif /* MBEDTLS_SSL_CLI_C */
3402#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3403 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3404 if (8 > (size_t) (end - p)) {
3405 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3406 }
3407 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3408 p += 8;
3409 }
3410#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3411#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3412
3413 /*
3414 * Misc extension-related info
3415 */
3416#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3417 if (1 > (size_t) (end - p)) {
3418 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3419 }
3420
3421 session->mfl_code = *p++;
3422#endif
3423
3424#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3425 if (1 > (size_t) (end - p)) {
3426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3427 }
3428
3429 session->encrypt_then_mac = *p++;
3430#endif
3431
3432 /* Done, should have consumed entire buffer */
3433 if (p != end) {
3434 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3435 }
3436
3437 return 0;
3438}
3439
3440#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3441
3442#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3443/* Serialization of TLS 1.3 sessions:
3444 *
David Horstmanncb01b362024-02-29 17:31:46 +00003445 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003446 */
3447#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3448MBEDTLS_CHECK_RETURN_CRITICAL
3449static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3450 unsigned char *buf,
3451 size_t buf_len,
3452 size_t *olen)
3453{
3454 unsigned char *p = buf;
3455#if defined(MBEDTLS_SSL_CLI_C) && \
3456 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3457 size_t hostname_len = (session->hostname == NULL) ?
3458 0 : strlen(session->hostname) + 1;
3459#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003460
3461#if defined(MBEDTLS_SSL_SRV_C) && \
3462 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003463 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003464 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003465#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003466 size_t needed = 4 /* ticket_age_add */
3467 + 1 /* ticket_flags */
3468 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003469
David Horstmanne59f9702024-02-29 16:08:57 +00003470 *olen = 0;
3471
3472 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3473 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3474 }
3475 needed += session->resumption_key_len; /* resumption_key */
3476
3477#if defined(MBEDTLS_SSL_EARLY_DATA)
3478 needed += 4; /* max_early_data_size */
3479#endif
3480#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3481 needed += 2; /* record_size_limit */
3482#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3483
3484#if defined(MBEDTLS_HAVE_TIME)
3485 needed += 8; /* ticket_creation_time or ticket_reception_time */
3486#endif
3487
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003488#if defined(MBEDTLS_SSL_SRV_C)
3489 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3490#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003491 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003492 + alpn_len; /* alpn */
3493#endif
3494 }
3495#endif /* MBEDTLS_SSL_SRV_C */
3496
David Horstmanne59f9702024-02-29 16:08:57 +00003497#if defined(MBEDTLS_SSL_CLI_C)
3498 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3499#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3500 needed += 2 /* hostname_len */
3501 + hostname_len; /* hostname */
3502#endif
3503
3504 needed += 4 /* ticket_lifetime */
3505 + 2; /* ticket_len */
3506
3507 /* Check size_t overflow */
3508 if (session->ticket_len > SIZE_MAX - needed) {
3509 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3510 }
3511
3512 needed += session->ticket_len; /* ticket */
3513 }
3514#endif /* MBEDTLS_SSL_CLI_C */
3515
3516 *olen = needed;
3517 if (needed > buf_len) {
3518 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3519 }
3520
3521 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3522 p[4] = session->ticket_flags;
3523
3524 /* save resumption_key */
3525 p[5] = session->resumption_key_len;
3526 p += 6;
3527 memcpy(p, session->resumption_key, session->resumption_key_len);
3528 p += session->resumption_key_len;
3529
3530#if defined(MBEDTLS_SSL_EARLY_DATA)
3531 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3532 p += 4;
3533#endif
3534#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3535 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3536 p += 2;
3537#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3538
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003539#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003540 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003541#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003542 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3543 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003544#endif /* MBEDTLS_HAVE_TIME */
3545
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003546#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003547 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3548 p += 2;
3549
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003550 if (alpn_len > 0) {
3551 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003552 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003553 p += alpn_len;
3554 }
3555#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3556 }
3557#endif /* MBEDTLS_SSL_SRV_C */
3558
David Horstmanne59f9702024-02-29 16:08:57 +00003559#if defined(MBEDTLS_SSL_CLI_C)
3560 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3561#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3562 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3563 p += 2;
3564 if (hostname_len > 0) {
3565 /* save host name */
3566 memcpy(p, session->hostname, hostname_len);
3567 p += hostname_len;
3568 }
3569#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3570
3571#if defined(MBEDTLS_HAVE_TIME)
3572 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3573 p += 8;
3574#endif
3575 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3576 p += 4;
3577
3578 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3579 p += 2;
3580
3581 if (session->ticket != NULL && session->ticket_len > 0) {
3582 memcpy(p, session->ticket, session->ticket_len);
3583 p += session->ticket_len;
3584 }
3585 }
3586#endif /* MBEDTLS_SSL_CLI_C */
3587 return 0;
3588}
3589
3590MBEDTLS_CHECK_RETURN_CRITICAL
3591static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3592 const unsigned char *buf,
3593 size_t len)
3594{
3595 const unsigned char *p = buf;
3596 const unsigned char *end = buf + len;
3597
3598 if (end - p < 6) {
3599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3600 }
3601 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3602 session->ticket_flags = p[4];
3603
3604 /* load resumption_key */
3605 session->resumption_key_len = p[5];
3606 p += 6;
3607
3608 if (end - p < session->resumption_key_len) {
3609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3610 }
3611
3612 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3614 }
3615 memcpy(session->resumption_key, p, session->resumption_key_len);
3616 p += session->resumption_key_len;
3617
3618#if defined(MBEDTLS_SSL_EARLY_DATA)
3619 if (end - p < 4) {
3620 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3621 }
3622 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3623 p += 4;
3624#endif
3625#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3626 if (end - p < 2) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3630 p += 2;
3631#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3632
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003633#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003634 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003635#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003636 if (end - p < 8) {
3637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3638 }
3639 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3640 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003641#endif /* MBEDTLS_HAVE_TIME */
3642
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003643#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003644 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003645
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003646 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003647 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3648 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003649
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003650 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3651 p += 2;
3652
3653 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
3656
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003657 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003658 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3659 if (ret != 0) {
3660 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003661 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003662 p += alpn_len;
3663 }
3664#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3665 }
3666#endif /* MBEDTLS_SSL_SRV_C */
3667
David Horstmanne59f9702024-02-29 16:08:57 +00003668#if defined(MBEDTLS_SSL_CLI_C)
3669 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3670#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3671 size_t hostname_len;
3672 /* load host name */
3673 if (end - p < 2) {
3674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3675 }
3676 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3677 p += 2;
3678
3679 if (end - p < (long int) hostname_len) {
3680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3681 }
3682 if (hostname_len > 0) {
3683 session->hostname = mbedtls_calloc(1, hostname_len);
3684 if (session->hostname == NULL) {
3685 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3686 }
3687 memcpy(session->hostname, p, hostname_len);
3688 p += hostname_len;
3689 }
3690#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3691
3692#if defined(MBEDTLS_HAVE_TIME)
3693 if (end - p < 8) {
3694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3695 }
3696 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3697 p += 8;
3698#endif
3699 if (end - p < 4) {
3700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3701 }
3702 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3703 p += 4;
3704
3705 if (end - p < 2) {
3706 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3707 }
3708 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3709 p += 2;
3710
3711 if (end - p < (long int) session->ticket_len) {
3712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3713 }
3714 if (session->ticket_len > 0) {
3715 session->ticket = mbedtls_calloc(1, session->ticket_len);
3716 if (session->ticket == NULL) {
3717 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3718 }
3719 memcpy(session->ticket, p, session->ticket_len);
3720 p += session->ticket_len;
3721 }
3722 }
3723#endif /* MBEDTLS_SSL_CLI_C */
3724
3725 return 0;
3726
3727}
3728#else /* MBEDTLS_SSL_SESSION_TICKETS */
3729MBEDTLS_CHECK_RETURN_CRITICAL
3730static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3731 unsigned char *buf,
3732 size_t buf_len,
3733 size_t *olen)
3734{
3735 ((void) session);
3736 ((void) buf);
3737 ((void) buf_len);
3738 *olen = 0;
3739 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3740}
3741
3742static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003743 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003744 size_t buf_len)
3745{
3746 ((void) session);
3747 ((void) buf);
3748 ((void) buf_len);
3749 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3750}
3751#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3752#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3753
Paul Bakker5121ce52009-01-03 21:22:43 +00003754/*
Hanno Beckera835da52019-05-16 12:39:07 +01003755 * Define ticket header determining Mbed TLS version
3756 * and structure of the ticket.
3757 */
3758
Hanno Becker94ef3b32019-05-16 12:50:45 +01003759/*
Hanno Becker50b59662019-05-28 14:30:45 +01003760 * Define bitflag determining compile-time settings influencing
3761 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003762 */
3763
Hanno Becker50b59662019-05-28 14:30:45 +01003764#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003765#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003766#else
Hanno Becker3e088662019-05-29 11:10:18 +01003767#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003768#endif /* MBEDTLS_HAVE_TIME */
3769
3770#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003771#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003772#else
Hanno Becker3e088662019-05-29 11:10:18 +01003773#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003774#endif /* MBEDTLS_X509_CRT_PARSE_C */
3775
David Horstmann5c5a32f2024-02-13 17:53:35 +00003776#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003777#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003778#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003779#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003780#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3781
Hanno Becker94ef3b32019-05-16 12:50:45 +01003782#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003783#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003784#else
Hanno Becker3e088662019-05-29 11:10:18 +01003785#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003786#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3787
3788#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003789#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003790#else
Hanno Becker3e088662019-05-29 11:10:18 +01003791#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003792#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3793
Hanno Becker94ef3b32019-05-16 12:50:45 +01003794#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003795#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003796#else
Hanno Becker3e088662019-05-29 11:10:18 +01003797#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003798#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3799
Hanno Becker94ef3b32019-05-16 12:50:45 +01003800#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3801#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3802#else
3803#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3804#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3805
David Horstmann92b258b2024-02-13 17:23:34 +00003806#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3807#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3808#else
3809#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3810#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3811
3812#if defined(MBEDTLS_SSL_EARLY_DATA)
3813#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3814#else
3815#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3816#endif /* MBEDTLS_SSL_EARLY_DATA */
3817
3818#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3819#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3820#else
3821#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3822#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3823
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003824#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3825 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003826#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3827#else
3828#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3829#endif /* MBEDTLS_SSL_ALPN */
3830
Hanno Becker3e088662019-05-29 11:10:18 +01003831#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3832#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3833#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3834#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003835#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3836#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003837#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003838#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3839#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3840#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003841#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003842
Hanno Becker50b59662019-05-28 14:30:45 +01003843#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003844 ((uint16_t) ( \
3845 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3846 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3847 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3848 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3849 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3850 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003851 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003852 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3853 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003854 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3855 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3856 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3857 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003858 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003859 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003860 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003861
Chien Wong4e9683e2023-12-28 17:07:43 +08003862static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003863 MBEDTLS_VERSION_MAJOR,
3864 MBEDTLS_VERSION_MINOR,
3865 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3867 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003868};
Hanno Beckera835da52019-05-16 12:39:07 +01003869
3870/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003871 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003872 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003873 *
David Horstmanncb01b362024-02-29 17:31:46 +00003874 * TLS 1.2 session:
3875 *
3876 * struct {
3877 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3878 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3879 * uint32 ticket_lifetime;
3880 * #endif
3881 * } ClientOnlyData;
3882 *
3883 * struct {
3884 * #if defined(MBEDTLS_HAVE_TIME)
3885 * uint64 start_time;
3886 * #endif
3887 * uint8 session_id_len; // at most 32
3888 * opaque session_id[32];
3889 * opaque master[48]; // fixed length in the standard
3890 * uint32 verify_result;
3891 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3892 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3893 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003894 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003895 * opaque peer_cert_digest<0..2^8-1>
3896 * #endif
3897 * select (endpoint) {
3898 * case client: ClientOnlyData;
3899 * case server: uint64 ticket_creation_time;
3900 * };
3901 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3902 * uint8 mfl_code; // up to 255 according to standard
3903 * #endif
3904 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3905 * uint8 encrypt_then_mac; // 0 or 1
3906 * #endif
3907 * } serialized_session_tls12;
3908 *
3909 *
3910 * TLS 1.3 Session:
3911 *
3912 * struct {
3913 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3914 * opaque hostname<0..2^16-1>;
3915 * #endif
3916 * #if defined(MBEDTLS_HAVE_TIME)
3917 * uint64 ticket_reception_time;
3918 * #endif
3919 * uint32 ticket_lifetime;
3920 * opaque ticket<1..2^16-1>;
3921 * } ClientOnlyData;
3922 *
3923 * struct {
3924 * uint32 ticket_age_add;
3925 * uint8 ticket_flags;
3926 * opaque resumption_key<0..255>;
3927 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3928 * uint32 max_early_data_size;
3929 * #endif
3930 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3931 * uint16 record_size_limit;
3932 * #endif
3933 * select ( endpoint ) {
3934 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003935 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003936 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003937 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003938 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003939 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003940 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003941 * #endif
3942 * };
3943 * } serialized_session_tls13;
3944 *
3945 *
3946 * SSL session:
3947 *
3948 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003949 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003950 * opaque mbedtls_version[3]; // library version: major, minor, patch
3951 * opaque session_format[2]; // library-version specific 16-bit field
3952 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003953 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003954 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003955 * Note: When updating the format, remember to keep
3956 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003957 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003958 * // In this version, `session_format` determines
3959 * // the setting of those compile-time
3960 * // configuration options which influence
3961 * // the structure of mbedtls_ssl_session.
3962 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003963 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003964 * // - TLS 1.2 (0x0303)
3965 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003966 * uint8_t endpoint;
3967 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003968 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003969 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003970 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003971 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003972 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003973 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003974 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003975 *
3976 * };
3977 *
3978 * } serialized_session;
3979 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003980 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003981
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003983static int ssl_session_save(const mbedtls_ssl_session *session,
3984 unsigned char omit_header,
3985 unsigned char *buf,
3986 size_t buf_len,
3987 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003988{
3989 unsigned char *p = buf;
3990 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003991 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003992#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3993 size_t out_len;
3994 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3995#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if (session == NULL) {
3997 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3998 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003999
Gilles Peskine449bd832023-01-11 14:50:10 +01004000 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004001 /*
4002 * Add Mbed TLS version identifier
4003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004005
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 if (used <= buf_len) {
4007 memcpy(p, ssl_serialized_session_header,
4008 sizeof(ssl_serialized_session_header));
4009 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004010 }
4011 }
4012
4013 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004014 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004015 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004016 used += 1 /* TLS version */
4017 + 1 /* endpoint */
4018 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004019 if (used <= buf_len) {
4020 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004021 *p++ = session->endpoint;
4022 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4023 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024 }
4025
4026 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004027 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 case MBEDTLS_SSL_VERSION_TLS1_2:
4031 used += ssl_tls12_session_save(session, p, remaining_len);
4032 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004033#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4034
Jerry Yu251a12e2022-07-13 15:15:48 +08004035#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 case MBEDTLS_SSL_VERSION_TLS1_3:
4037 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4038 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4039 return ret;
4040 }
4041 used += out_len;
4042 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004043#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 default:
4046 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004047 }
4048
4049 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 if (used > buf_len) {
4051 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4052 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004053
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004055}
4056
4057/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004058 * Public wrapper for ssl_session_save()
4059 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004060int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4061 unsigned char *buf,
4062 size_t buf_len,
4063 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004064{
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004066}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004067
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004068/*
4069 * Deserialize session, see mbedtls_ssl_session_save() for format.
4070 *
4071 * This internal version is wrapped by a public function that cleans up in
4072 * case of error, and has an extra option omit_header.
4073 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004074MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004075static int ssl_session_load(mbedtls_ssl_session *session,
4076 unsigned char omit_header,
4077 const unsigned char *buf,
4078 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004079{
4080 const unsigned char *p = buf;
4081 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004082 size_t remaining_len;
4083
4084
Gilles Peskine449bd832023-01-11 14:50:10 +01004085 if (session == NULL) {
4086 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4087 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004090 /*
4091 * Check Mbed TLS version identifier
4092 */
4093
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4095 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004096 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004097
4098 if (memcmp(p, ssl_serialized_session_header,
4099 sizeof(ssl_serialized_session_header)) != 0) {
4100 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4101 }
4102 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004103 }
4104
4105 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004106 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004107 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004108 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4110 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004111 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004112 session->endpoint = *p++;
4113 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4114 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004115
4116 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004117 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004119#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 case MBEDTLS_SSL_VERSION_TLS1_2:
4121 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004122#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4123
Jerry Yu438ddd82022-07-07 06:55:50 +00004124#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 case MBEDTLS_SSL_VERSION_TLS1_3:
4126 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004127#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4128
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 default:
4130 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004131 }
4132}
4133
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004134/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004135 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004136 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004137int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4138 const unsigned char *buf,
4139 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004140{
Gilles Peskine449bd832023-01-11 14:50:10 +01004141 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (ret != 0) {
4144 mbedtls_ssl_session_free(session);
4145 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004146
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004148}
4149
4150/*
Paul Bakker1961b702013-01-25 14:49:24 +01004151 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004152 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004153MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004154static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004155{
4156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4157
Ronald Cron66dbf912022-02-02 15:33:46 +01004158 /*
4159 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004160 * that were written into the output buffer by the previous handshake step,
4161 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004162 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4163 * We proceed to the next handshake step only when all data from the
4164 * previous one have been sent to the peer, thus we make sure that this is
4165 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4166 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4167 * we have to wait before to go ahead.
4168 * In the case of TLS 1.3, handshake step handlers do not send data to the
4169 * peer. Data are only sent here and through
4170 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004171 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004173 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4174 return ret;
4175 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004176
4177#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4179 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4180 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4181 return ret;
4182 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004183 }
4184#endif /* MBEDTLS_SSL_PROTO_DTLS */
4185
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004187}
4188
Gilles Peskine449bd832023-01-11 14:50:10 +01004189int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004190{
Hanno Becker41934dd2021-08-07 19:13:43 +01004191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004192
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004194 ssl->conf == NULL ||
4195 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4197 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004198 }
4199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 ret = ssl_prepare_handshake_step(ssl);
4201 if (ret != 0) {
4202 return ret;
4203 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 ret = mbedtls_ssl_handle_pending_alert(ssl);
4206 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004207 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 }
Jerry Yue7047812021-09-13 19:26:39 +08004209
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004210 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4211 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4212 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004214#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4216 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004217 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004220 case MBEDTLS_SSL_HELLO_REQUEST:
4221 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004222 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004223 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004224
Ronald Cron9f0fba32022-02-10 16:45:15 +01004225 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004227 break;
4228
4229 default:
4230#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4232 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4233 } else {
4234 ret = mbedtls_ssl_handshake_client_step(ssl);
4235 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004236#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004238#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004240#endif
4241 }
Jerry Yub9930e72021-08-06 17:11:51 +08004242 }
Ronald Cron6291b232023-03-08 15:51:25 +01004243#endif /* MBEDTLS_SSL_CLI_C */
4244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004245#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004246 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004247#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4248 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004250 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 ret = mbedtls_ssl_handshake_server_step(ssl);
4252 }
Ronald Cron6291b232023-03-08 15:51:25 +01004253#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4254 ret = mbedtls_ssl_handshake_server_step(ssl);
4255#else
4256 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004257#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004258 }
4259#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004262 /* handshake_step return error. And it is same
4263 * with alert_reason.
4264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (ssl->send_alert) {
4266 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004267 goto cleanup;
4268 }
4269 }
4270
4271cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004272 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004273}
4274
4275/*
4276 * Perform the SSL handshake
4277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004279{
4280 int ret = 0;
4281
Hanno Beckera817ea42020-10-20 15:20:23 +01004282 /* Sanity checks */
4283
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 if (ssl == NULL || ssl->conf == NULL) {
4285 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4286 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004287
Hanno Beckera817ea42020-10-20 15:20:23 +01004288#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4290 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4291 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4292 "mbedtls_ssl_set_timer_cb() for DTLS"));
4293 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004294 }
4295#endif /* MBEDTLS_SSL_PROTO_DTLS */
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004298
Hanno Beckera817ea42020-10-20 15:20:23 +01004299 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4301 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004304 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 }
Paul Bakker1961b702013-01-25 14:49:24 +01004306 }
4307
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004311}
4312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004313#if defined(MBEDTLS_SSL_RENEGOTIATION)
4314#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004315/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004316 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004317 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004319static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004320{
Janos Follath865b3eb2019-12-16 11:46:15 +00004321 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004324
4325 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004326 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4327 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4330 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4331 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004332 }
4333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004337}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004338#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004339
4340/*
4341 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004342 * - any side: calling mbedtls_ssl_renegotiate(),
4343 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4344 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004345 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004346 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004347 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004349int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004350{
Janos Follath865b3eb2019-12-16 11:46:15 +00004351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if ((ret = ssl_handshake_init(ssl)) != 0) {
4356 return ret;
4357 }
Paul Bakker48916f92012-09-16 19:57:18 +00004358
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004359 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4360 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4363 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4364 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004365 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004367 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004369 }
4370#endif
4371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004372 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4373 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4376 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4377 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004378 }
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004383}
4384
4385/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004386 * Renegotiate current connection on client,
4387 * or request renegotiation on server
4388 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004390{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004391 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (ssl == NULL || ssl->conf == NULL) {
4394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4395 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004396
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004397#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004398 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4400 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4402 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004404 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004405
4406 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (ssl->out_left != 0) {
4408 return mbedtls_ssl_flush_output(ssl);
4409 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004412 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004413#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004416 /*
4417 * On client, either start the renegotiation process or,
4418 * if already in progress, continue the handshake
4419 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4421 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4422 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004423 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004424
4425 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4426 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4427 return ret;
4428 }
4429 } else {
4430 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4431 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4432 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004433 }
4434 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004435#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004438}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004439#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004442{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004443 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004446 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004448
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004449#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004450#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 if (ssl->handshake->group_list_heap_allocated) {
4452 mbedtls_free((void *) handshake->group_list);
4453 }
Brett Warrene0edc842021-08-17 09:53:13 +01004454 handshake->group_list = NULL;
4455#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004456#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004457
Ronald Crone68ab4f2022-10-05 12:46:29 +02004458#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004459#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (ssl->handshake->sig_algs_heap_allocated) {
4461 mbedtls_free((void *) handshake->sig_algs);
4462 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004463 handshake->sig_algs = NULL;
4464#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004465#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (ssl->handshake->certificate_request_context) {
4467 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004468 }
4469#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004470#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004471
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004472#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4474 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004475 handshake->async_in_progress = 0;
4476 }
4477#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4478
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004479#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004481#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004482#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004484#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004485
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004486#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004488 /*
4489 * Opaque keys are not stored in the handshake's data and it's the user
4490 * responsibility to destroy them. Clear ones, instead, are created by
4491 * the TLS library and should be destroyed at the same level
4492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4494 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004495 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004496 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004497#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004499 handshake->ecjpake_cache = NULL;
4500 handshake->ecjpake_cache_len = 0;
4501#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004502#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004503
Valerio Setti7aeec542023-07-05 18:57:21 +02004504#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004505 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004506 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004507 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004509#endif
4510
Ronald Cron73fe8df2022-10-05 14:31:43 +02004511#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004513 /* The maintenance of the external PSK key slot is the
4514 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (ssl->handshake->psk_opaque_is_internal) {
4516 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004517 ssl->handshake->psk_opaque_is_internal = 0;
4518 }
4519 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4520 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004521#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4524 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004525 /*
4526 * Free only the linked list wrapper, not the keys themselves
4527 * since the belong to the SNI callback
4528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004531
Gilles Peskineeccd8882020-03-10 12:19:08 +01004532#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4534 if (handshake->ecrs_peer_cert != NULL) {
4535 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4536 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004537 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004538#endif
4539
Hanno Becker75173122019-02-06 16:18:31 +00004540#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4541 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004543#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4544
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004545#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4547 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004548#endif /* MBEDTLS_SSL_CLI_C &&
4549 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004550
4551#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 mbedtls_ssl_flight_free(handshake->flight);
4553 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004554#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004555
Valerio Settiea59c432023-07-25 11:14:03 +02004556#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004557 if (handshake->xxdh_psa_privkey_is_external == 0) {
4558 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 }
Valerio Settiea59c432023-07-25 11:14:03 +02004560#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004561
Ronald Cron6f135e12021-12-08 16:57:54 +01004562#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 mbedtls_ssl_transform_free(handshake->transform_handshake);
4564 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004565#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4567 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004568#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004569#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004570
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004571
4572#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4573 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4574 * processes datagrams and the fact that a datagram is allowed to have
4575 * several records in it, it is possible that the I/O buffers are not
4576 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4578 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004579#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004580
Jerry Yuba9c7272021-10-30 11:54:10 +08004581 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 mbedtls_platform_zeroize(handshake,
4583 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004584}
4585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004587{
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004589 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004592#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004594#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004595
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004596#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004597#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4598 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004602#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004603
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004604#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4605 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004606 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004607#endif
4608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004610}
4611
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004612#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004613
4614#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4615#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4616#else
4617#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4618#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4619
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004620#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004621
4622#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4623#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4624#else
4625#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4626#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4627
4628#if defined(MBEDTLS_SSL_ALPN)
4629#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4630#else
4631#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4632#endif /* MBEDTLS_SSL_ALPN */
4633
4634#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4635#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4636#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4637#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4638
4639#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 ((uint32_t) ( \
4641 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4642 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4643 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4644 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4645 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4646 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4647 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4648 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004649
Chien Wong4e9683e2023-12-28 17:07:43 +08004650static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004651 MBEDTLS_VERSION_MAJOR,
4652 MBEDTLS_VERSION_MINOR,
4653 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4655 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4656 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4657 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4658 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004659};
4660
Paul Bakker5121ce52009-01-03 21:22:43 +00004661/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004662 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004663 *
4664 * The format of the serialized data is:
4665 * (in the presentation language of TLS, RFC 8446 section 3)
4666 *
4667 * // header
4668 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004669 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004670 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004671 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004672 * Note: When updating the format, remember to keep these
4673 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004674 *
4675 * // session sub-structure
4676 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4677 * // transform sub-structure
4678 * uint8 random[64]; // ServerHello.random+ClientHello.random
4679 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4680 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4681 * // fields from ssl_context
4682 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4683 * uint64 in_window_top; // DTLS: last validated record seq_num
4684 * uint64 in_window; // DTLS: bitmask for replay protection
4685 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4686 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4687 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4688 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4689 *
4690 * Note that many fields of the ssl_context or sub-structures are not
4691 * serialized, as they fall in one of the following categories:
4692 *
4693 * 1. forced value (eg in_left must be 0)
4694 * 2. pointer to dynamically-allocated memory (eg session, transform)
4695 * 3. value can be re-derived from other data (eg session keys from MS)
4696 * 4. value was temporary (eg content of input buffer)
4697 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004698 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004699int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4700 unsigned char *buf,
4701 size_t buf_len,
4702 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004703{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004704 unsigned char *p = buf;
4705 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004706 size_t session_len;
4707 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004708
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004709 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004710 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4711 * this function's documentation.
4712 *
4713 * These are due to assumptions/limitations in the implementation. Some of
4714 * them are likely to stay (no handshake in progress) some might go away
4715 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004716 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004717 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4719 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004721 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (ssl->handshake != NULL) {
4723 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004725 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004726 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if (ssl->transform == NULL || ssl->session == NULL) {
4728 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004730 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004731 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if (mbedtls_ssl_check_pending(ssl) != 0) {
4733 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004735 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (ssl->out_left != 0) {
4737 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004739 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004740 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4742 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004744 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004745 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4747 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004749 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004750 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004754 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004755 /* Renegotiation must not be enabled */
4756#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4758 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4759 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004760 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004761#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004762
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004763 /*
4764 * Version and format identifier
4765 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004767
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (used <= buf_len) {
4769 memcpy(p, ssl_serialized_context_header,
4770 sizeof(ssl_serialized_context_header));
4771 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004772 }
4773
4774 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004775 * Session (length + data)
4776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4778 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4779 return ret;
4780 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004781
4782 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (used <= buf_len) {
4784 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004785 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 ret = ssl_session_save(ssl->session, 1,
4788 p, session_len, &session_len);
4789 if (ret != 0) {
4790 return ret;
4791 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004792
4793 p += session_len;
4794 }
4795
4796 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004797 * Transform
4798 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 used += sizeof(ssl->transform->randbytes);
4800 if (used <= buf_len) {
4801 memcpy(p, ssl->transform->randbytes,
4802 sizeof(ssl->transform->randbytes));
4803 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004804 }
4805
4806#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004807 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004809 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004811 p += ssl->transform->in_cid_len;
4812
4813 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004815 p += ssl->transform->out_cid_len;
4816 }
4817#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4818
4819 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004820 * Saved fields from top-level ssl_context structure
4821 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004822 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (used <= buf_len) {
4824 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004825 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004826 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004827
4828#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4829 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 if (used <= buf_len) {
4831 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004832 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004835 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004836 }
4837#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4838
4839#if defined(MBEDTLS_SSL_PROTO_DTLS)
4840 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004842 *p++ = ssl->disable_datagram_packing;
4843 }
4844#endif /* MBEDTLS_SSL_PROTO_DTLS */
4845
Jerry Yuae0b2e22021-10-08 15:21:19 +08004846 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (used <= buf_len) {
4848 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004849 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004850 }
4851
4852#if defined(MBEDTLS_SSL_PROTO_DTLS)
4853 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (used <= buf_len) {
4855 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004856 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004857 }
4858#endif /* MBEDTLS_SSL_PROTO_DTLS */
4859
4860#if defined(MBEDTLS_SSL_ALPN)
4861 {
4862 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004864 : 0;
4865
4866 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004868 *p++ = alpn_len;
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (ssl->alpn_chosen != NULL) {
4871 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004872 p += alpn_len;
4873 }
4874 }
4875 }
4876#endif /* MBEDTLS_SSL_ALPN */
4877
4878 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004879 * Done
4880 */
4881 *olen = used;
4882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 if (used > buf_len) {
4884 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4885 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004890}
4891
4892/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004893 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004894 *
4895 * This internal version is wrapped by a public function that cleans up in
4896 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004897 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004898MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004899static int ssl_context_load(mbedtls_ssl_context *ssl,
4900 const unsigned char *buf,
4901 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004902{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004903 const unsigned char *p = buf;
4904 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004905 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004907#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004908 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004909#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004910
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004911 /*
4912 * The context should have been freshly setup or reset.
4913 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004914 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004915 * renegotiating, or if the user mistakenly loaded a session first.)
4916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4918 ssl->session != NULL) {
4919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004920 }
4921
4922 /*
4923 * We can't check that the config matches the initial one, but we can at
4924 * least check it matches the requirements for serializing.
4925 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004926 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004927#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004928 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004929#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004930 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4931 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4932 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4933 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004935 }
4936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004938
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004939 /*
4940 * Check version identifier
4941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004944 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004945
4946 if (memcmp(p, ssl_serialized_context_header,
4947 sizeof(ssl_serialized_context_header)) != 0) {
4948 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4949 }
4950 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004951
4952 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953 * Session
4954 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if ((size_t) (end - p) < 4) {
4956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4957 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004958
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004959 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004960 p += 4;
4961
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004962 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004963 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004964 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004965 ssl->session_in = ssl->session;
4966 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004967 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004968
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if ((size_t) (end - p) < session_len) {
4970 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4971 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 ret = ssl_session_load(ssl->session, 1, p, session_len);
4974 if (ret != 0) {
4975 mbedtls_ssl_session_free(ssl->session);
4976 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004977 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004978
4979 p += session_len;
4980
4981 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004982 * Transform
4983 */
4984
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004985 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004986 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004987#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004988 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004989 ssl->transform_in = ssl->transform;
4990 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004991 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004992#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004993
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004994#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4996 if (prf_func == NULL) {
4997 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4998 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004999
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005000 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5003 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005 ret = ssl_tls12_populate_transform(ssl->transform,
5006 ssl->session->ciphersuite,
5007 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005008#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005010#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 prf_func,
5012 p, /* currently pointing to randbytes */
5013 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5014 ssl->conf->endpoint,
5015 ssl);
5016 if (ret != 0) {
5017 return ret;
5018 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005019#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005021
5022#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5023 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 if ((size_t) (end - p) < 1) {
5025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5026 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005027
5028 ssl->transform->in_cid_len = *p++;
5029
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5032 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005035 p += ssl->transform->in_cid_len;
5036
5037 ssl->transform->out_cid_len = *p++;
5038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5041 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005042
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005044 p += ssl->transform->out_cid_len;
5045#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5046
5047 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005048 * Saved fields from top-level ssl_context structure
5049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if ((size_t) (end - p) < 4) {
5051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5052 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005053
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005054 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005055 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005056
5057#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if ((size_t) (end - p) < 16) {
5059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5060 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005061
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005062 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005063 p += 8;
5064
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005065 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066 p += 8;
5067#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5068
5069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if ((size_t) (end - p) < 1) {
5071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5072 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073
5074 ssl->disable_datagram_packing = *p++;
5075#endif /* MBEDTLS_SSL_PROTO_DTLS */
5076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5079 }
5080 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5081 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005082
5083#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005084 if ((size_t) (end - p) < 2) {
5085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5086 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005087
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005088 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005089 p += 2;
5090#endif /* MBEDTLS_SSL_PROTO_DTLS */
5091
5092#if defined(MBEDTLS_SSL_ALPN)
5093 {
5094 uint8_t alpn_len;
5095 const char **cur;
5096
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if ((size_t) (end - p) < 1) {
5098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5099 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005100
5101 alpn_len = *p++;
5102
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005104 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5106 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005107 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005108 ssl->alpn_chosen = *cur;
5109 break;
5110 }
5111 }
5112 }
5113
5114 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5117 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005118
5119 p += alpn_len;
5120 }
5121#endif /* MBEDTLS_SSL_ALPN */
5122
5123 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005124 * Forced fields from top-level ssl_context structure
5125 *
5126 * Most of them already set to the correct value by mbedtls_ssl_init() and
5127 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5128 */
5129 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005130 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005131
Hanno Becker361b10d2019-08-30 10:42:49 +01005132 /* Adjust pointers for header fields of outgoing records to
5133 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005135
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005136#if defined(MBEDTLS_SSL_PROTO_DTLS)
5137 ssl->in_epoch = 1;
5138#endif
5139
5140 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5141 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005142 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5143 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (ssl->handshake != NULL) {
5145 mbedtls_ssl_handshake_free(ssl);
5146 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005147 ssl->handshake = NULL;
5148 }
5149
5150 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005151 * Done - should have consumed entire buffer
5152 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (p != end) {
5154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5155 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005156
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005158}
5159
5160/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005161 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005162 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5164 const unsigned char *buf,
5165 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005166{
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005168
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 if (ret != 0) {
5170 mbedtls_ssl_free(context);
5171 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005174}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005175#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005176
5177/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005178 * Free an SSL context
5179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005180void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005181{
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005183 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005189#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5190 size_t out_buf_len = ssl->out_buf_len;
5191#else
5192 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5193#endif
5194
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005195 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005196 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005197 }
5198
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005200#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5201 size_t in_buf_len = ssl->in_buf_len;
5202#else
5203 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5204#endif
5205
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005206 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005207 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005208 }
5209
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 if (ssl->transform) {
5211 mbedtls_ssl_transform_free(ssl->transform);
5212 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005213 }
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (ssl->handshake) {
5216 mbedtls_ssl_handshake_free(ssl);
5217 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005218
5219#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5221 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005222#endif
5223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 mbedtls_ssl_session_free(ssl->session_negotiate);
5225 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005226 }
5227
Ronald Cron6f135e12021-12-08 16:57:54 +01005228#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 mbedtls_ssl_transform_free(ssl->transform_application);
5230 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005231#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (ssl->session) {
5234 mbedtls_ssl_session_free(ssl->session);
5235 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005236 }
5237
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005238#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005240 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005241 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005242#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005243
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005244#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005246#endif
5247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005249
Paul Bakker86f04f42013-02-14 11:20:09 +01005250 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005252}
5253
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005254/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005255 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005256 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005257void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005258{
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005260}
5261
Gilles Peskineae270bf2021-06-02 00:05:29 +02005262/* The selection should be the same as mbedtls_x509_crt_profile_default in
5263 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005264 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005265 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005266 * about this list.
5267 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005268static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005269#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005270 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005271#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005272#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005273 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005274#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005275#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005276 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005277#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005278#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005279 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005280#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005281#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005282 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005283#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005284#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005285 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005286#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005287#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005288 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005289#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005290#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005291 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005292#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005293#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005294 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5295 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5296 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5297 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5298 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5299#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005300 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005301};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005302
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005303static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005304 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5305 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5306 0
5307};
5308
Ronald Crone68ab4f2022-10-05 12:46:29 +02005309#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005310
Jerry Yu909df7b2022-01-22 11:56:27 +08005311/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005312 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005313 * rules SHOULD be upheld.
5314 * - No duplicate entries.
5315 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005316 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005317 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005318 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005319static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005320
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005321#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005322 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005323 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005324 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005325 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5326#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005327
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005328#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005329 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005330 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005331 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005332 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5333#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005334
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005335#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005336 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005337 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005338 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005339 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5340#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005341
Gabor Mezeic15ef932024-06-13 12:53:54 +02005342#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005343 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005344#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005345
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005346#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005347 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005348#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005349
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005350#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005351 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005352#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005353
Gabor Mezeic15ef932024-06-13 12:53:54 +02005354#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005355 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005356#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005357
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005358#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005359 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005360#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005361
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005362#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005363 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005364#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005365
Gabor Mezei15b95a62022-05-09 16:37:58 +02005366 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005367};
5368
5369/* NOTICE: see above */
5370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5371static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005372
Gabor Mezeic15ef932024-06-13 12:53:54 +02005373#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005374#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005376#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005377#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5378 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005379#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005380#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005382#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005383#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005384
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005385#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005386#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005387 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005388#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005389#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5390 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005391#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005392#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005394#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005395#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005396
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005397#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005398#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005400#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005401#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5402 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005403#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005404#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005406#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005407#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005408
Gabor Mezei15b95a62022-05-09 16:37:58 +02005409 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005410};
5411#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005412
Jerry Yu909df7b2022-01-22 11:56:27 +08005413/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005414static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005415
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005416#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005417 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005418 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005419 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005420 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5421#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005422
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005423#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005424 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005425 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005426 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005427 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5428#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005429
Gabor Mezei15b95a62022-05-09 16:37:58 +02005430 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005431};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005432
Jerry Yu909df7b2022-01-22 11:56:27 +08005433/* NOTICE: see above */
5434#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5435static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005436
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005437#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005438#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005439 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005440#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005441#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005442
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005443#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005444#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005446#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005447#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005448
Gabor Mezei15b95a62022-05-09 16:37:58 +02005449 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005450};
Jerry Yu909df7b2022-01-22 11:56:27 +08005451#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5452
Ronald Crone68ab4f2022-10-05 12:46:29 +02005453#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005454
Chien Wong4e9683e2023-12-28 17:07:43 +08005455static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005456#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005457 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005458#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005459#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005460 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005461#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005462 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005463};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005464
Ronald Crone68ab4f2022-10-05 12:46:29 +02005465#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005466/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005467 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005468MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005469static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005470{
5471 size_t i, j;
5472 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005473
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5475 for (j = 0; j < i; j++) {
5476 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005477 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 }
5479 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5480 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5481 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005482 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005483 }
5484 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005486}
5487
Ronald Crone68ab4f2022-10-05 12:46:29 +02005488#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005489
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005490/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005491 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005492 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005493int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5494 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005495{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005496#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5498 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5499 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005500 }
5501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5503 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5504 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005505 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005506
5507#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5509 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5510 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005511 }
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5514 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5515 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005516 }
5517#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005518#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005519
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005520 /* Use the functions here so that they are covered in tests,
5521 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 mbedtls_ssl_conf_endpoint(conf, endpoint);
5523 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005524
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005525 /*
5526 * Things that are common to all presets
5527 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005528#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005530 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5531#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5532 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5533#endif
5534 }
5535#endif
5536
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005537#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5538 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5539#endif
5540
5541#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5542 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5543#endif
5544
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005545#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005546 conf->f_cookie_write = ssl_cookie_write_dummy;
5547 conf->f_cookie_check = ssl_cookie_check_dummy;
5548#endif
5549
5550#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5551 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5552#endif
5553
Janos Follath088ce432017-04-10 12:42:31 +01005554#if defined(MBEDTLS_SSL_SRV_C)
5555 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005556 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005557#endif
5558
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005559#if defined(MBEDTLS_SSL_PROTO_DTLS)
5560 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5561 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5562#endif
5563
5564#if defined(MBEDTLS_SSL_RENEGOTIATION)
5565 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 memset(conf->renego_period, 0x00, 2);
5567 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005568#endif
5569
Ronald Cron6f135e12021-12-08 16:57:54 +01005570#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005571
5572#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005573 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005574#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005575 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005576#endif
5577#endif /* MBEDTLS_SSL_EARLY_DATA */
5578
Jerry Yud0766ec2022-09-22 10:46:57 +08005579#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005580 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005582#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005583 /*
5584 * Allow all TLS 1.3 key exchange modes by default.
5585 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005586 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005587#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005588
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005590#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005591 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005592 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005593#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005595#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005597#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005598 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5599 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005600#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5601 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5602 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5603#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5604 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5605 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5606#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005608#endif
5609 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005610
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005611 /*
5612 * Preset-specific defaults
5613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005615 /*
5616 * NSA Suite B
5617 */
5618 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005619
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005620 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005621
5622#if defined(MBEDTLS_X509_CRT_PARSE_C)
5623 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005624#endif
5625
Ronald Crone68ab4f2022-10-05 12:46:29 +02005626#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005629 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005631#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005633#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005634
Brett Warrene0edc842021-08-17 09:53:13 +01005635 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005636 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005637
5638 /*
5639 * Default
5640 */
5641 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005642
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005643 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005644
5645#if defined(MBEDTLS_X509_CRT_PARSE_C)
5646 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5647#endif
5648
Ronald Crone68ab4f2022-10-05 12:46:29 +02005649#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005650#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005652 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005654#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005656#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005657
Brett Warrene0edc842021-08-17 09:53:13 +01005658 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005659 }
5660
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005662}
5663
5664/*
5665 * Free mbedtls_ssl_config
5666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005667void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005668{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005669 if (conf == NULL) {
5670 return;
5671 }
5672
Ronald Cron73fe8df2022-10-05 14:31:43 +02005673#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005675 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5676 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005678 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005679 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005680 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005681 }
5682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005684 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005685 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005686 conf->psk_identity_len = 0;
5687 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005688#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005689
5690#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005692#endif
5693
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005695}
5696
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005697#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005698 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005699/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005700 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005702unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005703{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005704#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5706 return MBEDTLS_SSL_SIG_RSA;
5707 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005708#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005709#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5711 return MBEDTLS_SSL_SIG_ECDSA;
5712 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005713#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005715}
5716
Gilles Peskine449bd832023-01-11 14:50:10 +01005717unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005718{
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005720 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005722 case MBEDTLS_PK_ECDSA:
5723 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005725 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005727 }
5728}
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005731{
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733#if defined(MBEDTLS_RSA_C)
5734 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005736#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005737#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005740#endif
5741 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005743 }
5744}
Valerio Settie9646ec2023-08-02 20:02:28 +02005745#endif /* MBEDTLS_PK_C &&
5746 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005747
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005748/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005749 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005751mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005752{
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005754#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005755 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005757#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005758#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005759 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005761#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005762#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005764 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005765#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005766#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005767 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005768 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005769#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005770#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005773#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005774#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005775 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005777#endif
5778 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005780 }
5781}
5782
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005783/*
5784 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5785 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005786unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005787{
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005789#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005790 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005792#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005793#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005794 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005796#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005797#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005798 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005800#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005801#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005802 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005804#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005805#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005806 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005808#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005809#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005810 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005812#endif
5813 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005815 }
5816}
5817
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005818/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005819 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005820 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005822int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005823{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005824 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 if (group_list == NULL) {
5827 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005828 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 for (; *group_list != 0; group_list++) {
5831 if (*group_list == tls_id) {
5832 return 0;
5833 }
5834 }
5835
5836 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005837}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005838
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005839#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005840/*
5841 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005843int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005844{
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005848 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005852}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005853#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005854
Valerio Setti18c9fed2022-12-30 17:44:24 +01005855static const struct {
5856 uint16_t tls_id;
5857 mbedtls_ecp_group_id ecp_group_id;
5858 psa_ecc_family_t psa_family;
5859 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005860} tls_id_match_table[] =
5861{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005862#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005863 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005864#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005865#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005866 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005867#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005868#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005869 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005870#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005871#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005872 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005873#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005874#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005875 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005876#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005877#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005878 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005879#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005880#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005881 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005882#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005883#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005884 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005885#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005886#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005887 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005888#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005889#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005890 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005891#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005892#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005893 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005894#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005895#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005896 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005897#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005898 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005899};
5900
Gilles Peskine449bd832023-01-11 14:50:10 +01005901int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005902 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904{
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5906 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005907 if (type != NULL) {
5908 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 }
5910 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005911 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005912 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005913 return PSA_SUCCESS;
5914 }
5915 }
5916
5917 return PSA_ERROR_NOT_SUPPORTED;
5918}
5919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005921{
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5923 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005924 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005926 }
5927
5928 return MBEDTLS_ECP_DP_NONE;
5929}
5930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005932{
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5934 i++) {
5935 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005936 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005938 }
5939
5940 return 0;
5941}
5942
Valerio Setti67419f02023-01-04 16:12:42 +01005943#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005944static const struct {
5945 uint16_t tls_id;
5946 const char *name;
5947} tls_id_curve_name_table[] =
5948{
Valerio Setti54e23792023-07-07 10:49:27 +02005949 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5950 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5951 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5952 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5953 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5954 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5955 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5956 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5957 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5958 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5959 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5960 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5961 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005962 { 0, NULL },
5963};
5964
Gilles Peskine449bd832023-01-11 14:50:10 +01005965const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005966{
Valerio Settiacd32c02023-06-29 18:06:29 +02005967 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5968 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5969 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005971 }
5972
5973 return NULL;
5974}
Valerio Setti67419f02023-01-04 16:12:42 +01005975#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5978 const mbedtls_md_type_t md,
5979 unsigned char *dst,
5980 size_t dst_len,
5981 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005982{
Ronald Cronf6893e12022-01-07 22:09:01 +01005983 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5984 psa_hash_operation_t *hash_operation_to_clone;
5985 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5986
Jerry Yu148165c2021-09-24 23:20:59 +08005987 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005988
Gilles Peskine449bd832023-01-11 14:50:10 +01005989 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005990#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005991 case MBEDTLS_MD_SHA384:
5992 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5993 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005994#endif
5995
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005996#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 case MBEDTLS_MD_SHA256:
5998 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5999 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006000#endif
6001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 default:
6003 goto exit;
6004 }
6005
6006 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6007 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006008 goto exit;
6009 }
6010
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6012 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006013 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006015
6016exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006017#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006018 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006019 (void) ssl;
6020#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006021 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006022}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006023
Ronald Crone68ab4f2022-10-05 12:46:29 +02006024#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006025/* mbedtls_ssl_parse_sig_alg_ext()
6026 *
6027 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6028 * value (TLS 1.3 RFC8446):
6029 * enum {
6030 * ....
6031 * ecdsa_secp256r1_sha256( 0x0403 ),
6032 * ecdsa_secp384r1_sha384( 0x0503 ),
6033 * ecdsa_secp521r1_sha512( 0x0603 ),
6034 * ....
6035 * } SignatureScheme;
6036 *
6037 * struct {
6038 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6039 * } SignatureSchemeList;
6040 *
6041 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6042 * value (TLS 1.2 RFC5246):
6043 * enum {
6044 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6045 * sha512(6), (255)
6046 * } HashAlgorithm;
6047 *
6048 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6049 * SignatureAlgorithm;
6050 *
6051 * struct {
6052 * HashAlgorithm hash;
6053 * SignatureAlgorithm signature;
6054 * } SignatureAndHashAlgorithm;
6055 *
6056 * SignatureAndHashAlgorithm
6057 * supported_signature_algorithms<2..2^16-2>;
6058 *
6059 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6060 * generalization of the TLS 1.2 signature algorithm extension.
6061 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6062 * `SignatureScheme` field of TLS 1.3
6063 *
6064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006065int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6066 const unsigned char *buf,
6067 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006068{
6069 const unsigned char *p = buf;
6070 size_t supported_sig_algs_len = 0;
6071 const unsigned char *supported_sig_algs_end;
6072 uint16_t sig_alg;
6073 uint32_t common_idx = 0;
6074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6076 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006077 p += 2;
6078
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 memset(ssl->handshake->received_sig_algs, 0,
6080 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006081
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006083 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 while (p < supported_sig_algs_end) {
6085 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6086 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006087 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6089 sig_alg,
6090 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6093 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6094 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006095 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006096 }
6097#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6100 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006101
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006103 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6104 common_idx += 1;
6105 }
6106 }
6107 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (p != end) {
6109 MBEDTLS_SSL_DEBUG_MSG(1,
6110 ("Signature algorithms extension length misaligned"));
6111 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6112 MBEDTLS_ERR_SSL_DECODE_ERROR);
6113 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006114 }
6115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 if (common_idx == 0) {
6117 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6118 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6119 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6120 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006121 }
6122
Gabor Mezei15b95a62022-05-09 16:37:58 +02006123 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006125}
6126
Ronald Crone68ab4f2022-10-05 12:46:29 +02006127#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006128
Jerry Yudc7bd172022-02-17 13:44:15 +08006129#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6130
Jerry Yudc7bd172022-02-17 13:44:15 +08006131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6133 mbedtls_svc_key_id_t key,
6134 psa_algorithm_t alg,
6135 const unsigned char *raw_psk, size_t raw_psk_length,
6136 const unsigned char *seed, size_t seed_length,
6137 const unsigned char *label, size_t label_length,
6138 const unsigned char *other_secret,
6139 size_t other_secret_length,
6140 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006141{
6142 psa_status_t status;
6143
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 status = psa_key_derivation_setup(derivation, alg);
6145 if (status != PSA_SUCCESS) {
6146 return status;
6147 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6150 status = psa_key_derivation_input_bytes(derivation,
6151 PSA_KEY_DERIVATION_INPUT_SEED,
6152 seed, seed_length);
6153 if (status != PSA_SUCCESS) {
6154 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006155 }
6156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (other_secret != NULL) {
6158 status = psa_key_derivation_input_bytes(derivation,
6159 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6160 other_secret, other_secret_length);
6161 if (status != PSA_SUCCESS) {
6162 return status;
6163 }
6164 }
6165
6166 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006167 status = psa_key_derivation_input_bytes(
6168 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 raw_psk, raw_psk_length);
6170 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006171 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006173 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (status != PSA_SUCCESS) {
6175 return status;
6176 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006177
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 status = psa_key_derivation_input_bytes(derivation,
6179 PSA_KEY_DERIVATION_INPUT_LABEL,
6180 label, label_length);
6181 if (status != PSA_SUCCESS) {
6182 return status;
6183 }
6184 } else {
6185 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006186 }
6187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 status = psa_key_derivation_set_capacity(derivation, capacity);
6189 if (status != PSA_SUCCESS) {
6190 return status;
6191 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006194}
6195
Andrzej Kurek57d10632022-10-24 10:32:01 -04006196#if defined(PSA_WANT_ALG_SHA_384) || \
6197 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006198MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006199static int tls_prf_generic(mbedtls_md_type_t md_type,
6200 const unsigned char *secret, size_t slen,
6201 const char *label,
6202 const unsigned char *random, size_t rlen,
6203 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006204{
6205 psa_status_t status;
6206 psa_algorithm_t alg;
6207 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6208 psa_key_derivation_operation_t derivation =
6209 PSA_KEY_DERIVATION_OPERATION_INIT;
6210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006212 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006214 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006216
6217 /* Normally a "secret" should be long enough to be impossible to
6218 * find by brute force, and in particular should not be empty. But
6219 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6220 * and for this use case it makes sense to have a 0-length "secret".
6221 * Since the key API doesn't allow importing a key of length 0,
6222 * keep master_key=0, which setup_psa_key_derivation() understands
6223 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6227 psa_set_key_algorithm(&key_attributes, alg);
6228 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6231 if (status != PSA_SUCCESS) {
6232 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6233 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006234 }
6235
Gilles Peskine449bd832023-01-11 14:50:10 +01006236 status = setup_psa_key_derivation(&derivation,
6237 master_key, alg,
6238 NULL, 0,
6239 random, rlen,
6240 (unsigned char const *) label,
6241 (size_t) strlen(label),
6242 NULL, 0,
6243 dlen);
6244 if (status != PSA_SUCCESS) {
6245 psa_key_derivation_abort(&derivation);
6246 psa_destroy_key(master_key);
6247 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006248 }
6249
Gilles Peskine449bd832023-01-11 14:50:10 +01006250 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6251 if (status != PSA_SUCCESS) {
6252 psa_key_derivation_abort(&derivation);
6253 psa_destroy_key(master_key);
6254 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006255 }
6256
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 status = psa_key_derivation_abort(&derivation);
6258 if (status != PSA_SUCCESS) {
6259 psa_destroy_key(master_key);
6260 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006261 }
6262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (!mbedtls_svc_key_id_is_null(master_key)) {
6264 status = psa_destroy_key(master_key);
6265 }
6266 if (status != PSA_SUCCESS) {
6267 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6268 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006271}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006272#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006273
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006274#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006275MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006276static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6277 const char *label,
6278 const unsigned char *random, size_t rlen,
6279 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006280{
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6282 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006283}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006284#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006285
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006286#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006288static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6289 const char *label,
6290 const unsigned char *random, size_t rlen,
6291 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006292{
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6294 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006295}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006296#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006297
Jerry Yuf009d862022-02-17 14:01:37 +08006298/*
6299 * Set appropriate PRF function and other SSL / TLS1.2 functions
6300 *
6301 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006302 * - hash associated with the ciphersuite (only used by TLS 1.2)
6303 *
6304 * Outputs:
6305 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6306 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006308static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6309 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006310{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006311#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006313 handshake->tls_prf = tls_prf_sha384;
6314 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6315 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006317#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006318#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006319 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006320 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006321 handshake->tls_prf = tls_prf_sha256;
6322 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6323 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6324 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006325#else
Jerry Yuf009d862022-02-17 14:01:37 +08006326 {
Jerry Yuf009d862022-02-17 14:01:37 +08006327 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006328 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006330 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006331#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006334}
Jerry Yud6ab2352022-02-17 14:03:43 +08006335
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006336/*
6337 * Compute master secret if needed
6338 *
6339 * Parameters:
6340 * [in/out] handshake
6341 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6342 * (PSA-PSK) ciphersuite_info, psk_opaque
6343 * [out] premaster (cleared)
6344 * [out] master
6345 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6346 * debug: conf->f_dbg, conf->p_dbg
6347 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006348 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006349 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006350MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006351static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6352 unsigned char *master,
6353 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006354{
6355 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6356
6357 /* cf. RFC 5246, Section 8.1:
6358 * "The master secret is always exactly 48 bytes in length." */
6359 size_t const master_secret_len = 48;
6360
6361#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6362 unsigned char session_hash[48];
6363#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6364
6365 /* The label for the KDF used for key expansion.
6366 * This is either "master secret" or "extended master secret"
6367 * depending on whether the Extended Master Secret extension
6368 * is used. */
6369 char const *lbl = "master secret";
6370
Przemek Stekielae4ed302022-04-05 17:15:55 +02006371 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006372 * - If the Extended Master Secret extension is not used,
6373 * this is ClientHello.Random + ServerHello.Random
6374 * (see Sect. 8.1 in RFC 5246).
6375 * - If the Extended Master Secret extension is used,
6376 * this is the transcript of the handshake so far.
6377 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006378 unsigned char const *seed = handshake->randbytes;
6379 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380
6381#if !defined(MBEDTLS_DEBUG_C) && \
6382 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006383 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006384 ssl = NULL; /* make sure we don't use it except for those cases */
6385 (void) ssl;
6386#endif
6387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 if (handshake->resume != 0) {
6389 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6390 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006391 }
6392
6393#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006396 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006397 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6398 if (ret != 0) {
6399 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6400 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6403 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006405#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006406
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006407#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 /* Perform PSK-to-MS expansion in a single step. */
6410 psa_status_t status;
6411 psa_algorithm_t alg;
6412 mbedtls_svc_key_id_t psk;
6413 psa_key_derivation_operation_t derivation =
6414 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006415 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006427 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006431 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006432 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006433 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006434 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006435 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6436 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6437 other_secret = handshake->premaster + 2;
6438 break;
6439 default:
6440 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006441 }
6442
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 status = setup_psa_key_derivation(&derivation, psk, alg,
6444 ssl->conf->psk, ssl->conf->psk_len,
6445 seed, seed_len,
6446 (unsigned char const *) lbl,
6447 (size_t) strlen(lbl),
6448 other_secret, other_secret_len,
6449 master_secret_len);
6450 if (status != PSA_SUCCESS) {
6451 psa_key_derivation_abort(&derivation);
6452 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453 }
6454
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 status = psa_key_derivation_output_bytes(&derivation,
6456 master,
6457 master_secret_len);
6458 if (status != PSA_SUCCESS) {
6459 psa_key_derivation_abort(&derivation);
6460 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006461 }
6462
Gilles Peskine449bd832023-01-11 14:50:10 +01006463 status = psa_key_derivation_abort(&derivation);
6464 if (status != PSA_SUCCESS) {
6465 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6466 }
6467 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006468#endif
6469 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006470#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006472 psa_status_t status;
6473 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6474 psa_key_derivation_operation_t derivation =
6475 PSA_KEY_DERIVATION_OPERATION_INIT;
6476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006478
6479 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 status = psa_key_derivation_setup(&derivation, alg);
6482 if (status != PSA_SUCCESS) {
6483 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006484 }
6485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 status = psa_key_derivation_set_capacity(&derivation,
6487 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6488 if (status != PSA_SUCCESS) {
6489 psa_key_derivation_abort(&derivation);
6490 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491 }
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6494 &derivation);
6495 if (status != PSA_SUCCESS) {
6496 psa_key_derivation_abort(&derivation);
6497 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006498 }
6499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 status = psa_key_derivation_output_bytes(&derivation,
6501 handshake->premaster,
6502 handshake->pmslen);
6503 if (status != PSA_SUCCESS) {
6504 psa_key_derivation_abort(&derivation);
6505 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6506 }
6507
6508 status = psa_key_derivation_abort(&derivation);
6509 if (status != PSA_SUCCESS) {
6510 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006511 }
6512 }
6513#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6515 lbl, seed, seed_len,
6516 master,
6517 master_secret_len);
6518 if (ret != 0) {
6519 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6520 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006521 }
6522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6524 handshake->premaster,
6525 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 mbedtls_platform_zeroize(handshake->premaster,
6528 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006529 }
6530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006532}
6533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006535{
6536 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6537 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6538 ssl->handshake->ciphersuite_info;
6539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006541
6542 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006544 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 if (ret != 0) {
6546 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6547 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006548 }
6549
6550 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006551 ret = ssl_compute_master(ssl->handshake,
6552 ssl->session_negotiate->master,
6553 ssl);
6554 if (ret != 0) {
6555 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6556 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006557 }
6558
6559 /* Swap the client and server random values:
6560 * - MS derivation wanted client+server (RFC 5246 8.1)
6561 * - key derivation wants server+client (RFC 5246 6.3) */
6562 {
6563 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 memcpy(tmp, ssl->handshake->randbytes, 64);
6565 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6566 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6567 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006568 }
6569
6570 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6572 ssl->session_negotiate->ciphersuite,
6573 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006574#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006576#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 ssl->handshake->tls_prf,
6578 ssl->handshake->randbytes,
6579 ssl->tls_version,
6580 ssl->conf->endpoint,
6581 ssl);
6582 if (ret != 0) {
6583 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6584 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006585 }
6586
6587 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6589 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006590
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006592
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006594}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006597{
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006599#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006600 case MBEDTLS_SSL_HASH_SHA384:
6601 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6602 break;
6603#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006604#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006605 case MBEDTLS_SSL_HASH_SHA256:
6606 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6607 break;
6608#endif
6609 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006611 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006612#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006613 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006614 (void) ssl;
6615#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006617}
6618
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006619static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6620 const psa_hash_operation_t *hs_op,
6621 size_t buffer_size,
6622 unsigned char *hash,
6623 size_t *hlen)
6624{
6625 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006626 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006627
6628#if !defined(MBEDTLS_DEBUG_C)
6629 (void) ssl;
6630#endif
6631 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006632 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006633 if (status != PSA_SUCCESS) {
6634 goto exit;
6635 }
6636
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006637 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006638 if (status != PSA_SUCCESS) {
6639 goto exit;
6640 }
6641
6642 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6643 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6644
6645exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006646 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006647 return mbedtls_md_error_from_psa(status);
6648}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006649
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006650#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006651int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6652 unsigned char *hash,
6653 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006654{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006655 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6656 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006657}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006658#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006659
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006660#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006661int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6662 unsigned char *hash,
6663 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006664{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006665 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6666 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006667}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006668#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006669
Jerry Yuc2c673d2022-02-17 14:20:39 +08006670#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006671MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006672static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006673
6674#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006675int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006676{
6677 /* If renegotiation is not enforced, retransmit until we would reach max
6678 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006680 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6681 unsigned char doublings = 1;
6682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006684 ++doublings;
6685 ratio >>= 1;
6686 }
6687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 if (++ssl->renego_records_seen > doublings) {
6689 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6690 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006691 }
6692 }
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006695}
6696#endif
6697#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006698
Jerry Yud9526692022-02-17 14:23:47 +08006699/*
6700 * Handshake functions
6701 */
6702#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6703/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006704int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006705{
6706 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6707 ssl->handshake->ciphersuite_info;
6708
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6712 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006713 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006715 }
6716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6718 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006719}
6720
Gilles Peskine449bd832023-01-11 14:50:10 +01006721int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006722{
6723 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6724 ssl->handshake->ciphersuite_info;
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6729 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006730 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006732 }
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6735 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006736}
6737
6738#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6739/* Some certificate support -> implement write and parse */
6740
Gilles Peskine449bd832023-01-11 14:50:10 +01006741int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006742{
6743 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6744 size_t i, n;
6745 const mbedtls_x509_crt *crt;
6746 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6747 ssl->handshake->ciphersuite_info;
6748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6752 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006753 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006755 }
6756
6757#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6759 if (ssl->handshake->client_auth == 0) {
6760 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006761 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006763 }
6764 }
6765#endif /* MBEDTLS_SSL_CLI_C */
6766#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6768 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006769 /* Should never happen because we shouldn't have picked the
6770 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006772 }
6773 }
6774#endif
6775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006777
6778 /*
6779 * 0 . 0 handshake type
6780 * 1 . 3 handshake length
6781 * 4 . 6 length of all certs
6782 * 7 . 9 length of cert. 1
6783 * 10 . n-1 peer certificate
6784 * n . n+2 length of cert. 2
6785 * n+3 . ... upper level cert, etc.
6786 */
6787 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006791 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6793 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6794 " > %" MBEDTLS_PRINTF_SIZET,
6795 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6796 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006797 }
6798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6800 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6801 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006804 i += n; crt = crt->next;
6805 }
6806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6808 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6809 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006810
6811 ssl->out_msglen = i;
6812 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6813 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6814
6815 ssl->state++;
6816
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6819 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006820 }
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006825}
6826
6827#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6828
6829#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006831static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6832 unsigned char *crt_buf,
6833 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006834{
6835 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 if (peer_crt == NULL) {
6838 return -1;
6839 }
Jerry Yud9526692022-02-17 14:23:47 +08006840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 if (peer_crt->raw.len != crt_buf_len) {
6842 return -1;
6843 }
Jerry Yud9526692022-02-17 14:23:47 +08006844
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006846}
6847#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006848MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006849static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6850 unsigned char *crt_buf,
6851 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006852{
6853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6854 unsigned char const * const peer_cert_digest =
6855 ssl->session->peer_cert_digest;
6856 mbedtls_md_type_t const peer_cert_digest_type =
6857 ssl->session->peer_cert_digest_type;
6858 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006860 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6861 size_t digest_len;
6862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 if (peer_cert_digest == NULL || digest_info == NULL) {
6864 return -1;
6865 }
Jerry Yud9526692022-02-17 14:23:47 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 digest_len = mbedtls_md_get_size(digest_info);
6868 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6869 return -1;
6870 }
Jerry Yud9526692022-02-17 14:23:47 +08006871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6873 if (ret != 0) {
6874 return -1;
6875 }
Jerry Yud9526692022-02-17 14:23:47 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006878}
6879#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6880#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6881
6882/*
6883 * Once the certificate message is read, parse it into a cert chain and
6884 * perform basic checks, but leave actual verification to the caller
6885 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006886MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006887static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6888 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006889{
6890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6891#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006893#endif
6894 size_t i, n;
6895 uint8_t alert;
6896
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6898 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6899 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6900 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6901 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006902 }
6903
Gilles Peskine449bd832023-01-11 14:50:10 +01006904 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6905 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6906 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6907 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006908 }
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6911 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6912 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6913 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6914 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006915 }
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006918
6919 /*
6920 * Same message structure as in mbedtls_ssl_write_certificate()
6921 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006922 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 if (ssl->in_msg[i] != 0 ||
6925 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6926 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6927 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6928 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6929 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006930 }
6931
6932 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6933 i += 3;
6934
6935 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006937 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (i + 3 > ssl->in_hslen) {
6939 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6940 mbedtls_ssl_send_alert_message(ssl,
6941 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6942 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6943 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006944 }
6945 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6946 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006947 if (ssl->in_msg[i] != 0) {
6948 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6949 mbedtls_ssl_send_alert_message(ssl,
6950 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6951 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6952 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006953 }
6954
6955 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006956 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006957 i += 3;
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (n < 128 || i + n > ssl->in_hslen) {
6960 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6961 mbedtls_ssl_send_alert_message(ssl,
6962 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6963 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6964 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006965 }
6966
6967 /* Check if we're handling the first CRT in the chain. */
6968#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006970 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006972 /* During client-side renegotiation, check that the server's
6973 * end-CRTs hasn't changed compared to the initial handshake,
6974 * mitigating the triple handshake attack. On success, reuse
6975 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6977 if (ssl_check_peer_crt_unchanged(ssl,
6978 &ssl->in_msg[i],
6979 n) != 0) {
6980 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6981 mbedtls_ssl_send_alert_message(ssl,
6982 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6983 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6984 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006985 }
6986
6987 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006989 }
6990#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6991
6992 /* Parse the next certificate in the chain. */
6993#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006995#else
6996 /* If we don't need to store the CRT chain permanently, parse
6997 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006998 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006999#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007001 case 0: /*ok*/
7002 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7003 /* Ignore certificate with an unknown algorithm: maybe a
7004 prior certificate was already trusted. */
7005 break;
7006
7007 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7008 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7009 goto crt_parse_der_failed;
7010
7011 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7012 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7013 goto crt_parse_der_failed;
7014
7015 default:
7016 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007017crt_parse_der_failed:
7018 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7019 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7020 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007021 }
7022
7023 i += n;
7024 }
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7027 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007028}
7029
7030#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007031MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007032static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007033{
Gilles Peskine449bd832023-01-11 14:50:10 +01007034 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7035 return -1;
7036 }
Jerry Yud9526692022-02-17 14:23:47 +08007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007039 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7040 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007041 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7042 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7043 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007046}
7047#endif /* MBEDTLS_SSL_SRV_C */
7048
7049/* Check if a certificate message is expected.
7050 * Return either
7051 * - SSL_CERTIFICATE_EXPECTED, or
7052 * - SSL_CERTIFICATE_SKIP
7053 * indicating whether a Certificate message is expected or not.
7054 */
7055#define SSL_CERTIFICATE_EXPECTED 0
7056#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007057MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007058static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7059 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007060{
7061 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7062 ssl->handshake->ciphersuite_info;
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7065 return SSL_CERTIFICATE_SKIP;
7066 }
Jerry Yud9526692022-02-17 14:23:47 +08007067
7068#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007071 ssl->session_negotiate->verify_result =
7072 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007074 }
7075 }
7076#else
7077 ((void) authmode);
7078#endif /* MBEDTLS_SSL_SRV_C */
7079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007081}
7082
Jerry Yud9526692022-02-17 14:23:47 +08007083#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007084MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007085static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7086 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007087{
7088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7089 /* Remember digest of the peer's end-CRT. */
7090 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7092 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7093 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7094 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7095 mbedtls_ssl_send_alert_message(ssl,
7096 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7097 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007098
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007100 }
7101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 ret = mbedtls_md(mbedtls_md_info_from_type(
7103 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7104 start, len,
7105 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007106
7107 ssl->session_negotiate->peer_cert_digest_type =
7108 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7109 ssl->session_negotiate->peer_cert_digest_len =
7110 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007113}
7114
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007115MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007116static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7117 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007118{
7119 unsigned char *end = start + len;
7120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7121
7122 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007123 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7124 ret = mbedtls_pk_parse_subpubkey(&start, end,
7125 &ssl->handshake->peer_pubkey);
7126 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007127 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007129 }
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007132}
7133#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007136{
7137 int ret = 0;
7138 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007139 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007140#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7141 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7142 ? ssl->handshake->sni_authmode
7143 : ssl->conf->authmode;
7144#else
7145 const int authmode = ssl->conf->authmode;
7146#endif
7147 void *rs_ctx = NULL;
7148 mbedtls_x509_crt *chain = NULL;
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7153 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7154 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007155 goto exit;
7156 }
7157
7158#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 if (ssl->handshake->ecrs_enabled &&
7160 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007161 chain = ssl->handshake->ecrs_peer_cert;
7162 ssl->handshake->ecrs_peer_cert = NULL;
7163 goto crt_verify;
7164 }
7165#endif
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007168 /* mbedtls_ssl_read_record may have sent an alert already. We
7169 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007171 goto exit;
7172 }
7173
7174#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007176 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7177
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007179 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 }
Jerry Yud9526692022-02-17 14:23:47 +08007181
7182 goto exit;
7183 }
7184#endif /* MBEDTLS_SSL_SRV_C */
7185
7186 /* Clear existing peer CRT structure in case we tried to
7187 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7191 if (chain == NULL) {
7192 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7193 sizeof(mbedtls_x509_crt)));
7194 mbedtls_ssl_send_alert_message(ssl,
7195 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7196 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007197
7198 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7199 goto exit;
7200 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007202
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 ret = ssl_parse_certificate_chain(ssl, chain);
7204 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007205 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 }
Jerry Yud9526692022-02-17 14:23:47 +08007207
7208#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007209 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007210 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 }
Jerry Yud9526692022-02-17 14:23:47 +08007212
7213crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007215 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 }
Jerry Yud9526692022-02-17 14:23:47 +08007217#endif
7218
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007219 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7220 ssl->handshake->ciphersuite_info,
7221 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007223 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 }
Jerry Yud9526692022-02-17 14:23:47 +08007225
7226#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7227 {
7228 unsigned char *crt_start, *pk_start;
7229 size_t crt_len, pk_len;
7230
7231 /* We parse the CRT chain without copying, so
7232 * these pointers point into the input buffer,
7233 * and are hence still valid after freeing the
7234 * CRT chain. */
7235
7236 crt_start = chain->raw.p;
7237 crt_len = chain->raw.len;
7238
7239 pk_start = chain->pk_raw.p;
7240 pk_len = chain->pk_raw.len;
7241
7242 /* Free the CRT structures before computing
7243 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 mbedtls_x509_crt_free(chain);
7245 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007246 chain = NULL;
7247
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7249 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 }
Jerry Yud9526692022-02-17 14:23:47 +08007252
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7254 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007256 }
Jerry Yud9526692022-02-17 14:23:47 +08007257 }
7258#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7259 /* Pass ownership to session structure. */
7260 ssl->session_negotiate->peer_cert = chain;
7261 chain = NULL;
7262#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007265
7266exit:
7267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007269 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 }
Jerry Yud9526692022-02-17 14:23:47 +08007271
7272#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007274 ssl->handshake->ecrs_peer_cert = chain;
7275 chain = NULL;
7276 }
7277#endif
7278
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 if (chain != NULL) {
7280 mbedtls_x509_crt_free(chain);
7281 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007282 }
7283
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007285}
7286#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7287
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007288static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7289 unsigned char *padbuf, size_t hlen,
7290 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007291{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007292 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007293 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007294 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007295 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007296 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007297 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007298
7299 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007301 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007305 ? "client finished"
7306 : "server finished";
7307
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007308 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007309
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007310 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007312 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007313 }
7314
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007315 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007317 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007318 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007319 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007320
7321 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7322
Jerry Yu615bd6f2022-02-17 14:25:15 +08007323 /*
7324 * TLSv1.2:
7325 * hash = PRF( master, finished_label,
7326 * Hash( handshake ) )[0.11]
7327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007329 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007332
Paul Elliottecb95be2023-08-11 16:41:04 +01007333 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007334
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007335 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007336
7337exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007338 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007339 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007340}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007341
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007342#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007343static int ssl_calc_finished_tls_sha256(
7344 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7345{
7346 unsigned char padbuf[32];
7347 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007348 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007349 padbuf, sizeof(padbuf),
7350 buf, from);
7351}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007352#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007353
Jerry Yub7ba49e2022-02-17 14:25:53 +08007354
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007355#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007356static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007358{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007359 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007360 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007361 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007362 padbuf, sizeof(padbuf),
7363 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007364}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007365#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007366
Gilles Peskine449bd832023-01-11 14:50:10 +01007367void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007368{
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007370
7371 /*
7372 * Free our handshake params
7373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 mbedtls_ssl_handshake_free(ssl);
7375 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007376 ssl->handshake = NULL;
7377
7378 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007379 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (ssl->transform) {
7382 mbedtls_ssl_transform_free(ssl->transform);
7383 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007384 }
7385 ssl->transform = ssl->transform_negotiate;
7386 ssl->transform_negotiate = NULL;
7387
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007389}
7390
Gilles Peskine449bd832023-01-11 14:50:10 +01007391void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007392{
7393 int resume = ssl->handshake->resume;
7394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007396
7397#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007399 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7400 ssl->renego_records_seen = 0;
7401 }
7402#endif
7403
7404 /*
7405 * Free the previous session and switch in the current one
7406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007407 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007408#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7409 /* RFC 7366 3.1: keep the EtM state */
7410 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007412#endif
7413
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 mbedtls_ssl_session_free(ssl->session);
7415 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007416 }
7417 ssl->session = ssl->session_negotiate;
7418 ssl->session_negotiate = NULL;
7419
7420 /*
7421 * Add cache entry
7422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007424 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 resume == 0) {
7426 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7427 ssl->session->id,
7428 ssl->session->id_len,
7429 ssl->session) != 0) {
7430 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7431 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007432 }
7433
7434#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7436 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007437 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007439
7440 /* Keep last flight around in case we need to resend it:
7441 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7443 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007444#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007446
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007447 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007450}
7451
Gilles Peskine449bd832023-01-11 14:50:10 +01007452int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007453{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007454 int ret;
7455 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007460
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007461 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7462 if (ret != 0) {
7463 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7464 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007465
7466 /*
7467 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7468 * may define some other value. Currently (early 2016), no defined
7469 * ciphersuite does this (and this is unlikely to change as activity has
7470 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7471 */
7472 hash_len = 12;
7473
7474#if defined(MBEDTLS_SSL_RENEGOTIATION)
7475 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007477#endif
7478
7479 ssl->out_msglen = 4 + hash_len;
7480 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7481 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7482
7483 /*
7484 * In case of session resuming, invert the client and server
7485 * ChangeCipherSpec messages order.
7486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007488#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007490 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007492#endif
7493#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007495 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007497#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007499 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007501
7502 /*
7503 * Switch to our negotiated transform and session parameters for outbound
7504 * data.
7505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007507
7508#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007510 unsigned char i;
7511
7512 /* Remember current epoch settings for resending */
7513 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7515 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007516
7517 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007519
7520
7521 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 for (i = 2; i > 0; i--) {
7523 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007524 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 }
7526 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007527
7528 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 if (i == 0) {
7530 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7531 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007532 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007534#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007536
7537 ssl->transform_out = ssl->transform_negotiate;
7538 ssl->session_out = ssl->session_negotiate;
7539
7540#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7542 mbedtls_ssl_send_flight_completed(ssl);
7543 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007544#endif
7545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7547 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7548 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007549 }
7550
7551#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7553 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7554 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7555 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007556 }
7557#endif
7558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007562}
7563
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007564#define SSL_MAX_HASH_LEN 12
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007567{
7568 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7569 unsigned int hash_len = 12;
7570 unsigned char buf[SSL_MAX_HASH_LEN];
7571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007573
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007574 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7575 if (ret != 0) {
7576 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7577 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7580 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007581 goto exit;
7582 }
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7585 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7586 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7587 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007588 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7589 goto exit;
7590 }
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7593 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7594 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007595 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7596 goto exit;
7597 }
7598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7600 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7601 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7602 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007603 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7604 goto exit;
7605 }
7606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7608 buf, hash_len) != 0) {
7609 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7610 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7611 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007612 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7613 goto exit;
7614 }
7615
7616#if defined(MBEDTLS_SSL_RENEGOTIATION)
7617 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007619#endif
7620
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007622#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007624 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007626#endif
7627#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007629 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007631#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007633 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007635
7636#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7638 mbedtls_ssl_recv_flight_completed(ssl);
7639 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007640#endif
7641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007643
7644exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 mbedtls_platform_zeroize(buf, hash_len);
7646 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007647}
7648
Jerry Yu392112c2022-02-17 14:34:10 +08007649#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7650/*
7651 * Helper to get TLS 1.2 PRF from ciphersuite
7652 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7653 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007654static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007655{
Jerry Yu392112c2022-02-17 14:34:10 +08007656 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007658#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7660 return tls_prf_sha384;
7661 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007662#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007663#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007664 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7666 return tls_prf_sha256;
7667 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007668 }
7669#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007670#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007671 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007672 (void) ciphersuite_info;
7673#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007676}
7677#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007680{
7681 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007682#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 if (tls_prf == tls_prf_sha384) {
7684 return MBEDTLS_SSL_TLS_PRF_SHA384;
7685 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007686#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007687#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 if (tls_prf == tls_prf_sha256) {
7689 return MBEDTLS_SSL_TLS_PRF_SHA256;
7690 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007691#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007693}
7694
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007695/*
7696 * Populate a transform structure with session keys and all the other
7697 * necessary information.
7698 *
7699 * Parameters:
7700 * - [in/out]: transform: structure to populate
7701 * [in] must be just initialised with mbedtls_ssl_transform_init()
7702 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7703 * - [in] ciphersuite
7704 * - [in] master
7705 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007706 * - [in] tls_prf: pointer to PRF to use for key derivation
7707 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007708 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007709 * - [in] endpoint: client or server
7710 * - [in] ssl: used for:
7711 * - ssl->conf->{f,p}_export_keys
7712 * [in] optionally used for:
7713 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007716static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7717 int ciphersuite,
7718 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007719#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007721#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007722 ssl_tls_prf_t tls_prf,
7723 const unsigned char randbytes[64],
7724 mbedtls_ssl_protocol_version tls_version,
7725 unsigned endpoint,
7726 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007727{
7728 int ret = 0;
7729 unsigned char keyblk[256];
7730 unsigned char *key1;
7731 unsigned char *key2;
7732 unsigned char *mac_enc;
7733 unsigned char *mac_dec;
7734 size_t mac_key_len = 0;
7735 size_t iv_copy_len;
7736 size_t keylen;
7737 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007738 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007739
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007740 psa_key_type_t key_type;
7741 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7742 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007743 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007744 size_t key_bits;
7745 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007746
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007747 /*
7748 * Some data just needs copying into the structure
7749 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007750#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007751 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007752#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007753 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007754
7755#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007757#endif
7758
7759#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007761 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7762 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007764 }
7765#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7766
7767 /*
7768 * Get various info structures
7769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7771 if (ciphersuite_info == NULL) {
7772 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7773 ciphersuite));
7774 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007775 }
7776
Neil Armstrongab555e02022-04-04 11:07:59 +02007777 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007778#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007780#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007782
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007784 transform->taglen =
7785 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007787
Dave Rodgman2eab4622023-10-05 13:30:37 +01007788 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 transform->taglen,
7790 &alg,
7791 &key_type,
7792 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007793 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007795 goto end;
7796 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007797
Dave Rodgman2eab4622023-10-05 13:30:37 +01007798 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007800 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 (unsigned) ciphersuite_info->mac));
7802 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007803 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007804
7805#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7806 /* Copy own and peer's CID if the use of the CID
7807 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7809 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007810
7811 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7813 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7814 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007815
7816 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7818 ssl->handshake->peer_cid_len);
7819 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7820 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007821 }
7822#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7823
7824 /*
7825 * Compute key block using the PRF
7826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7828 if (ret != 0) {
7829 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7830 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007831 }
7832
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7834 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7835 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7836 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7837 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838
7839 /*
7840 * Determine the appropriate key, IV and MAC length.
7841 */
7842
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007843 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007844
Valerio Settie5707042023-10-11 11:54:42 +02007845#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007847 size_t explicit_ivlen;
7848
7849 transform->maclen = 0;
7850 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007851
7852 /* All modes haves 96-bit IVs, but the length of the static parts vary
7853 * with mode and version:
7854 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7855 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7856 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7857 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7858 * sequence number).
7859 */
7860 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007861
7862 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007864
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007868 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007870
7871 /* Minimum length of encrypted record */
7872 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7873 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 } else
Valerio Settie5707042023-10-11 11:54:42 +02007875#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007876#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007878 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007881
Neil Armstronge4512952022-03-08 09:08:22 +01007882 /* Get MAC length */
7883 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007884 transform->maclen = mac_key_len;
7885
7886 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007888
7889 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007893 /*
7894 * GenericBlockCipher:
7895 * 1. if EtM is in use: one block plus MAC
7896 * otherwise: * first multiple of blocklen greater than maclen
7897 * 2. IV
7898 */
7899#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007901 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 + block_size;
7903 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007904#endif
7905 {
7906 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 + block_size
7908 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909 }
7910
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007912 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 } else {
7914 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007915 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7916 goto end;
7917 }
7918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007920#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7921 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7923 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924 }
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7927 (unsigned) keylen,
7928 (unsigned) transform->minlen,
7929 (unsigned) transform->ivlen,
7930 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931
7932 /*
7933 * Finally setup the cipher contexts, IVs and MAC secrets.
7934 */
7935#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007937 key1 = keyblk + mac_key_len * 2;
7938 key2 = keyblk + mac_key_len * 2 + keylen;
7939
7940 mac_enc = keyblk;
7941 mac_dec = keyblk + mac_key_len;
7942
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 iv_copy_len = (transform->fixed_ivlen) ?
7944 transform->fixed_ivlen : transform->ivlen;
7945 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7946 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7947 iv_copy_len);
7948 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007949#endif /* MBEDTLS_SSL_CLI_C */
7950#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007952 key1 = keyblk + mac_key_len * 2 + keylen;
7953 key2 = keyblk + mac_key_len * 2;
7954
7955 mac_enc = keyblk + mac_key_len;
7956 mac_dec = keyblk;
7957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 iv_copy_len = (transform->fixed_ivlen) ?
7959 transform->fixed_ivlen : transform->ivlen;
7960 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7961 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7962 iv_copy_len);
7963 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007964#endif /* MBEDTLS_SSL_SRV_C */
7965 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007967 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7968 goto end;
7969 }
7970
Paul Elliott4fb19552023-10-18 12:15:30 +01007971 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 ssl->f_export_keys(ssl->p_export_keys,
7973 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7974 master, 48,
7975 randbytes + 32,
7976 randbytes,
7977 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007978 }
7979
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007980 transform->psa_alg = alg;
7981
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7983 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7984 psa_set_key_algorithm(&attributes, alg);
7985 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 if ((status = psa_import_key(&attributes,
7988 key1,
7989 PSA_BITS_TO_BYTES(key_bits),
7990 &transform->psa_key_enc)) != PSA_SUCCESS) {
7991 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007992 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007994 goto end;
7995 }
7996
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if ((status = psa_import_key(&attributes,
8000 key2,
8001 PSA_BITS_TO_BYTES(key_bits),
8002 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008003 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005 goto end;
8006 }
8007 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008008
Neil Armstrong29c0c042022-03-17 17:47:28 +01008009#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8010 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8011 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008014
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8016 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8017 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if ((status = psa_import_key(&attributes,
8020 mac_enc, mac_key_len,
8021 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008022 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008024 goto end;
8025 }
8026
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8028 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008029#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008031#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008033 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8035 PSA_KEY_USAGE_VERIFY_HASH);
8036 } else {
8037 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8038 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 if ((status = psa_import_key(&attributes,
8041 mac_dec, mac_key_len,
8042 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008043 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008045 goto end;
8046 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008047 }
8048#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8049
8050 ((void) mac_dec);
8051 ((void) mac_enc);
8052
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008053end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8055 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008056}
8057
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008058#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008059int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 psa_pake_operation_t *pake_ctx,
8061 const unsigned char *buf,
8062 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008063{
8064 psa_status_t status;
8065 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008066 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008067 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8068 * At round two perform a single cycle
8069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 for (; remaining_steps > 0; remaining_steps--) {
8073 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008074 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008076 /* Length is stored at the first byte */
8077 size_t length = buf[input_offset];
8078 input_offset += 1;
8079
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008081 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8082 }
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 status = psa_pake_input(pake_ctx, step,
8085 buf + input_offset, length);
8086 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008087 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008088 }
8089
8090 input_offset += length;
8091 }
8092 }
8093
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008095 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008099}
8100
Valerio Setti6b3dab02022-11-17 17:14:54 +01008101int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 psa_pake_operation_t *pake_ctx,
8103 unsigned char *buf,
8104 size_t len, size_t *olen,
8105 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008106{
8107 psa_status_t status;
8108 size_t output_offset = 0;
8109 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008110 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008111 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8112 * At round two perform a single cycle
8113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008115
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 for (; remaining_steps > 0; remaining_steps--) {
8117 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8118 step <= PSA_PAKE_STEP_ZK_PROOF;
8119 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008120 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008121 * For each step, prepend 1 byte with the length of the data as
8122 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008123 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 status = psa_pake_output(pake_ctx, step,
8125 buf + output_offset + 1,
8126 len - output_offset - 1,
8127 &output_len);
8128 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008129 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008130 }
8131
Valerio Setti99d88c12022-11-22 16:03:43 +01008132 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008133
8134 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008135 }
8136 }
8137
8138 *olen = output_offset;
8139
Gilles Peskine449bd832023-01-11 14:50:10 +01008140 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008141}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008142#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008143
Gilles Peskine449bd832023-01-11 14:50:10 +01008144int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8145 unsigned char *hash, size_t *hashlen,
8146 unsigned char *data, size_t data_len,
8147 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008148{
8149 psa_status_t status;
8150 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008151 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008152
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008154
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 if ((status = psa_hash_setup(&hash_operation,
8156 hash_alg)) != PSA_SUCCESS) {
8157 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008158 goto exit;
8159 }
8160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8162 64)) != PSA_SUCCESS) {
8163 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008164 goto exit;
8165 }
8166
Gilles Peskine449bd832023-01-11 14:50:10 +01008167 if ((status = psa_hash_update(&hash_operation,
8168 data, data_len)) != PSA_SUCCESS) {
8169 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008170 goto exit;
8171 }
8172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8174 hashlen)) != PSA_SUCCESS) {
8175 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8176 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008177 }
8178
8179exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 if (status != PSA_SUCCESS) {
8181 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8182 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8183 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008184 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008186 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8187 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008189 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008191 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008193 }
8194 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008196}
8197
Jerry Yuee40f9d2022-02-17 14:55:16 +08008198
Jerry Yud9d91da2022-02-17 14:57:06 +08008199#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8200
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008201/* Find the preferred hash for a given signature algorithm. */
8202unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 mbedtls_ssl_context *ssl,
8204 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008205{
Gabor Mezei078e8032022-04-27 21:17:56 +02008206 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008207 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008208
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8210 return MBEDTLS_SSL_HASH_NONE;
8211 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008212
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008214 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8216 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008217 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8219 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008220
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008221 mbedtls_md_type_t md_alg =
8222 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8223 if (md_alg == MBEDTLS_MD_NONE) {
8224 continue;
8225 }
8226
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008229 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008230 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008231
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8233 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8234 PSA_ALG_ECDSA(psa_hash_alg),
8235 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008236 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008238
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8240 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8241 PSA_ALG_RSA_PKCS1V15_SIGN(
8242 psa_hash_alg),
8243 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008244 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008246 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008247
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008249 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008250 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008251
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008253}
8254
8255#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8256
Jerry Yudc7bd172022-02-17 13:44:15 +08008257#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8258
XiaokangQian75d40ef2022-04-20 11:05:24 +00008259int mbedtls_ssl_validate_ciphersuite(
8260 const mbedtls_ssl_context *ssl,
8261 const mbedtls_ssl_ciphersuite_t *suite_info,
8262 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008264{
8265 (void) ssl;
8266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 if (suite_info == NULL) {
8268 return -1;
8269 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008270
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 if ((suite_info->min_tls_version > max_tls_version) ||
8272 (suite_info->max_tls_version < min_tls_version)) {
8273 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008274 }
8275
XiaokangQian060d8672022-04-21 09:24:56 +00008276#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008277#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008279 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008281 }
8282#endif
8283
8284 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8285#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8287 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8288 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008289 }
8290#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8291#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8292
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008294}
8295
Ronald Crone68ab4f2022-10-05 12:46:29 +02008296#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008297/*
8298 * Function for writing a signature algorithm extension.
8299 *
8300 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8301 * value (TLS 1.3 RFC8446):
8302 * enum {
8303 * ....
8304 * ecdsa_secp256r1_sha256( 0x0403 ),
8305 * ecdsa_secp384r1_sha384( 0x0503 ),
8306 * ecdsa_secp521r1_sha512( 0x0603 ),
8307 * ....
8308 * } SignatureScheme;
8309 *
8310 * struct {
8311 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8312 * } SignatureSchemeList;
8313 *
8314 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8315 * value (TLS 1.2 RFC5246):
8316 * enum {
8317 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8318 * sha512(6), (255)
8319 * } HashAlgorithm;
8320 *
8321 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8322 * SignatureAlgorithm;
8323 *
8324 * struct {
8325 * HashAlgorithm hash;
8326 * SignatureAlgorithm signature;
8327 * } SignatureAndHashAlgorithm;
8328 *
8329 * SignatureAndHashAlgorithm
8330 * supported_signature_algorithms<2..2^16-2>;
8331 *
8332 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8333 * generalization of the TLS 1.2 signature algorithm extension.
8334 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8335 * `SignatureScheme` field of TLS 1.3
8336 *
8337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008338int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8339 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008340{
8341 unsigned char *p = buf;
8342 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8343 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8344
8345 *out_len = 0;
8346
Gilles Peskine449bd832023-01-11 14:50:10 +01008347 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008348
8349 /* Check if we have space for header and length field:
8350 * - extension_type (2 bytes)
8351 * - extension_data_length (2 bytes)
8352 * - supported_signature_algorithms_length (2 bytes)
8353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008355 p += 6;
8356
8357 /*
8358 * Write supported_signature_algorithms
8359 */
8360 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008361 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8362 if (sig_alg == NULL) {
8363 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8364 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008365
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8367 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8368 *sig_alg,
8369 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8370 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008371 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 }
8373 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8374 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008375 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8377 *sig_alg,
8378 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008379 }
8380
8381 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008382 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008383 if (supported_sig_alg_len == 0) {
8384 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8385 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008386 }
8387
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8389 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8390 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008391
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008392 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008393
8394#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008396#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008397
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008399}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008400#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008401
XiaokangQian40a35232022-05-07 09:02:40 +00008402#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008403/*
8404 * mbedtls_ssl_parse_server_name_ext
8405 *
8406 * Structure of server_name extension:
8407 *
8408 * enum {
8409 * host_name(0), (255)
8410 * } NameType;
8411 * opaque HostName<1..2^16-1>;
8412 *
8413 * struct {
8414 * NameType name_type;
8415 * select (name_type) {
8416 * case host_name: HostName;
8417 * } name;
8418 * } ServerName;
8419 * struct {
8420 * ServerName server_name_list<1..2^16-1>
8421 * } ServerNameList;
8422 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008423MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008424int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8425 const unsigned char *buf,
8426 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008427{
8428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8429 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008430 size_t server_name_list_len, hostname_len;
8431 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008432
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008434
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8436 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008437 p += 2;
8438
Gilles Peskine449bd832023-01-11 14:50:10 +01008439 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008440 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008441 while (p < server_name_list_end) {
8442 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8443 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8444 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8445 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008446
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008448 /* sni_name is intended to be used only during the parsing of the
8449 * ClientHello message (it is reset to NULL before the end of
8450 * the message parsing). Thus it is ok to just point to the
8451 * reception buffer and not make a copy of it.
8452 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008453 ssl->handshake->sni_name = p + 3;
8454 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 if (ssl->conf->f_sni == NULL) {
8456 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008457 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8459 ssl, p + 3, hostname_len);
8460 if (ret != 0) {
8461 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8462 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8463 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8464 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8465 }
8466 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008467 }
8468
8469 p += hostname_len + 3;
8470 }
8471
Gilles Peskine449bd832023-01-11 14:50:10 +01008472 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008473}
8474#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8475
XiaokangQianacb39922022-06-17 10:18:48 +00008476#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008477MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008478int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8479 const unsigned char *buf,
8480 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008481{
8482 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008483 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008484 const unsigned char *protocol_name_list;
8485 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008486 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008487
8488 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008489 if (ssl->conf->alpn_list == NULL) {
8490 return 0;
8491 }
XiaokangQianacb39922022-06-17 10:18:48 +00008492
8493 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008494 * RFC7301, section 3.1
8495 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008496 *
XiaokangQianc7403452022-06-23 03:24:12 +00008497 * struct {
8498 * ProtocolName protocol_name_list<2..2^16-1>
8499 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008500 */
8501
XiaokangQianc7403452022-06-23 03:24:12 +00008502 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008503 * protocol_name_list_len 2 bytes
8504 * protocol_name_len 1 bytes
8505 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008508
Gilles Peskine449bd832023-01-11 14:50:10 +01008509 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008510 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008512 protocol_name_list = p;
8513 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008514
8515 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008517 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008518 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8519 protocol_name_len);
8520 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008521 MBEDTLS_SSL_PEND_FATAL_ALERT(
8522 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8524 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008525 }
8526
8527 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008528 }
8529
8530 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8532 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008533 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008535 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 if (protocol_name_len == alpn_len &&
8537 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008538 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008540 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008541
8542 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008543 }
8544 }
8545
XiaokangQian95d5f542022-06-24 02:29:26 +00008546 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008547 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008548 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8549 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8550 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008551}
8552
Gilles Peskine449bd832023-01-11 14:50:10 +01008553int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8554 unsigned char *buf,
8555 unsigned char *end,
8556 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008557{
8558 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008559 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008560 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 if (ssl->alpn_chosen == NULL) {
8563 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008564 }
8565
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 protocol_name_len = strlen(ssl->alpn_chosen);
8567 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008570 /*
8571 * 0 . 1 ext identifier
8572 * 2 . 3 ext length
8573 * 4 . 5 protocol list length
8574 * 6 . 6 protocol name length
8575 * 7 . 7+n protocol name
8576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008578
XiaokangQian95d5f542022-06-24 02:29:26 +00008579 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8582 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008583 /* Note: the length of the chosen protocol has been checked to be less
8584 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008589
8590#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008592#endif
8593
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008595}
8596#endif /* MBEDTLS_SSL_ALPN */
8597
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008598#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008599 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008600 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008601 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008602int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8603 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008604{
8605 /* Initialize to suppress unnecessary compiler warning */
8606 size_t hostname_len = 0;
8607
8608 /* Check if new hostname is valid before
8609 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 if (hostname != NULL) {
8611 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008612
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8615 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008616 }
8617
8618 /* Now it's clear that we will overwrite the old hostname,
8619 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008621 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008623 }
8624
8625 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008627 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 } else {
8629 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8630 if (session->hostname == NULL) {
8631 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8632 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008633
Gilles Peskine449bd832023-01-11 14:50:10 +01008634 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008635 }
8636
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008638}
Xiaokang Qian03409292022-10-12 02:49:52 +00008639#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8640 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008641 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008642 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008643
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008644#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8645 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008646int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8647 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008648{
8649 size_t alpn_len = 0;
8650
8651 if (alpn != NULL) {
8652 alpn_len = strlen(alpn);
8653
8654 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8656 }
8657 }
8658
8659 if (session->ticket_alpn != NULL) {
8660 mbedtls_zeroize_and_free(session->ticket_alpn,
8661 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008662 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008663 }
8664
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008665 if (alpn != NULL) {
8666 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008667 if (session->ticket_alpn == NULL) {
8668 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8669 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008670 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008671 }
8672
8673 return 0;
8674}
8675#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008676
8677/*
8678 * The following functions are used by 1.2 and 1.3, client and server.
8679 */
8680#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8681int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8682 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8683 int recv_endpoint,
8684 mbedtls_ssl_protocol_version tls_version,
8685 uint32_t *flags)
8686{
8687 int ret = 0;
8688 unsigned int usage = 0;
8689 const char *ext_oid;
8690 size_t ext_len;
8691
8692 /*
8693 * keyUsage
8694 */
8695
8696 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8697 * to check what a compliant client will think while choosing which cert
8698 * to send to the client. */
8699#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8700 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8701 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8702 /* TLS 1.2 server part of the key exchange */
8703 switch (ciphersuite->key_exchange) {
8704 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008705 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
8706 break;
8707
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008708 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8709 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8710 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8711 break;
8712
8713 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8714 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8715 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8716 break;
8717
8718 /* Don't use default: we want warnings when adding new values */
8719 case MBEDTLS_KEY_EXCHANGE_NONE:
8720 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008721 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8722 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8723 usage = 0;
8724 }
8725 } else
8726#endif
8727 {
8728 /* This is either TLS 1.3 authentication, which always uses signatures,
8729 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8730 * options we implement, both using signatures. */
8731 (void) tls_version;
8732 (void) ciphersuite;
8733 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8734 }
8735
8736 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8737 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8738 ret = -1;
8739 }
8740
8741 /*
8742 * extKeyUsage
8743 */
8744
8745 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8746 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8747 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8748 } else {
8749 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8750 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8751 }
8752
8753 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8754 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8755 ret = -1;
8756 }
8757
8758 return ret;
8759}
8760
8761int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8762 int authmode,
8763 mbedtls_x509_crt *chain,
8764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8765 void *rs_ctx)
8766{
8767 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8768 return 0;
8769 }
8770
8771 /*
8772 * Primary check: use the appropriate X.509 verification function
8773 */
8774 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8775 void *p_vrfy;
8776 if (ssl->f_vrfy != NULL) {
8777 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8778 f_vrfy = ssl->f_vrfy;
8779 p_vrfy = ssl->p_vrfy;
8780 } else {
8781 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8782 f_vrfy = ssl->conf->f_vrfy;
8783 p_vrfy = ssl->conf->p_vrfy;
8784 }
8785
8786 int ret = 0;
8787 int have_ca_chain_or_callback = 0;
8788#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8789 if (ssl->conf->f_ca_cb != NULL) {
8790 ((void) rs_ctx);
8791 have_ca_chain_or_callback = 1;
8792
8793 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8794 ret = mbedtls_x509_crt_verify_with_ca_cb(
8795 chain,
8796 ssl->conf->f_ca_cb,
8797 ssl->conf->p_ca_cb,
8798 ssl->conf->cert_profile,
8799 ssl->hostname,
8800 &ssl->session_negotiate->verify_result,
8801 f_vrfy, p_vrfy);
8802 } else
8803#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8804 {
8805 mbedtls_x509_crt *ca_chain;
8806 mbedtls_x509_crl *ca_crl;
8807#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8808 if (ssl->handshake->sni_ca_chain != NULL) {
8809 ca_chain = ssl->handshake->sni_ca_chain;
8810 ca_crl = ssl->handshake->sni_ca_crl;
8811 } else
8812#endif
8813 {
8814 ca_chain = ssl->conf->ca_chain;
8815 ca_crl = ssl->conf->ca_crl;
8816 }
8817
8818 if (ca_chain != NULL) {
8819 have_ca_chain_or_callback = 1;
8820 }
8821
8822 ret = mbedtls_x509_crt_verify_restartable(
8823 chain,
8824 ca_chain, ca_crl,
8825 ssl->conf->cert_profile,
8826 ssl->hostname,
8827 &ssl->session_negotiate->verify_result,
8828 f_vrfy, p_vrfy, rs_ctx);
8829 }
8830
8831 if (ret != 0) {
8832 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8833 }
8834
8835#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8836 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8837 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8838 }
8839#endif
8840
8841 /*
8842 * Secondary checks: always done, but change 'ret' only if it was 0
8843 */
8844
8845 /* With TLS 1.2 and ECC certs, check that the curve used by the
8846 * certificate is on our list of acceptable curves.
8847 *
8848 * With TLS 1.3 this is not needed because the curve is part of the
8849 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8850 * we validate the signature made with the key associated to this cert.
8851 */
8852#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8853 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8854 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8855 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8856 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8857 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8858 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8859 if (ret == 0) {
8860 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8861 }
8862 }
8863 }
8864#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8865
8866 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8867 if (mbedtls_ssl_check_cert_usage(chain,
8868 ciphersuite_info,
8869 ssl->conf->endpoint,
8870 ssl->tls_version,
8871 &ssl->session_negotiate->verify_result) != 0) {
8872 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8873 if (ret == 0) {
8874 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8875 }
8876 }
8877
8878 /* With authmode optional, we want to keep going if the certificate was
8879 * unacceptable, but still fail on other errors (out of memory etc),
8880 * including fatal errors from the f_vrfy callback.
8881 *
8882 * The only acceptable errors are:
8883 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8884 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8885 * Anything else is a fatal error. */
8886 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8887 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8888 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8889 ret = 0;
8890 }
8891
8892 /* Return a specific error as this is a user error: inconsistent
8893 * configuration - can't verify without trust anchors. */
8894 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8895 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8896 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8897 }
8898
8899 if (ret != 0) {
8900 uint8_t alert;
8901
8902 /* The certificate may have been rejected for several reasons.
8903 Pick one and send the corresponding alert. Which alert to send
8904 may be a subject of debate in some cases. */
8905 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8906 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8907 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8908 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8909 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8910 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8911 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8912 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8913 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8914 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8915 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8916 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8917 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8918 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8919 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8920 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8921 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8922 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8923 } else {
8924 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8925 }
8926 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8927 alert);
8928 }
8929
8930#if defined(MBEDTLS_DEBUG_C)
8931 if (ssl->session_negotiate->verify_result != 0) {
8932 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8933 (unsigned int) ssl->session_negotiate->verify_result));
8934 } else {
8935 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8936 }
8937#endif /* MBEDTLS_DEBUG_C */
8938
8939 return ret;
8940}
8941#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008943#endif /* MBEDTLS_SSL_TLS_C */