blob: 7eb181e373739a04025ec8faaca23de789f68f5e [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;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200343 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;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000348 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ssl->in_buf_len < in_buf_new_len) {
352 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
353 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
354 } else {
355 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 written_out = ssl->out_msg - ssl->out_buf;
364 iv_offset_out = ssl->out_iv - ssl->out_buf;
365 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 ssl->out_buf_len < out_buf_new_len) {
369 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
370 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
371 } else {
372 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
373 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200374 modified = 1;
375 }
376 }
377 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000380 ssl->in_hdr = ssl->in_buf + hdr_in;
381 mbedtls_ssl_update_in_pointers(ssl);
382 mbedtls_ssl_reset_out_pointers(ssl);
383
Andrzej Kurek4a063792020-10-21 15:08:44 +0200384 /* Fields below might not be properly updated with record
385 * splitting or with CID, so they are manually updated here. */
386 ssl->out_msg = ssl->out_buf + written_out;
387 ssl->out_len = ssl->out_buf + len_offset_out;
388 ssl->out_iv = ssl->out_buf + iv_offset_out;
389
390 ssl->in_msg = ssl->in_buf + written_in;
391 ssl->in_len = ssl->in_buf + len_offset_in;
392 ssl->in_iv = ssl->in_buf + iv_offset_in;
393 }
394}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500395#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
396
Jerry Yudb8c48a2022-01-27 14:54:54 +0800397#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800398
399#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100400typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
401 const char *label,
402 const unsigned char *random, size_t rlen,
403 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800406
407#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
408
409/* Type for the TLS PRF */
410typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
411 const unsigned char *, size_t,
412 unsigned char *, size_t);
413
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
416 int ciphersuite,
417 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 ssl_tls_prf_t tls_prf,
422 const unsigned char randbytes[64],
423 mbedtls_ssl_protocol_version tls_version,
424 unsigned endpoint,
425 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800426
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100427#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300430 const char *label,
431 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100433static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
434static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100436#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100437
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100438#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100439MBEDTLS_CHECK_RETURN_CRITICAL
440static int tls_prf_sha384(const unsigned char *secret, size_t slen,
441 const char *label,
442 const unsigned char *random, size_t rlen,
443 unsigned char *dstbuf, size_t dlen);
444
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100445static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
446static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100447#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449MBEDTLS_CHECK_RETURN_CRITICAL
450static int ssl_tls12_session_load(mbedtls_ssl_session *session,
451 const unsigned char *buf,
452 size_t len);
453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
454
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100455static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100457#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100459#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100461#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100462static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100463#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100464
465int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
466 const unsigned char *secret, size_t slen,
467 const char *label,
468 const unsigned char *random, size_t rlen,
469 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470{
471 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300476 case MBEDTLS_SSL_TLS_PRF_SHA384:
477 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100479#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481 case MBEDTLS_SSL_TLS_PRF_SHA256:
482 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100484#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300485#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 default:
487 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300488 }
489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300491}
492
Jerry Yuc73c6182022-02-08 20:29:25 +0800493#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100494static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800495{
496#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (session->peer_cert != NULL) {
498 mbedtls_x509_crt_free(session->peer_cert);
499 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800504 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800515{
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800517 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800519
520 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800522
523 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800525
526 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800528
529 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800531
532 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800534
535 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800537
538 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800540
541 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800543
544 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800546
547 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800549
550 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800552
553 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800555
556 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800558
559 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800561
562 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800564
565 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800567
568 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800570
571 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800573
574 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800576
577 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800579
580 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800582
583 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800585
586 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800588
589 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800591
592 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800594
Jan Bruckner151f6422023-02-10 12:45:19 +0100595 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
596 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
597
Jerry Yu7a485c12022-10-31 13:08:18 +0800598 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600
601 }
602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800604}
605
Gilles Peskine449bd832023-01-11 14:50:10 +0100606uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800609}
610
Jerry Yud25cab02022-10-31 12:48:30 +0800611#if defined(MBEDTLS_DEBUG_C)
612static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800613 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800614 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
615 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
616 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
618 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
619 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
620 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
621 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
622 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
623 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
624 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
626 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
627 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
628 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
629 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
630 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
631 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
632 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
633 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
634 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
635 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
636 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
637 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
638 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
639 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100640 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
641 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800642};
643
Chien Wong4e9683e2023-12-28 17:07:43 +0800644static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800645 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
646 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
647 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
648 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
650 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
651 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
652 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
653 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
654 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
655 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
656 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
658 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
659 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
660 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
661 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
662 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
663 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
664 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
665 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
666 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
667 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
668 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
669 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
670 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
671 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100672 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
673 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800674};
675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800677{
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return extension_name_table[
679 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800680}
681
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800683{
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800701}
702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
704 int level, const char *file, int line,
705 int hs_msg_type, unsigned int extension_type,
706 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800707{
708 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800710 mbedtls_debug_print_msg(
711 ssl, level, file, line,
712 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800715 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800717 return;
718 }
719
720 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800722 mbedtls_debug_print_msg(
723 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
725 mbedtls_ssl_get_extension_name(extension_type), extension_type,
726 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800727 return;
728 }
729
730 mbedtls_debug_print_msg(
731 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
733 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800734}
735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
737 int level, const char *file, int line,
738 int hs_msg_type, uint32_t extensions_mask,
739 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800740{
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 for (unsigned i = 0;
743 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
744 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800745 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800746 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800748 }
749}
750
Pengyu Lvee455c02023-01-12 14:37:24 +0800751#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800752static const char *ticket_flag_name_table[] =
753{
754 [0] = "ALLOW_PSK_RESUMPTION",
755 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
756 [3] = "ALLOW_EARLY_DATA",
757};
758
Pengyu Lv4938a562023-01-16 11:28:49 +0800759void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
760 int level, const char *file, int line,
761 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762{
763 size_t i;
764
765 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800766 "print ticket_flags (0x%02x)", flags);
767
768 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800769
770 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800771 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800772 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
773 ticket_flag_name_table[i]);
774 }
775 }
776}
777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
778
Jerry Yud25cab02022-10-31 12:48:30 +0800779#endif /* MBEDTLS_DEBUG_C */
780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800783{
784 ((void) ciphersuite_info);
785
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100786#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800790#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100791#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800793 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800795#endif
796 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 return;
799 }
800}
801
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100802int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100803 unsigned hs_type,
804 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805{
806 unsigned char hs_hdr[4];
807
808 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
810 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
811 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
812 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815}
816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100818 unsigned hs_type,
819 unsigned char const *msg,
820 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100821{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100822 int ret;
823 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100828}
829
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100830int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800831{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100832#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100833 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100835#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800836 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100837#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100838#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100839 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
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 }
843 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
844 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200845 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100846 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800847#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100848#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
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 }
853 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
854 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200855 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100856 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100858 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800859}
860
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100861static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100862 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800863{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100864#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100865 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100866 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100867#else /* SHA-256 or SHA-384 */
868 ((void) ssl);
869 (void) buf;
870 (void) len;
871#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100872#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100873 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
874 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200875 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100876 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800877#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100878#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100879 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
880 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200881 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100882 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800883#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800885}
886
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100887#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100888static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100889 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800890{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200891 return mbedtls_md_error_from_psa(psa_hash_update(
892 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894#endif
895
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100896#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100897static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100898 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200900 return mbedtls_md_error_from_psa(psa_hash_update(
901 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800902}
903#endif
904
Gilles Peskine449bd832023-01-11 14:50:10 +0100905static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200906{
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200908
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100909#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100912#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500913 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500914#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200915
916 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100917
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200918#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200919 handshake->psa_pake_ctx = psa_pake_operation_init();
920 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200921#if defined(MBEDTLS_SSL_CLI_C)
922 handshake->ecjpake_cache = NULL;
923 handshake->ecjpake_cache_len = 0;
924#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200925#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200926
Gilles Peskineeccd8882020-03-10 12:19:08 +0100927#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200929#endif
930
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200931#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
932 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
933#endif
Hanno Becker75173122019-02-06 16:18:31 +0000934
935#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
936 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000938#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200939}
940
Gilles Peskine449bd832023-01-11 14:50:10 +0100941void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200942{
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200944
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100945 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
946 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100947
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000948#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100949 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
950 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100951#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200952}
953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200955{
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200957}
958
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100960static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000961{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
963
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200964 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 if (ssl->transform_negotiate) {
967 mbedtls_ssl_transform_free(ssl->transform_negotiate);
968 }
Jerry Yu2e199812022-12-01 18:57:19 +0800969#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 if (ssl->session_negotiate) {
971 mbedtls_ssl_session_free(ssl->session_negotiate);
972 }
973 if (ssl->handshake) {
974 mbedtls_ssl_handshake_free(ssl);
975 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976
Jerry Yu2e199812022-12-01 18:57:19 +0800977#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978 /*
979 * Either the pointers are now NULL or cleared properly and can be freed.
980 * Now allocate missing structures.
981 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 if (ssl->transform_negotiate == NULL) {
983 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200984 }
Jerry Yu2e199812022-12-01 18:57:19 +0800985#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000986
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if (ssl->session_negotiate == NULL) {
988 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200989 }
Paul Bakker48916f92012-09-16 19:57:18 +0000990
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 if (ssl->handshake == NULL) {
992 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200993 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500994#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
995 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
998 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500999#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001000
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001001 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001003#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001004 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001005#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 ssl->session_negotiate == NULL) {
1007 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001008
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001010 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001011
1012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001014 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001015#endif
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018 ssl->session_negotiate = NULL;
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001021 }
1022
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001023#if defined(MBEDTLS_SSL_EARLY_DATA)
1024#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001025 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001026#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001027#if defined(MBEDTLS_SSL_SRV_C)
1028 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1029#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001030 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001031#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001032
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001033 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 mbedtls_ssl_session_init(ssl->session_negotiate);
1035 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001036
Jerry Yu2e199812022-12-01 18:57:19 +08001037#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001039#endif
1040
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001041 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001042 ret = mbedtls_ssl_reset_checksum(ssl);
1043 if (ret != 0) {
1044 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1045 return ret;
1046 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001047
Jerry Yud0766ec2022-09-22 10:46:57 +08001048#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1049 defined(MBEDTLS_SSL_SRV_C) && \
1050 defined(MBEDTLS_SSL_SESSION_TICKETS)
1051 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001053#endif
1054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001057 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001058
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001060 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001062 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001066 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001067#endif
1068
Ronald Crone68ab4f2022-10-05 12:46:29 +02001069#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001070#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001071#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001072 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1073 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1075 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001076 const int *md;
1077 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001078 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001079 uint16_t *p;
1080
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001081 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1082 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1083 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1086 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001087 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001089#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001091#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001092
Jerry Yub476a442022-01-21 18:14:45 +08001093#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001095#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1097 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1098 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001099 }
1100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1102 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1103 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1106 sizeof(uint16_t));
1107 if (ssl->handshake->sig_algs == NULL) {
1108 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1109 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 p = (uint16_t *) ssl->handshake->sig_algs;
1112 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1113 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1114 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001115 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001117#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001119 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001120#endif
1121#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001123 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001124#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001125 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001126 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001127 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001131 ssl->handshake->sig_algs_heap_allocated = 0;
1132 }
Jerry Yucc539102022-06-27 16:27:35 +08001133#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001134#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001136}
1137
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001138#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001139/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001141static int ssl_cookie_write_dummy(void *ctx,
1142 unsigned char **p, unsigned char *end,
1143 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001144{
1145 ((void) ctx);
1146 ((void) p);
1147 ((void) end);
1148 ((void) cli_id);
1149 ((void) cli_id_len);
1150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001152}
1153
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001154MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001155static int ssl_cookie_check_dummy(void *ctx,
1156 const unsigned char *cookie, size_t cookie_len,
1157 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001158{
1159 ((void) ctx);
1160 ((void) cookie);
1161 ((void) cookie_len);
1162 ((void) cli_id);
1163 ((void) cli_id_len);
1164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001166}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001167#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001168
Paul Bakker5121ce52009-01-03 21:22:43 +00001169/*
1170 * Initialize an SSL context
1171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001172void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001173{
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001175}
1176
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001177MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001178static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001179{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001180 const mbedtls_ssl_config *conf = ssl->conf;
1181
Ronald Cron6f135e12021-12-08 16:57:54 +01001182#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1184 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1185 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1186 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001187 }
1188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1190 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001191 }
1192#endif
1193
1194#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1196 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1197 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001198 }
1199#endif
1200
Ronald Cron6f135e12021-12-08 16:57:54 +01001201#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1203 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1204 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1205 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001206 }
1207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1209 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001210 }
1211#endif
1212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1214 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001215}
1216
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001217MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001218static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1219{
1220 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ret = ssl_conf_version_check(ssl);
1222 if (ret != 0) {
1223 return ret;
1224 }
Jerry Yu60835a82021-08-04 10:13:52 +08001225
Yanray Wangb422cab2023-12-01 16:18:10 +08001226 if (ssl->conf->f_rng == NULL) {
1227 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1228 return MBEDTLS_ERR_SSL_NO_RNG;
1229 }
1230
Jerry Yu60835a82021-08-04 10:13:52 +08001231 /* Space for further checks */
1232
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001234}
1235
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001236/*
1237 * Setup an SSL context
1238 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001239
Gilles Peskine449bd832023-01-11 14:50:10 +01001240int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1241 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001242{
Janos Follath865b3eb2019-12-16 11:46:15 +00001243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001244 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1245 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001246
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001247 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 if ((ret = ssl_conf_check(ssl)) != 0) {
1250 return ret;
1251 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001252 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001253
Paul Bakker62f2dee2012-09-28 07:31:51 +00001254 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001255 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001256 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001257
1258 /* Set to NULL in case of an error condition */
1259 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001260
Darryl Greenb33cc762019-11-28 14:29:44 +00001261#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1262 ssl->in_buf_len = in_buf_len;
1263#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1265 if (ssl->in_buf == NULL) {
1266 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001267 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001268 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001269 }
1270
Darryl Greenb33cc762019-11-28 14:29:44 +00001271#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1272 ssl->out_buf_len = out_buf_len;
1273#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1275 if (ssl->out_buf == NULL) {
1276 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001277 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001278 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001279 }
1280
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001281 mbedtls_ssl_reset_in_pointers(ssl);
1282 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001283
Johan Pascalb62bb512015-12-03 21:56:45 +01001284#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001286#endif
1287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001289 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001293
1294error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 mbedtls_free(ssl->in_buf);
1296 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001297
1298 ssl->conf = NULL;
1299
Darryl Greenb33cc762019-11-28 14:29:44 +00001300#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1301 ssl->in_buf_len = 0;
1302 ssl->out_buf_len = 0;
1303#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001304 ssl->in_buf = NULL;
1305 ssl->out_buf = NULL;
1306
1307 ssl->in_hdr = NULL;
1308 ssl->in_ctr = NULL;
1309 ssl->in_len = NULL;
1310 ssl->in_iv = NULL;
1311 ssl->in_msg = NULL;
1312
1313 ssl->out_hdr = NULL;
1314 ssl->out_ctr = NULL;
1315 ssl->out_len = NULL;
1316 ssl->out_iv = NULL;
1317 ssl->out_msg = NULL;
1318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001320}
1321
1322/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001323 * Reset an initialized and used SSL context for re-use while retaining
1324 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001325 *
1326 * If partial is non-zero, keep data in the input buffer and client ID.
1327 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1330 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001331{
Darryl Greenb33cc762019-11-28 14:29:44 +00001332#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1333 size_t in_buf_len = ssl->in_buf_len;
1334 size_t out_buf_len = ssl->out_buf_len;
1335#else
1336 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1337 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1338#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001339
Hanno Beckerb0302c42021-08-03 09:39:42 +01001340#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1341 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001342#endif
1343
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001344 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001346
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001347 mbedtls_ssl_reset_in_pointers(ssl);
1348 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001349
1350 /* Reset incoming message parsing */
1351 ssl->in_offt = NULL;
1352 ssl->nb_zero = 0;
1353 ssl->in_msgtype = 0;
1354 ssl->in_msglen = 0;
1355 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001356 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001357 ssl->keep_current_message = 0;
1358 ssl->transform_in = NULL;
1359
1360#if defined(MBEDTLS_SSL_PROTO_DTLS)
1361 ssl->next_record_offset = 0;
1362 ssl->in_epoch = 0;
1363#endif
1364
1365 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001367 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 }
1370
Ronald Cronad8c17b2022-06-10 17:18:09 +02001371 ssl->send_alert = 0;
1372
Hanno Beckerb0302c42021-08-03 09:39:42 +01001373 /* Reset outgoing message writing */
1374 ssl->out_msgtype = 0;
1375 ssl->out_msglen = 0;
1376 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 memset(ssl->out_buf, 0, out_buf_len);
1378 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379 ssl->transform_out = NULL;
1380
1381#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001383#endif
1384
XiaokangQian2b01dc32022-01-21 02:53:13 +00001385#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if (ssl->transform) {
1387 mbedtls_ssl_transform_free(ssl->transform);
1388 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001389 ssl->transform = NULL;
1390 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001391#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1392
XiaokangQian2b01dc32022-01-21 02:53:13 +00001393#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 mbedtls_ssl_transform_free(ssl->transform_application);
1395 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001396 ssl->transform_application = NULL;
1397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1401 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001402 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001403#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1406 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001407 ssl->handshake->transform_handshake = NULL;
1408 }
1409
XiaokangQian2b01dc32022-01-21 02:53:13 +00001410#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001411}
1412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001414{
1415 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1416
1417 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001418 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001419
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001421
1422 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#if defined(MBEDTLS_SSL_RENEGOTIATION)
1424 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001425 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001426
1427 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1429 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001430#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001432
Hanno Beckerb0302c42021-08-03 09:39:42 +01001433 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001434 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (ssl->session) {
1436 mbedtls_ssl_session_free(ssl->session);
1437 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001438 ssl->session = NULL;
1439 }
1440
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001441#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001442 ssl->alpn_chosen = NULL;
1443#endif
1444
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001445#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001446 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001447#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001449#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 if (free_cli_id) {
1451 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001452 ssl->cli_id = NULL;
1453 ssl->cli_id_len = 0;
1454 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001455#endif
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 if ((ret = ssl_handshake_init(ssl)) != 0) {
1458 return ret;
1459 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001462}
1463
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001464/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001465 * Reset an initialized and used SSL context for re-use while retaining
1466 * all application-set variables, function pointers and data.
1467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001468int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001469{
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001471}
1472
1473/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001474 * SSL set accessors
1475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001476void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001477{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001478 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001479}
1480
Gilles Peskine449bd832023-01-11 14:50:10 +01001481void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001482{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001483 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001484}
1485
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001487void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001488{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001489 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001490}
1491#endif
1492
Gilles Peskine449bd832023-01-11 14:50:10 +01001493void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001495 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001496}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1501 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001502{
1503 ssl->disable_datagram_packing = !allow_packing;
1504}
1505
Gilles Peskine449bd832023-01-11 14:50:10 +01001506void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1507 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001509 conf->hs_timeout_min = min;
1510 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001511}
1512#endif
1513
Gilles Peskine449bd832023-01-11 14:50:10 +01001514void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001515{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001516 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001517}
1518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001520void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1521 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1522 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001524 conf->f_vrfy = f_vrfy;
1525 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001526}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1530 int (*f_rng)(void *, unsigned char *, size_t),
1531 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001532{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001533 conf->f_rng = f_rng;
1534 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001535}
1536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1538 void (*f_dbg)(void *, int, const char *, int, const char *),
1539 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001540{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001541 conf->f_dbg = f_dbg;
1542 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001543}
1544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1546 void *p_bio,
1547 mbedtls_ssl_send_t *f_send,
1548 mbedtls_ssl_recv_t *f_recv,
1549 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001550{
1551 ssl->p_bio = p_bio;
1552 ssl->f_send = f_send;
1553 ssl->f_recv = f_recv;
1554 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001555}
1556
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001557#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001558void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001559{
1560 ssl->mtu = mtu;
1561}
1562#endif
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001565{
1566 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001567}
1568
Gilles Peskine449bd832023-01-11 14:50:10 +01001569void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1570 void *p_timer,
1571 mbedtls_ssl_set_timer_t *f_set_timer,
1572 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001573{
1574 ssl->p_timer = p_timer;
1575 ssl->f_set_timer = f_set_timer;
1576 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001577
1578 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001580}
1581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1584 void *p_cache,
1585 mbedtls_ssl_cache_get_t *f_get_cache,
1586 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001587{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001588 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001589 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001590 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001591}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001595int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001596{
Janos Follath865b3eb2019-12-16 11:46:15 +00001597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001598
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001600 session == NULL ||
1601 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001604 }
1605
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 if (ssl->handshake->resume == 1) {
1607 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1608 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001609
Jerry Yu21092062022-10-10 21:21:31 +08001610#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001612#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001613 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001615
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001617 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1619 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1620 session->ciphersuite));
1621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001622 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001623#else
1624 /*
1625 * If session tickets are not enabled, it is not possible to resume a
1626 * TLS 1.3 session, thus do not make any change to the SSL context in
1627 * the first place.
1628 */
1629 return 0;
1630#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001631 }
Jerry Yu21092062022-10-10 21:21:31 +08001632#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1635 session)) != 0) {
1636 return ret;
1637 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001638
Paul Bakker0a597072012-09-25 21:55:46 +00001639 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001642}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001644
Gilles Peskine449bd832023-01-11 14:50:10 +01001645void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1646 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001647{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001648 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001649}
1650
Ronald Cron6f135e12021-12-08 16:57:54 +01001651#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001652void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1653 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001654{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001655 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001656}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001657
1658#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001659void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1660 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001661{
1662 conf->early_data_enabled = early_data_enabled;
1663}
Jerry Yucc4e0072022-11-22 17:22:22 +08001664
1665#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001666void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001668{
Jerry Yu39da9852022-12-06 16:58:36 +08001669 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001670}
1671#endif /* MBEDTLS_SSL_SRV_C */
1672
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001673#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001674#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001677void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1678 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001679{
1680 conf->cert_profile = profile;
1681}
1682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001684{
1685 mbedtls_ssl_key_cert *cur = key_cert, *next;
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001688 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001690 cur = next;
1691 }
1692}
1693
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001694/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001695MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001696static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1697 mbedtls_x509_crt *cert,
1698 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001699{
niisato8ee24222018-06-25 19:05:48 +09001700 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001703 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001705 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001707 }
1708
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1710 if (new_cert == NULL) {
1711 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1712 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001713
niisato8ee24222018-06-25 19:05:48 +09001714 new_cert->cert = cert;
1715 new_cert->key = key;
1716 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001717
Glenn Strauss36872db2022-01-22 05:06:31 -05001718 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001720 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001722 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001724 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 }
niisato8ee24222018-06-25 19:05:48 +09001726 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001727 }
1728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001730}
1731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001733 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001735{
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001737}
1738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001740 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001742{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001743 conf->ca_chain = ca_chain;
1744 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001745
1746#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1747 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1748 * cannot be used together. */
1749 conf->f_ca_cb = NULL;
1750 conf->p_ca_cb = NULL;
1751#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001752}
Hanno Becker5adaad92019-03-27 16:54:37 +00001753
1754#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001755void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1756 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1757 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001758{
1759 conf->f_ca_cb = f_ca_cb;
1760 conf->p_ca_cb = p_ca_cb;
1761
1762 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1763 * cannot be used together. */
1764 conf->ca_chain = NULL;
1765 conf->ca_crl = NULL;
1766}
1767#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001769
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001770#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001771const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1772 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001773{
1774 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001776}
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1779 mbedtls_x509_crt *own_cert,
1780 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001781{
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1783 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001784}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1787 mbedtls_x509_crt *ca_chain,
1788 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001789{
1790 ssl->handshake->sni_ca_chain = ca_chain;
1791 ssl->handshake->sni_ca_crl = ca_crl;
1792}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001793
Glenn Strauss999ef702022-03-11 01:37:23 -05001794#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001795void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1796 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001797{
1798 ssl->handshake->dn_hints = crt;
1799}
1800#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1803 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001804{
1805 ssl->handshake->sni_authmode = authmode;
1806}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001807#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1808
Hanno Becker8927c832019-04-03 12:52:50 +01001809#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001810void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1811 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1812 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001813{
1814 ssl->f_vrfy = f_vrfy;
1815 ssl->p_vrfy = p_vrfy;
1816}
1817#endif
1818
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001819#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001820
Przemek Stekielfde11282023-03-13 16:06:09 +01001821static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1822static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1823
Valerio Setti016f6822022-12-09 14:17:50 +01001824static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 mbedtls_ssl_context *ssl,
1826 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001827{
1828 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001829 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001830 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001831 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001832 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001833 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1835 psa_pake_cs_set_primitive(&cipher_suite,
1836 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1837 PSA_ECC_FAMILY_SECP_R1,
1838 256));
1839 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1842 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001843 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001847 user = jpake_server_id;
1848 user_len = sizeof(jpake_server_id);
1849 peer = jpake_client_id;
1850 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001852 user = jpake_client_id;
1853 user_len = sizeof(jpake_client_id);
1854 peer = jpake_server_id;
1855 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001857
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001858 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1859 if (status != PSA_SUCCESS) {
1860 return status;
1861 }
1862
1863 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001865 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 }
Valerio Setti016f6822022-12-09 14:17:50 +01001867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1869 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001870 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 }
Valerio Setti016f6822022-12-09 14:17:50 +01001872
1873 ssl->handshake->psa_pake_ctx_is_ok = 1;
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001876}
1877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1879 const unsigned char *pw,
1880 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001881{
1882 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1883 psa_status_t status;
1884
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 if (ssl->handshake == NULL || ssl->conf == NULL) {
1886 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001887 }
1888
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 /* Empty password is not valid */
1890 if ((pw == NULL) || (pw_len == 0)) {
1891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1892 }
1893
1894 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1895 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1896 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1897
1898 status = psa_import_key(&attributes, pw, pw_len,
1899 &ssl->handshake->psa_pake_password);
1900 if (status != PSA_SUCCESS) {
1901 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1902 }
1903
1904 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1905 ssl->handshake->psa_pake_password);
1906 if (status != PSA_SUCCESS) {
1907 psa_destroy_key(ssl->handshake->psa_pake_password);
1908 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1909 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1910 }
1911
1912 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001913}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1916 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001917{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001918 psa_status_t status;
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (ssl->handshake == NULL || ssl->conf == NULL) {
1921 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001922 }
1923
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 if (mbedtls_svc_key_id_is_null(pwd)) {
1925 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1926 }
1927
1928 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1929 if (status != PSA_SUCCESS) {
1930 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1931 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1932 }
1933
1934 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001935}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001936#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001937
Ronald Cron73fe8df2022-10-05 14:31:43 +02001938#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001939int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001940{
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 if (conf->psk_identity == NULL ||
1942 conf->psk_identity_len == 0) {
1943 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001944 }
1945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1947 return 1;
1948 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001949
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 if (conf->psk != NULL && conf->psk_len != 0) {
1951 return 1;
1952 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001955}
1956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958{
1959 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961 /* The maintenance of the PSK key slot is the
1962 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001963 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001964 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001966 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001967 conf->psk = NULL;
1968 conf->psk_len = 0;
1969 }
1970
1971 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 if (conf->psk_identity != NULL) {
1973 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001974 conf->psk_identity = NULL;
1975 conf->psk_identity_len = 0;
1976 }
1977}
1978
Hanno Becker7390c712018-11-15 13:33:04 +00001979/* This function assumes that PSK identity in the SSL config is unset.
1980 * It checks that the provided identity is well-formed and attempts
1981 * to make a copy of it in the SSL config.
1982 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001983MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001984static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1985 unsigned char const *psk_identity,
1986 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001987{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001988 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001990 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 (psk_identity_len >> 16) != 0 ||
1992 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001994 }
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1997 if (conf->psk_identity == NULL) {
1998 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1999 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002000
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002001 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002005}
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2008 const unsigned char *psk, size_t psk_len,
2009 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002010{
Janos Follath865b3eb2019-12-16 11:46:15 +00002011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002012
2013 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2015 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2016 }
Hanno Becker7390c712018-11-15 13:33:04 +00002017
2018 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 if (psk == NULL) {
2020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2021 }
2022 if (psk_len == 0) {
2023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2024 }
2025 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2027 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2030 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2031 }
Hanno Becker7390c712018-11-15 13:33:04 +00002032 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002034
2035 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2037 if (ret != 0) {
2038 ssl_conf_remove_psk(conf);
2039 }
Hanno Becker7390c712018-11-15 13:33:04 +00002040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002042}
2043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002045{
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002047 /* The maintenance of the external PSK key slot is the
2048 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (ssl->handshake->psk_opaque_is_internal) {
2050 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002051 ssl->handshake->psk_opaque_is_internal = 0;
2052 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002053 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002054 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002055}
2056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2058 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002059{
Neil Armstrong501c9322022-05-03 09:35:09 +02002060 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002061 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002062 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002063 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (psk == NULL || ssl->handshake == NULL) {
2066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2067 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002068
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2071 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002072
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002074
Jerry Yuccc68a42022-07-26 16:39:20 +08002075#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2077 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2078 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2079 } else {
2080 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2081 }
2082 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002083 }
2084#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002085
Jerry Yu568ec252022-07-22 21:27:34 +08002086#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2088 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2089 psa_set_key_usage_flags(&key_attributes,
2090 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002091 }
2092#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 psa_set_key_algorithm(&key_attributes, alg);
2095 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2098 if (status != PSA_SUCCESS) {
2099 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2100 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002101
2102 /* Allow calling psa_destroy_key() on psk remove */
2103 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002105}
2106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2108 mbedtls_svc_key_id_t psk,
2109 const unsigned char *psk_identity,
2110 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002111{
Janos Follath865b3eb2019-12-16 11:46:15 +00002112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002113
2114 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2116 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2117 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002118
Hanno Becker7390c712018-11-15 13:33:04 +00002119 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (mbedtls_svc_key_id_is_null(psk)) {
2121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2122 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002123 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002124
2125 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2127 psk_identity_len);
2128 if (ret != 0) {
2129 ssl_conf_remove_psk(conf);
2130 }
Hanno Becker7390c712018-11-15 13:33:04 +00002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002133}
2134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2136 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002137{
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 if ((mbedtls_svc_key_id_is_null(psk)) ||
2139 (ssl->handshake == NULL)) {
2140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2141 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002146}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002147
Jerry Yu8897c072022-08-12 13:56:53 +08002148#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002149void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2150 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2151 size_t),
2152 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002153{
2154 conf->f_psk = f_psk;
2155 conf->p_psk = p_psk;
2156}
Jerry Yu8897c072022-08-12 13:56:53 +08002157#endif /* MBEDTLS_SSL_SRV_C */
2158
Ronald Cron73fe8df2022-10-05 14:31:43 +02002159#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002160
Gilles Peskine301711e2022-04-26 16:57:05 +02002161static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002163{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002164#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (alg == PSA_ALG_CBC_NO_PADDING) {
2166 return MBEDTLS_SSL_MODE_CBC;
2167 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002168#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (PSA_ALG_IS_AEAD(alg)) {
2170 return MBEDTLS_SSL_MODE_AEAD;
2171 }
2172 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002173}
2174
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002175
Gilles Peskinee108d982022-04-26 16:50:40 +02002176static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2177 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002179{
2180#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2182 base_mode == MBEDTLS_SSL_MODE_CBC) {
2183 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002184 }
2185#else
2186 (void) encrypt_then_mac;
2187#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002189}
2190
Neil Armstrongab555e02022-04-04 11:07:59 +02002191mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002193{
Gilles Peskinee108d982022-04-26 16:50:40 +02002194 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002196 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002197
Gilles Peskinee108d982022-04-26 16:50:40 +02002198 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002199#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002200 encrypt_then_mac = transform->encrypt_then_mac;
2201#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002203}
2204
Neil Armstrongab555e02022-04-04 11:07:59 +02002205mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002206#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002208#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210{
Gilles Peskinee108d982022-04-26 16:50:40 +02002211 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2212
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002213 psa_status_t status;
2214 psa_algorithm_t alg;
2215 psa_key_type_t type;
2216 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002217 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2218 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 if (status == PSA_SUCCESS) {
2220 base_mode = mbedtls_ssl_get_base_mode(alg);
2221 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002222
Gilles Peskinee108d982022-04-26 16:50:40 +02002223#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2224 int encrypt_then_mac = 0;
2225#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002227}
2228
Jerry Yu251a12e2022-07-13 15:15:48 +08002229
Ronald Cron8b592d22024-11-12 18:08:25 +01002230const mbedtls_error_pair_t psa_to_ssl_errors[] =
2231{
2232 { PSA_SUCCESS, 0 },
2233 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2234 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2235 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2236 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2237 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2238 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2239};
2240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2242 size_t taglen,
2243 psa_algorithm_t *alg,
2244 psa_key_type_t *key_type,
2245 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002246{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002247#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002248 (void) taglen;
2249#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002251#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002252 case MBEDTLS_CIPHER_AES_128_CBC:
2253 *alg = PSA_ALG_CBC_NO_PADDING;
2254 *key_type = PSA_KEY_TYPE_AES;
2255 *key_size = 128;
2256 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002257#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002258#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002261 *key_type = PSA_KEY_TYPE_AES;
2262 *key_size = 128;
2263 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002264#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002265#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002266 case MBEDTLS_CIPHER_AES_128_GCM:
2267 *alg = PSA_ALG_GCM;
2268 *key_type = PSA_KEY_TYPE_AES;
2269 *key_size = 128;
2270 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002271#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002272#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002273 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002275 *key_type = PSA_KEY_TYPE_AES;
2276 *key_size = 192;
2277 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002278#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002279#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 case MBEDTLS_CIPHER_AES_192_GCM:
2281 *alg = PSA_ALG_GCM;
2282 *key_type = PSA_KEY_TYPE_AES;
2283 *key_size = 192;
2284 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002285#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002286#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002287 case MBEDTLS_CIPHER_AES_256_CBC:
2288 *alg = PSA_ALG_CBC_NO_PADDING;
2289 *key_type = PSA_KEY_TYPE_AES;
2290 *key_size = 256;
2291 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002292#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002293#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002294 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002296 *key_type = PSA_KEY_TYPE_AES;
2297 *key_size = 256;
2298 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002299#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002300#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 case MBEDTLS_CIPHER_AES_256_GCM:
2302 *alg = PSA_ALG_GCM;
2303 *key_type = PSA_KEY_TYPE_AES;
2304 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002308 case MBEDTLS_CIPHER_ARIA_128_CBC:
2309 *alg = PSA_ALG_CBC_NO_PADDING;
2310 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002317 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002322 case MBEDTLS_CIPHER_ARIA_128_GCM:
2323 *alg = PSA_ALG_GCM;
2324 *key_type = PSA_KEY_TYPE_ARIA;
2325 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002329 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002331 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 case MBEDTLS_CIPHER_ARIA_192_GCM:
2337 *alg = PSA_ALG_GCM;
2338 *key_type = PSA_KEY_TYPE_ARIA;
2339 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002343 case MBEDTLS_CIPHER_ARIA_256_CBC:
2344 *alg = PSA_ALG_CBC_NO_PADDING;
2345 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002350 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002352 *key_type = PSA_KEY_TYPE_ARIA;
2353 *key_size = 256;
2354 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002355#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002356#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002357 case MBEDTLS_CIPHER_ARIA_256_GCM:
2358 *alg = PSA_ALG_GCM;
2359 *key_type = PSA_KEY_TYPE_ARIA;
2360 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002364 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2365 *alg = PSA_ALG_CBC_NO_PADDING;
2366 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002371 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002373 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002378 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2379 *alg = PSA_ALG_GCM;
2380 *key_type = PSA_KEY_TYPE_CAMELLIA;
2381 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002385 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002387 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002392 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2393 *alg = PSA_ALG_GCM;
2394 *key_type = PSA_KEY_TYPE_CAMELLIA;
2395 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002399 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2400 *alg = PSA_ALG_CBC_NO_PADDING;
2401 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002406 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002408 *key_type = PSA_KEY_TYPE_CAMELLIA;
2409 *key_size = 256;
2410 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002411#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002412#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002413 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2414 *alg = PSA_ALG_GCM;
2415 *key_type = PSA_KEY_TYPE_CAMELLIA;
2416 *key_size = 256;
2417 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002418#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002419#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002420 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2421 *alg = PSA_ALG_CHACHA20_POLY1305;
2422 *key_type = PSA_KEY_TYPE_CHACHA20;
2423 *key_size = 256;
2424 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002425#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002426 case MBEDTLS_CIPHER_NULL:
2427 *alg = MBEDTLS_SSL_NULL_CIPHER;
2428 *key_type = 0;
2429 *key_size = 0;
2430 break;
2431 default:
2432 return PSA_ERROR_NOT_SUPPORTED;
2433 }
2434
2435 return PSA_SUCCESS;
2436}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002437
Ronald Crone68ab4f2022-10-05 12:46:29 +02002438#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002439#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002440/*
2441 * Set allowed/preferred hashes for handshake signatures
2442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002443void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2444 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002445{
2446 conf->sig_hashes = hashes;
2447}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002448#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002449
Jerry Yuf017ee42022-01-12 15:49:48 +08002450/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002451void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2452 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002453{
Jerry Yuf017ee42022-01-12 15:49:48 +08002454#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2455 conf->sig_hashes = NULL;
2456#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2457 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002458}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002459#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002460
Brett Warrene0edc842021-08-17 09:53:13 +01002461/*
2462 * Set the allowed groups
2463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2465 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002466{
Brett Warrene0edc842021-08-17 09:53:13 +01002467 conf->group_list = group_list;
2468}
2469
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002470#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002471int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002472{
Hanno Becker947194e2017-04-07 13:25:49 +01002473 /* Initialize to suppress unnecessary compiler warning */
2474 size_t hostname_len = 0;
2475
2476 /* Check if new hostname is valid before
2477 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 if (hostname != NULL) {
2479 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2482 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2483 }
Hanno Becker947194e2017-04-07 13:25:49 +01002484 }
2485
2486 /* Now it's clear that we will overwrite the old hostname,
2487 * so we can free it safely */
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002490 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002491 }
2492
2493 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002496 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 } else {
2498 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2499 if (ssl->hostname == NULL) {
2500 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2501 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002504
Hanno Becker947194e2017-04-07 13:25:49 +01002505 ssl->hostname[hostname_len] = '\0';
2506 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002507
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002509}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002510#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002511
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002512#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002513void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2514 int (*f_sni)(void *, mbedtls_ssl_context *,
2515 const unsigned char *, size_t),
2516 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002517{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002518 conf->f_sni = f_sni;
2519 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002520}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002524int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002525{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002526 size_t cur_len, tot_len;
2527 const char **p;
2528
2529 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002530 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2531 * MUST NOT be truncated."
2532 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002533 */
2534 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 for (p = protos; *p != NULL; p++) {
2536 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002537 tot_len += cur_len;
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 if ((cur_len == 0) ||
2540 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2541 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2542 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2543 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002544 }
2545
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002546 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002549}
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002552{
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002554}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002556
Johan Pascalb62bb512015-12-03 21:56:45 +01002557#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002558void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2559 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002560{
2561 conf->dtls_srtp_mki_support = support_mki_value;
2562}
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2565 unsigned char *mki_value,
2566 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002567{
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2569 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002570 }
Ron Eldor591f1622018-01-22 12:30:04 +02002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2573 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002574 }
Ron Eldor591f1622018-01-22 12:30:04 +02002575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002577 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002579}
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2582 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002583{
Johan Pascal253d0262020-09-22 13:04:45 +02002584 const mbedtls_ssl_srtp_profile *p;
2585 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002586
Johan Pascal253d0262020-09-22 13:04:45 +02002587 /* check the profiles list: all entry must be valid,
2588 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2590 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2591 p++) {
2592 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002593 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002595 /* unsupported value, stop parsing and set the size to an error value */
2596 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002597 }
2598 }
2599
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2601 conf->dtls_srtp_profile_list = NULL;
2602 conf->dtls_srtp_profile_list_len = 0;
2603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002604 }
2605
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002606 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002607 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002610}
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2613 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002614{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002615 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2616 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002618 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002620 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2622 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002623 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002624}
Johan Pascalb62bb512015-12-03 21:56:45 +01002625#endif /* MBEDTLS_SSL_DTLS_SRTP */
2626
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302627#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002628void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002629{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002630 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002631}
2632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002634{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002635 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002636}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302637#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002638
Janos Follath088ce432017-04-10 12:42:31 +01002639#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002640void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2641 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002642{
2643 conf->cert_req_ca_list = cert_req_ca_list;
2644}
2645#endif
2646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002648void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002649{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002650 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002651}
2652#endif
2653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002655void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002656{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002657 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002658}
2659#endif
2660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002662int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002663{
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2665 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002667 }
2668
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002669 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002672}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002676{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002677 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002678}
2679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002681void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002682{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002683 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002684}
2685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002687{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002688 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002689}
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2692 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002693{
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002695}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002699#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002700void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002701{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002702 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002703}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002704#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002705
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002706#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002707
Jerry Yud0766ec2022-09-22 10:46:57 +08002708#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2710 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002711{
Jerry Yud0766ec2022-09-22 10:46:57 +08002712 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002713}
2714#endif
2715
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2717 mbedtls_ssl_ticket_write_t *f_ticket_write,
2718 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2719 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002720{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002721 conf->f_ticket_write = f_ticket_write;
2722 conf->f_ticket_parse = f_ticket_parse;
2723 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002724}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002725#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2729 mbedtls_ssl_export_keys_t *f_export_keys,
2730 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002731{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002732 ssl->f_export_keys = f_export_keys;
2733 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002734}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002735
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002736#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002737void mbedtls_ssl_conf_async_private_cb(
2738 mbedtls_ssl_config *conf,
2739 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002740 mbedtls_ssl_async_resume_t *f_async_resume,
2741 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002743{
2744 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002745 conf->f_async_resume = f_async_resume;
2746 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002747 conf->p_async_config_data = async_config_data;
2748}
2749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002751{
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002753}
2754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002756{
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if (ssl->handshake == NULL) {
2758 return NULL;
2759 } else {
2760 return ssl->handshake->user_async_ctx;
2761 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002762}
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2765 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002766{
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002768 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002770}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002771#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002772
Paul Bakker5121ce52009-01-03 21:22:43 +00002773/*
2774 * SSL get accessors
2775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002776uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002777{
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 if (ssl->session != NULL) {
2779 return ssl->session->verify_result;
2780 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (ssl->session_negotiate != NULL) {
2783 return ssl->session_negotiate->verify_result;
2784 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002787}
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002790{
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (ssl == NULL || ssl->session == NULL) {
2792 return 0;
2793 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002796}
2797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002799{
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (ssl == NULL || ssl->session == NULL) {
2801 return NULL;
2802 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002805}
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002808{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2811 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002812 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002814 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002816 }
2817 }
2818#endif
2819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002821 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002823 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002825 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002827 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002828}
2829
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002830#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2831
2832size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2833{
2834 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2835 size_t record_size_limit = max_len;
2836
2837 if (ssl->session != NULL &&
2838 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2839 ssl->session->record_size_limit < max_len) {
2840 record_size_limit = ssl->session->record_size_limit;
2841 }
2842
2843 // TODO: this is currently untested
2844 /* During a handshake, use the value being negotiated */
2845 if (ssl->session_negotiate != NULL &&
2846 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2847 ssl->session_negotiate->record_size_limit < max_len) {
2848 record_size_limit = ssl->session_negotiate->record_size_limit;
2849 }
2850
2851 return record_size_limit;
2852}
2853#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2854
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002855#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002856size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002857{
David Horstmann95d516f2021-05-04 18:36:56 +01002858 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002859 size_t read_mfl;
2860
Jerry Yuddda0502022-12-01 19:43:12 +08002861#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002862 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2864 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2865 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002866 }
Jerry Yuddda0502022-12-01 19:43:12 +08002867#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002868
2869 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (ssl->session_out != NULL) {
2871 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2872 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002873 max_len = read_mfl;
2874 }
2875 }
2876
Jerry Yuddda0502022-12-01 19:43:12 +08002877 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 if (ssl->session_negotiate != NULL) {
2879 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2880 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002881 max_len = read_mfl;
2882 }
2883 }
2884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002886}
2887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002889{
2890 size_t max_len;
2891
2892 /*
2893 * Assume mfl_code is correct since it was checked when set
2894 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002896
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002897 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 if (ssl->session_out != NULL &&
2899 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2900 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002901 }
2902
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002903 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (ssl->session_negotiate != NULL &&
2905 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2906 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002907 }
2908
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002910}
2911#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2912
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002913#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002914size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002915{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002916 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2918 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2919 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2920 return 0;
2921 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2924 return ssl->mtu;
2925 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 if (ssl->mtu == 0) {
2928 return ssl->handshake->mtu;
2929 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 return ssl->mtu < ssl->handshake->mtu ?
2932 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002933}
2934#endif /* MBEDTLS_SSL_PROTO_DTLS */
2935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002937{
2938 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2939
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002940#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002941 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002942 !defined(MBEDTLS_SSL_PROTO_DTLS)
2943 (void) ssl;
2944#endif
2945
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002946#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002950 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002952#endif
2953
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002954#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2955 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2956
2957 if (max_len > record_size_limit) {
2958 max_len = record_size_limit;
2959 }
2960#endif
2961
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002962 if (ssl->transform_out != NULL &&
2963 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002964 /*
2965 * In TLS 1.3 case, when records are protected, `max_len` as computed
2966 * above is the maximum length of the TLSInnerPlaintext structure that
2967 * along the plaintext payload contains the inner content type (one byte)
2968 * and some zero padding. Given the algorithm used for padding
2969 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2970 * the plaintext payload. Round down to a multiple of
2971 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2972 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002973 */
2974 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2975 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2976 }
2977
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002978#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2980 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2981 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002982 const size_t overhead = (size_t) ret;
2983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 if (ret < 0) {
2985 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002986 }
2987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (mtu <= overhead) {
2989 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2990 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2991 }
2992
2993 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002994 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002996 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002997#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002998
Hanno Becker0defedb2018-08-10 12:35:02 +01002999#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003000 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3001 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003002 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003003#endif
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003006}
3007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003009{
3010 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3011
3012#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3013 (void) ssl;
3014#endif
3015
3016#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003020 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003022#endif
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003025}
3026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003028const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003029{
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 if (ssl == NULL || ssl->session == NULL) {
3031 return NULL;
3032 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003033
Hanno Beckere6824572019-02-07 13:18:46 +00003034#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003038#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003039}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003043int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3044 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003045{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003046 int ret;
3047
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003049 dst == NULL ||
3050 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003053 }
3054
Hanno Beckere810bbc2021-05-14 16:01:05 +01003055 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3056 * idempotent: Each session can only be exported once.
3057 *
3058 * (This is in preparation for TLS 1.3 support where we will
3059 * need the ability to export multiple sessions (aka tickets),
3060 * which will be achieved by calling mbedtls_ssl_get_session()
3061 * multiple times until it fails.)
3062 *
3063 * Check whether we have already exported the current session,
3064 * and fail if so.
3065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 if (ssl->session->exported == 1) {
3067 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3068 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3071 if (ret != 0) {
3072 return ret;
3073 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003074
3075 /* Remember that we've exported the session. */
3076 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003078}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003080
David Horstmanncb01b362024-02-29 17:31:46 +00003081#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3082
3083/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003084 *
David Horstmanncb01b362024-02-29 17:31:46 +00003085 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003086 */
3087static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3088 unsigned char *buf,
3089 size_t buf_len)
3090{
3091 unsigned char *p = buf;
3092 size_t used = 0;
3093
3094#if defined(MBEDTLS_HAVE_TIME)
3095 uint64_t start;
3096#endif
3097#if defined(MBEDTLS_X509_CRT_PARSE_C)
3098#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3099 size_t cert_len;
3100#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3101#endif /* MBEDTLS_X509_CRT_PARSE_C */
3102
3103 /*
3104 * Time
3105 */
3106#if defined(MBEDTLS_HAVE_TIME)
3107 used += 8;
3108
3109 if (used <= buf_len) {
3110 start = (uint64_t) session->start;
3111
3112 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3113 p += 8;
3114 }
3115#endif /* MBEDTLS_HAVE_TIME */
3116
3117 /*
3118 * Basic mandatory fields
3119 */
3120 used += 1 /* id_len */
3121 + sizeof(session->id)
3122 + sizeof(session->master)
3123 + 4; /* verify_result */
3124
3125 if (used <= buf_len) {
3126 *p++ = MBEDTLS_BYTE_0(session->id_len);
3127 memcpy(p, session->id, 32);
3128 p += 32;
3129
3130 memcpy(p, session->master, 48);
3131 p += 48;
3132
3133 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3134 p += 4;
3135 }
3136
3137 /*
3138 * Peer's end-entity certificate
3139 */
3140#if defined(MBEDTLS_X509_CRT_PARSE_C)
3141#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3142 if (session->peer_cert == NULL) {
3143 cert_len = 0;
3144 } else {
3145 cert_len = session->peer_cert->raw.len;
3146 }
3147
3148 used += 3 + cert_len;
3149
3150 if (used <= buf_len) {
3151 *p++ = MBEDTLS_BYTE_2(cert_len);
3152 *p++ = MBEDTLS_BYTE_1(cert_len);
3153 *p++ = MBEDTLS_BYTE_0(cert_len);
3154
3155 if (session->peer_cert != NULL) {
3156 memcpy(p, session->peer_cert->raw.p, cert_len);
3157 p += cert_len;
3158 }
3159 }
3160#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3161 if (session->peer_cert_digest != NULL) {
3162 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3163 if (used <= buf_len) {
3164 *p++ = (unsigned char) session->peer_cert_digest_type;
3165 *p++ = (unsigned char) session->peer_cert_digest_len;
3166 memcpy(p, session->peer_cert_digest,
3167 session->peer_cert_digest_len);
3168 p += session->peer_cert_digest_len;
3169 }
3170 } else {
3171 used += 2;
3172 if (used <= buf_len) {
3173 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3174 *p++ = 0;
3175 }
3176 }
3177#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3178#endif /* MBEDTLS_X509_CRT_PARSE_C */
3179
3180 /*
3181 * Session ticket if any, plus associated data
3182 */
3183#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3184#if defined(MBEDTLS_SSL_CLI_C)
3185 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3186 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3187
3188 if (used <= buf_len) {
3189 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3190 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3191 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3192
3193 if (session->ticket != NULL) {
3194 memcpy(p, session->ticket, session->ticket_len);
3195 p += session->ticket_len;
3196 }
3197
3198 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3199 p += 4;
3200 }
3201 }
3202#endif /* MBEDTLS_SSL_CLI_C */
3203#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3204 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3205 used += 8;
3206
3207 if (used <= buf_len) {
3208 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3209 p += 8;
3210 }
3211 }
3212#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3213#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3214
3215 /*
3216 * Misc extension-related info
3217 */
3218#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3219 used += 1;
3220
3221 if (used <= buf_len) {
3222 *p++ = session->mfl_code;
3223 }
3224#endif
3225
3226#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3227 used += 1;
3228
3229 if (used <= buf_len) {
3230 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3231 }
3232#endif
3233
3234 return used;
3235}
3236
3237MBEDTLS_CHECK_RETURN_CRITICAL
3238static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3239 const unsigned char *buf,
3240 size_t len)
3241{
3242#if defined(MBEDTLS_HAVE_TIME)
3243 uint64_t start;
3244#endif
3245#if defined(MBEDTLS_X509_CRT_PARSE_C)
3246#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3247 size_t cert_len;
3248#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3249#endif /* MBEDTLS_X509_CRT_PARSE_C */
3250
3251 const unsigned char *p = buf;
3252 const unsigned char * const end = buf + len;
3253
3254 /*
3255 * Time
3256 */
3257#if defined(MBEDTLS_HAVE_TIME)
3258 if (8 > (size_t) (end - p)) {
3259 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3260 }
3261
3262 start = MBEDTLS_GET_UINT64_BE(p, 0);
3263 p += 8;
3264
3265 session->start = (time_t) start;
3266#endif /* MBEDTLS_HAVE_TIME */
3267
3268 /*
3269 * Basic mandatory fields
3270 */
3271 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3273 }
3274
3275 session->id_len = *p++;
3276 memcpy(session->id, p, 32);
3277 p += 32;
3278
3279 memcpy(session->master, p, 48);
3280 p += 48;
3281
3282 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3283 p += 4;
3284
3285 /* Immediately clear invalid pointer values that have been read, in case
3286 * we exit early before we replaced them with valid ones. */
3287#if defined(MBEDTLS_X509_CRT_PARSE_C)
3288#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3289 session->peer_cert = NULL;
3290#else
3291 session->peer_cert_digest = NULL;
3292#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3293#endif /* MBEDTLS_X509_CRT_PARSE_C */
3294#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3295 session->ticket = NULL;
3296#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3297
3298 /*
3299 * Peer certificate
3300 */
3301#if defined(MBEDTLS_X509_CRT_PARSE_C)
3302#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3303 /* Deserialize CRT from the end of the ticket. */
3304 if (3 > (size_t) (end - p)) {
3305 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3306 }
3307
3308 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3309 p += 3;
3310
3311 if (cert_len != 0) {
3312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3313
3314 if (cert_len > (size_t) (end - p)) {
3315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3316 }
3317
3318 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3319
3320 if (session->peer_cert == NULL) {
3321 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3322 }
3323
3324 mbedtls_x509_crt_init(session->peer_cert);
3325
3326 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3327 p, cert_len)) != 0) {
3328 mbedtls_x509_crt_free(session->peer_cert);
3329 mbedtls_free(session->peer_cert);
3330 session->peer_cert = NULL;
3331 return ret;
3332 }
3333
3334 p += cert_len;
3335 }
3336#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3337 /* Deserialize CRT digest from the end of the ticket. */
3338 if (2 > (size_t) (end - p)) {
3339 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3340 }
3341
3342 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3343 session->peer_cert_digest_len = (size_t) *p++;
3344
3345 if (session->peer_cert_digest_len != 0) {
3346 const mbedtls_md_info_t *md_info =
3347 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3348 if (md_info == NULL) {
3349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3350 }
3351 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3352 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3353 }
3354
3355 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3357 }
3358
3359 session->peer_cert_digest =
3360 mbedtls_calloc(1, session->peer_cert_digest_len);
3361 if (session->peer_cert_digest == NULL) {
3362 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3363 }
3364
3365 memcpy(session->peer_cert_digest, p,
3366 session->peer_cert_digest_len);
3367 p += session->peer_cert_digest_len;
3368 }
3369#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3370#endif /* MBEDTLS_X509_CRT_PARSE_C */
3371
3372 /*
3373 * Session ticket and associated data
3374 */
3375#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3376#if defined(MBEDTLS_SSL_CLI_C)
3377 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3378 if (3 > (size_t) (end - p)) {
3379 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3380 }
3381
3382 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3383 p += 3;
3384
3385 if (session->ticket_len != 0) {
3386 if (session->ticket_len > (size_t) (end - p)) {
3387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3388 }
3389
3390 session->ticket = mbedtls_calloc(1, session->ticket_len);
3391 if (session->ticket == NULL) {
3392 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3393 }
3394
3395 memcpy(session->ticket, p, session->ticket_len);
3396 p += session->ticket_len;
3397 }
3398
3399 if (4 > (size_t) (end - p)) {
3400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3401 }
3402
3403 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3404 p += 4;
3405 }
3406#endif /* MBEDTLS_SSL_CLI_C */
3407#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3408 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3409 if (8 > (size_t) (end - p)) {
3410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3411 }
3412 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3413 p += 8;
3414 }
3415#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3416#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3417
3418 /*
3419 * Misc extension-related info
3420 */
3421#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3422 if (1 > (size_t) (end - p)) {
3423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3424 }
3425
3426 session->mfl_code = *p++;
3427#endif
3428
3429#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3430 if (1 > (size_t) (end - p)) {
3431 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3432 }
3433
3434 session->encrypt_then_mac = *p++;
3435#endif
3436
3437 /* Done, should have consumed entire buffer */
3438 if (p != end) {
3439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3440 }
3441
3442 return 0;
3443}
3444
3445#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3446
3447#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3448/* Serialization of TLS 1.3 sessions:
3449 *
David Horstmanncb01b362024-02-29 17:31:46 +00003450 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003451 */
3452#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3453MBEDTLS_CHECK_RETURN_CRITICAL
3454static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3455 unsigned char *buf,
3456 size_t buf_len,
3457 size_t *olen)
3458{
3459 unsigned char *p = buf;
3460#if defined(MBEDTLS_SSL_CLI_C) && \
3461 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3462 size_t hostname_len = (session->hostname == NULL) ?
3463 0 : strlen(session->hostname) + 1;
3464#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003465
3466#if defined(MBEDTLS_SSL_SRV_C) && \
3467 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003468 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003469 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003470#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003471 size_t needed = 4 /* ticket_age_add */
3472 + 1 /* ticket_flags */
3473 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003474
David Horstmanne59f9702024-02-29 16:08:57 +00003475 *olen = 0;
3476
3477 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3478 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3479 }
3480 needed += session->resumption_key_len; /* resumption_key */
3481
3482#if defined(MBEDTLS_SSL_EARLY_DATA)
3483 needed += 4; /* max_early_data_size */
3484#endif
3485#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3486 needed += 2; /* record_size_limit */
3487#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3488
3489#if defined(MBEDTLS_HAVE_TIME)
3490 needed += 8; /* ticket_creation_time or ticket_reception_time */
3491#endif
3492
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003493#if defined(MBEDTLS_SSL_SRV_C)
3494 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3495#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003496 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003497 + alpn_len; /* alpn */
3498#endif
3499 }
3500#endif /* MBEDTLS_SSL_SRV_C */
3501
David Horstmanne59f9702024-02-29 16:08:57 +00003502#if defined(MBEDTLS_SSL_CLI_C)
3503 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3504#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3505 needed += 2 /* hostname_len */
3506 + hostname_len; /* hostname */
3507#endif
3508
3509 needed += 4 /* ticket_lifetime */
3510 + 2; /* ticket_len */
3511
3512 /* Check size_t overflow */
3513 if (session->ticket_len > SIZE_MAX - needed) {
3514 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3515 }
3516
3517 needed += session->ticket_len; /* ticket */
3518 }
3519#endif /* MBEDTLS_SSL_CLI_C */
3520
3521 *olen = needed;
3522 if (needed > buf_len) {
3523 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3524 }
3525
3526 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3527 p[4] = session->ticket_flags;
3528
3529 /* save resumption_key */
3530 p[5] = session->resumption_key_len;
3531 p += 6;
3532 memcpy(p, session->resumption_key, session->resumption_key_len);
3533 p += session->resumption_key_len;
3534
3535#if defined(MBEDTLS_SSL_EARLY_DATA)
3536 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3537 p += 4;
3538#endif
3539#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3540 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3541 p += 2;
3542#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3543
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003544#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003545 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003546#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003547 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3548 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003549#endif /* MBEDTLS_HAVE_TIME */
3550
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003551#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003552 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3553 p += 2;
3554
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003555 if (alpn_len > 0) {
3556 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003557 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003558 p += alpn_len;
3559 }
3560#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3561 }
3562#endif /* MBEDTLS_SSL_SRV_C */
3563
David Horstmanne59f9702024-02-29 16:08:57 +00003564#if defined(MBEDTLS_SSL_CLI_C)
3565 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3566#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3567 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3568 p += 2;
3569 if (hostname_len > 0) {
3570 /* save host name */
3571 memcpy(p, session->hostname, hostname_len);
3572 p += hostname_len;
3573 }
3574#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3575
3576#if defined(MBEDTLS_HAVE_TIME)
3577 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3578 p += 8;
3579#endif
3580 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3581 p += 4;
3582
3583 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3584 p += 2;
3585
3586 if (session->ticket != NULL && session->ticket_len > 0) {
3587 memcpy(p, session->ticket, session->ticket_len);
3588 p += session->ticket_len;
3589 }
3590 }
3591#endif /* MBEDTLS_SSL_CLI_C */
3592 return 0;
3593}
3594
3595MBEDTLS_CHECK_RETURN_CRITICAL
3596static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3597 const unsigned char *buf,
3598 size_t len)
3599{
3600 const unsigned char *p = buf;
3601 const unsigned char *end = buf + len;
3602
3603 if (end - p < 6) {
3604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3605 }
3606 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3607 session->ticket_flags = p[4];
3608
3609 /* load resumption_key */
3610 session->resumption_key_len = p[5];
3611 p += 6;
3612
3613 if (end - p < session->resumption_key_len) {
3614 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3615 }
3616
3617 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3619 }
3620 memcpy(session->resumption_key, p, session->resumption_key_len);
3621 p += session->resumption_key_len;
3622
3623#if defined(MBEDTLS_SSL_EARLY_DATA)
3624 if (end - p < 4) {
3625 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3626 }
3627 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3628 p += 4;
3629#endif
3630#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3631 if (end - p < 2) {
3632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3633 }
3634 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3635 p += 2;
3636#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3637
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003638#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003639 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003640#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003641 if (end - p < 8) {
3642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3643 }
3644 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3645 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003646#endif /* MBEDTLS_HAVE_TIME */
3647
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003648#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003649 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003650
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003651 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003652 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3653 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003654
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003655 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3656 p += 2;
3657
3658 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003659 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3660 }
3661
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003662 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003663 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3664 if (ret != 0) {
3665 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003666 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003667 p += alpn_len;
3668 }
3669#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3670 }
3671#endif /* MBEDTLS_SSL_SRV_C */
3672
David Horstmanne59f9702024-02-29 16:08:57 +00003673#if defined(MBEDTLS_SSL_CLI_C)
3674 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3675#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3676 size_t hostname_len;
3677 /* load host name */
3678 if (end - p < 2) {
3679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3680 }
3681 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3682 p += 2;
3683
3684 if (end - p < (long int) hostname_len) {
3685 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3686 }
3687 if (hostname_len > 0) {
3688 session->hostname = mbedtls_calloc(1, hostname_len);
3689 if (session->hostname == NULL) {
3690 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3691 }
3692 memcpy(session->hostname, p, hostname_len);
3693 p += hostname_len;
3694 }
3695#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3696
3697#if defined(MBEDTLS_HAVE_TIME)
3698 if (end - p < 8) {
3699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3700 }
3701 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3702 p += 8;
3703#endif
3704 if (end - p < 4) {
3705 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3706 }
3707 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3708 p += 4;
3709
3710 if (end - p < 2) {
3711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3712 }
3713 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3714 p += 2;
3715
3716 if (end - p < (long int) session->ticket_len) {
3717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3718 }
3719 if (session->ticket_len > 0) {
3720 session->ticket = mbedtls_calloc(1, session->ticket_len);
3721 if (session->ticket == NULL) {
3722 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3723 }
3724 memcpy(session->ticket, p, session->ticket_len);
3725 p += session->ticket_len;
3726 }
3727 }
3728#endif /* MBEDTLS_SSL_CLI_C */
3729
3730 return 0;
3731
3732}
3733#else /* MBEDTLS_SSL_SESSION_TICKETS */
3734MBEDTLS_CHECK_RETURN_CRITICAL
3735static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3736 unsigned char *buf,
3737 size_t buf_len,
3738 size_t *olen)
3739{
3740 ((void) session);
3741 ((void) buf);
3742 ((void) buf_len);
3743 *olen = 0;
3744 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3745}
3746
3747static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003748 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003749 size_t buf_len)
3750{
3751 ((void) session);
3752 ((void) buf);
3753 ((void) buf_len);
3754 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3755}
3756#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3758
Paul Bakker5121ce52009-01-03 21:22:43 +00003759/*
Hanno Beckera835da52019-05-16 12:39:07 +01003760 * Define ticket header determining Mbed TLS version
3761 * and structure of the ticket.
3762 */
3763
Hanno Becker94ef3b32019-05-16 12:50:45 +01003764/*
Hanno Becker50b59662019-05-28 14:30:45 +01003765 * Define bitflag determining compile-time settings influencing
3766 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003767 */
3768
Hanno Becker50b59662019-05-28 14:30:45 +01003769#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003770#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003771#else
Hanno Becker3e088662019-05-29 11:10:18 +01003772#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003773#endif /* MBEDTLS_HAVE_TIME */
3774
3775#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003776#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003777#else
Hanno Becker3e088662019-05-29 11:10:18 +01003778#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003779#endif /* MBEDTLS_X509_CRT_PARSE_C */
3780
David Horstmann5c5a32f2024-02-13 17:53:35 +00003781#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003782#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003783#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003784#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003785#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3786
Hanno Becker94ef3b32019-05-16 12:50:45 +01003787#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003788#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003789#else
Hanno Becker3e088662019-05-29 11:10:18 +01003790#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3792
3793#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003794#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003795#else
Hanno Becker3e088662019-05-29 11:10:18 +01003796#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003797#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3798
Hanno Becker94ef3b32019-05-16 12:50:45 +01003799#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003800#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003801#else
Hanno Becker3e088662019-05-29 11:10:18 +01003802#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003803#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3804
Hanno Becker94ef3b32019-05-16 12:50:45 +01003805#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3806#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3807#else
3808#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3809#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3810
David Horstmann92b258b2024-02-13 17:23:34 +00003811#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3812#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3813#else
3814#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3815#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3816
3817#if defined(MBEDTLS_SSL_EARLY_DATA)
3818#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3819#else
3820#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3821#endif /* MBEDTLS_SSL_EARLY_DATA */
3822
3823#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3824#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3825#else
3826#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3827#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3828
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003829#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3830 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003831#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3832#else
3833#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3834#endif /* MBEDTLS_SSL_ALPN */
3835
Hanno Becker3e088662019-05-29 11:10:18 +01003836#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3837#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3838#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3839#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003840#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3841#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003842#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003843#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3844#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3845#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003846#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003847
Hanno Becker50b59662019-05-28 14:30:45 +01003848#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 ((uint16_t) ( \
3850 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3851 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3852 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3853 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3854 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3855 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003856 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003857 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3858 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003859 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3860 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3861 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3862 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003863 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003864 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003865 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003866
Chien Wong4e9683e2023-12-28 17:07:43 +08003867static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003868 MBEDTLS_VERSION_MAJOR,
3869 MBEDTLS_VERSION_MINOR,
3870 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003871 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3872 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003873};
Hanno Beckera835da52019-05-16 12:39:07 +01003874
3875/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003876 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003877 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003878 *
David Horstmanncb01b362024-02-29 17:31:46 +00003879 * TLS 1.2 session:
3880 *
3881 * struct {
3882 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3883 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3884 * uint32 ticket_lifetime;
3885 * #endif
3886 * } ClientOnlyData;
3887 *
3888 * struct {
3889 * #if defined(MBEDTLS_HAVE_TIME)
3890 * uint64 start_time;
3891 * #endif
3892 * uint8 session_id_len; // at most 32
3893 * opaque session_id[32];
3894 * opaque master[48]; // fixed length in the standard
3895 * uint32 verify_result;
3896 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3897 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3898 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003899 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003900 * opaque peer_cert_digest<0..2^8-1>
3901 * #endif
3902 * select (endpoint) {
3903 * case client: ClientOnlyData;
3904 * case server: uint64 ticket_creation_time;
3905 * };
3906 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3907 * uint8 mfl_code; // up to 255 according to standard
3908 * #endif
3909 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3910 * uint8 encrypt_then_mac; // 0 or 1
3911 * #endif
3912 * } serialized_session_tls12;
3913 *
3914 *
3915 * TLS 1.3 Session:
3916 *
3917 * struct {
3918 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3919 * opaque hostname<0..2^16-1>;
3920 * #endif
3921 * #if defined(MBEDTLS_HAVE_TIME)
3922 * uint64 ticket_reception_time;
3923 * #endif
3924 * uint32 ticket_lifetime;
3925 * opaque ticket<1..2^16-1>;
3926 * } ClientOnlyData;
3927 *
3928 * struct {
3929 * uint32 ticket_age_add;
3930 * uint8 ticket_flags;
3931 * opaque resumption_key<0..255>;
3932 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3933 * uint32 max_early_data_size;
3934 * #endif
3935 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3936 * uint16 record_size_limit;
3937 * #endif
3938 * select ( endpoint ) {
3939 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003940 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003941 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003942 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003943 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003944 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003945 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003946 * #endif
3947 * };
3948 * } serialized_session_tls13;
3949 *
3950 *
3951 * SSL session:
3952 *
3953 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003954 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003955 * opaque mbedtls_version[3]; // library version: major, minor, patch
3956 * opaque session_format[2]; // library-version specific 16-bit field
3957 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003958 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003959 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003960 * Note: When updating the format, remember to keep
3961 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003962 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003963 * // In this version, `session_format` determines
3964 * // the setting of those compile-time
3965 * // configuration options which influence
3966 * // the structure of mbedtls_ssl_session.
3967 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003968 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003969 * // - TLS 1.2 (0x0303)
3970 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003971 * uint8_t endpoint;
3972 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003973 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003974 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003975 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003976 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003977 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003978 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003979 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003980 *
3981 * };
3982 *
3983 * } serialized_session;
3984 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003985 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003987MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003988static int ssl_session_save(const mbedtls_ssl_session *session,
3989 unsigned char omit_header,
3990 unsigned char *buf,
3991 size_t buf_len,
3992 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003993{
3994 unsigned char *p = buf;
3995 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003996 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003997#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3998 size_t out_len;
3999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4000#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004001 if (session == NULL) {
4002 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4003 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004006 /*
4007 * Add Mbed TLS version identifier
4008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004010
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (used <= buf_len) {
4012 memcpy(p, ssl_serialized_session_header,
4013 sizeof(ssl_serialized_session_header));
4014 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004015 }
4016 }
4017
4018 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004019 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004020 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004021 used += 1 /* TLS version */
4022 + 1 /* endpoint */
4023 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (used <= buf_len) {
4025 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004026 *p++ = session->endpoint;
4027 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4028 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029 }
4030
4031 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004032 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004034#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 case MBEDTLS_SSL_VERSION_TLS1_2:
4036 used += ssl_tls12_session_save(session, p, remaining_len);
4037 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004038#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4039
Jerry Yu251a12e2022-07-13 15:15:48 +08004040#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 case MBEDTLS_SSL_VERSION_TLS1_3:
4042 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4043 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4044 return ret;
4045 }
4046 used += out_len;
4047 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004048#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 default:
4051 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004052 }
4053
4054 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 if (used > buf_len) {
4056 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4057 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004060}
4061
4062/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004063 * Public wrapper for ssl_session_save()
4064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4066 unsigned char *buf,
4067 size_t buf_len,
4068 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004069{
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004071}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004072
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004073/*
4074 * Deserialize session, see mbedtls_ssl_session_save() for format.
4075 *
4076 * This internal version is wrapped by a public function that cleans up in
4077 * case of error, and has an extra option omit_header.
4078 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004079MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004080static int ssl_session_load(mbedtls_ssl_session *session,
4081 unsigned char omit_header,
4082 const unsigned char *buf,
4083 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004084{
4085 const unsigned char *p = buf;
4086 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004087 size_t remaining_len;
4088
4089
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 if (session == NULL) {
4091 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4092 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004093
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004095 /*
4096 * Check Mbed TLS version identifier
4097 */
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004101 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004102
4103 if (memcmp(p, ssl_serialized_session_header,
4104 sizeof(ssl_serialized_session_header)) != 0) {
4105 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4106 }
4107 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004108 }
4109
4110 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004111 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004112 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004113 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4115 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004116 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004117 session->endpoint = *p++;
4118 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4119 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004120
4121 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004122 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004124#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 case MBEDTLS_SSL_VERSION_TLS1_2:
4126 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004127#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4128
Jerry Yu438ddd82022-07-07 06:55:50 +00004129#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 case MBEDTLS_SSL_VERSION_TLS1_3:
4131 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004132#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 default:
4135 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004136 }
4137}
4138
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004139/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004140 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004142int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4143 const unsigned char *buf,
4144 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004145{
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 if (ret != 0) {
4149 mbedtls_ssl_session_free(session);
4150 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004153}
4154
4155/*
Paul Bakker1961b702013-01-25 14:49:24 +01004156 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004157 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004158MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004159static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004160{
4161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4162
Ronald Cron66dbf912022-02-02 15:33:46 +01004163 /*
4164 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004165 * that were written into the output buffer by the previous handshake step,
4166 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004167 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4168 * We proceed to the next handshake step only when all data from the
4169 * previous one have been sent to the peer, thus we make sure that this is
4170 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4171 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4172 * we have to wait before to go ahead.
4173 * In the case of TLS 1.3, handshake step handlers do not send data to the
4174 * peer. Data are only sent here and through
4175 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004176 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4179 return ret;
4180 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004181
4182#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4184 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4185 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4186 return ret;
4187 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004188 }
4189#endif /* MBEDTLS_SSL_PROTO_DTLS */
4190
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004192}
4193
Gilles Peskine449bd832023-01-11 14:50:10 +01004194int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004195{
Hanno Becker41934dd2021-08-07 19:13:43 +01004196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004197
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004199 ssl->conf == NULL ||
4200 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4202 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004203 }
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 ret = ssl_prepare_handshake_step(ssl);
4206 if (ret != 0) {
4207 return ret;
4208 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 ret = mbedtls_ssl_handle_pending_alert(ssl);
4211 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004212 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 }
Jerry Yue7047812021-09-13 19:26:39 +08004214
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004215 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4216 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4217 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004219#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4221 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004222 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004225 case MBEDTLS_SSL_HELLO_REQUEST:
4226 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004227 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004228 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004229
Ronald Cron9f0fba32022-02-10 16:45:15 +01004230 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004232 break;
4233
4234 default:
4235#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4237 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4238 } else {
4239 ret = mbedtls_ssl_handshake_client_step(ssl);
4240 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004241#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004243#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004245#endif
4246 }
Jerry Yub9930e72021-08-06 17:11:51 +08004247 }
Ronald Cron6291b232023-03-08 15:51:25 +01004248#endif /* MBEDTLS_SSL_CLI_C */
4249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004252#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4253 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004255 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 ret = mbedtls_ssl_handshake_server_step(ssl);
4257 }
Ronald Cron6291b232023-03-08 15:51:25 +01004258#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4259 ret = mbedtls_ssl_handshake_server_step(ssl);
4260#else
4261 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004262#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004263 }
4264#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004265
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004267 /* handshake_step return error. And it is same
4268 * with alert_reason.
4269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (ssl->send_alert) {
4271 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004272 goto cleanup;
4273 }
4274 }
4275
4276cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004278}
4279
4280/*
4281 * Perform the SSL handshake
4282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004283int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004284{
4285 int ret = 0;
4286
Hanno Beckera817ea42020-10-20 15:20:23 +01004287 /* Sanity checks */
4288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (ssl == NULL || ssl->conf == NULL) {
4290 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4291 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004292
Hanno Beckera817ea42020-10-20 15:20:23 +01004293#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4295 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4296 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4297 "mbedtls_ssl_set_timer_cb() for DTLS"));
4298 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004299 }
4300#endif /* MBEDTLS_SSL_PROTO_DTLS */
4301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004303
Hanno Beckera817ea42020-10-20 15:20:23 +01004304 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4306 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004307
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004309 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 }
Paul Bakker1961b702013-01-25 14:49:24 +01004311 }
4312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004316}
4317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#if defined(MBEDTLS_SSL_RENEGOTIATION)
4319#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004320/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004321 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004322 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004324static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004325{
Janos Follath865b3eb2019-12-16 11:46:15 +00004326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004329
4330 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004331 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4332 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004333
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4335 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4336 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004337 }
4338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004342}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004343#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004344
4345/*
4346 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004347 * - any side: calling mbedtls_ssl_renegotiate(),
4348 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4349 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004350 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004351 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004354int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004355{
Janos Follath865b3eb2019-12-16 11:46:15 +00004356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 if ((ret = ssl_handshake_init(ssl)) != 0) {
4361 return ret;
4362 }
Paul Bakker48916f92012-09-16 19:57:18 +00004363
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004364 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4365 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004366#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4368 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4369 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004370 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004372 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004374 }
4375#endif
4376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004377 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4378 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4381 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4382 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004383 }
4384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004388}
4389
4390/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004391 * Renegotiate current connection on client,
4392 * or request renegotiation on server
4393 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004395{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (ssl == NULL || ssl->conf == NULL) {
4399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4400 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004402#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004403 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4405 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4407 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004408
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004410
4411 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (ssl->out_left != 0) {
4413 return mbedtls_ssl_flush_output(ssl);
4414 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004417 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004418#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004420#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004421 /*
4422 * On client, either start the renegotiation process or,
4423 * if already in progress, continue the handshake
4424 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4426 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4427 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004429
4430 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4431 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4432 return ret;
4433 }
4434 } else {
4435 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4436 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4437 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004438 }
4439 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004440#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004443}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004444#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004447{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004448 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4449
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004451 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004453
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004454#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004455#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 if (ssl->handshake->group_list_heap_allocated) {
4457 mbedtls_free((void *) handshake->group_list);
4458 }
Brett Warrene0edc842021-08-17 09:53:13 +01004459 handshake->group_list = NULL;
4460#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004461#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004462
Ronald Crone68ab4f2022-10-05 12:46:29 +02004463#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004464#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (ssl->handshake->sig_algs_heap_allocated) {
4466 mbedtls_free((void *) handshake->sig_algs);
4467 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004468 handshake->sig_algs = NULL;
4469#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004470#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 if (ssl->handshake->certificate_request_context) {
4472 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004473 }
4474#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004475#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004476
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004477#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4479 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004480 handshake->async_in_progress = 0;
4481 }
4482#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4483
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004484#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004486#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004487#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004489#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004490
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004491#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004493 /*
4494 * Opaque keys are not stored in the handshake's data and it's the user
4495 * responsibility to destroy them. Clear ones, instead, are created by
4496 * the TLS library and should be destroyed at the same level
4497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4499 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004500 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004501 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004502#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004504 handshake->ecjpake_cache = NULL;
4505 handshake->ecjpake_cache_len = 0;
4506#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004507#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004508
Valerio Setti7aeec542023-07-05 18:57:21 +02004509#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004510 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004511 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004512 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004514#endif
4515
Ronald Cron73fe8df2022-10-05 14:31:43 +02004516#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004518 /* The maintenance of the external PSK key slot is the
4519 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (ssl->handshake->psk_opaque_is_internal) {
4521 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004522 ssl->handshake->psk_opaque_is_internal = 0;
4523 }
4524 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4525 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004526#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004528#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4529 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004530 /*
4531 * Free only the linked list wrapper, not the keys themselves
4532 * since the belong to the SNI callback
4533 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004536
Gilles Peskineeccd8882020-03-10 12:19:08 +01004537#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4539 if (handshake->ecrs_peer_cert != NULL) {
4540 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4541 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004542 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004543#endif
4544
Hanno Becker75173122019-02-06 16:18:31 +00004545#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4546 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004548#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4549
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004550#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4552 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004553#endif /* MBEDTLS_SSL_CLI_C &&
4554 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004555
4556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 mbedtls_ssl_flight_free(handshake->flight);
4558 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004559#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004560
Valerio Settiea59c432023-07-25 11:14:03 +02004561#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004562 if (handshake->xxdh_psa_privkey_is_external == 0) {
4563 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 }
Valerio Settiea59c432023-07-25 11:14:03 +02004565#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004566
Ronald Cron6f135e12021-12-08 16:57:54 +01004567#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 mbedtls_ssl_transform_free(handshake->transform_handshake);
4569 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004570#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4572 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004573#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004574#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004575
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004576
4577#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4578 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4579 * processes datagrams and the fact that a datagram is allowed to have
4580 * several records in it, it is possible that the I/O buffers are not
4581 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4583 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004584#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004585
Jerry Yuba9c7272021-10-30 11:54:10 +08004586 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 mbedtls_platform_zeroize(handshake,
4588 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004589}
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004592{
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004594 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004599#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004600
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004601#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004602#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4603 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004605#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004607#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004608
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004609#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4610 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004611 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004612#endif
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004615}
4616
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004617#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004618
4619#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4620#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4621#else
4622#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4623#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4624
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004625#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004626
4627#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4628#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4629#else
4630#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4631#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4632
4633#if defined(MBEDTLS_SSL_ALPN)
4634#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4635#else
4636#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4637#endif /* MBEDTLS_SSL_ALPN */
4638
4639#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4640#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4641#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4642#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4643
4644#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 ((uint32_t) ( \
4646 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4647 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4648 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4649 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4650 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4651 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4652 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4653 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004654
Chien Wong4e9683e2023-12-28 17:07:43 +08004655static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004656 MBEDTLS_VERSION_MAJOR,
4657 MBEDTLS_VERSION_MINOR,
4658 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4660 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4661 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4662 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4663 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004664};
4665
Paul Bakker5121ce52009-01-03 21:22:43 +00004666/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004667 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004668 *
4669 * The format of the serialized data is:
4670 * (in the presentation language of TLS, RFC 8446 section 3)
4671 *
4672 * // header
4673 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004674 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004675 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004676 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004677 * Note: When updating the format, remember to keep these
4678 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004679 *
4680 * // session sub-structure
4681 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4682 * // transform sub-structure
4683 * uint8 random[64]; // ServerHello.random+ClientHello.random
4684 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4685 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4686 * // fields from ssl_context
4687 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4688 * uint64 in_window_top; // DTLS: last validated record seq_num
4689 * uint64 in_window; // DTLS: bitmask for replay protection
4690 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4691 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4692 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4693 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4694 *
4695 * Note that many fields of the ssl_context or sub-structures are not
4696 * serialized, as they fall in one of the following categories:
4697 *
4698 * 1. forced value (eg in_left must be 0)
4699 * 2. pointer to dynamically-allocated memory (eg session, transform)
4700 * 3. value can be re-derived from other data (eg session keys from MS)
4701 * 4. value was temporary (eg content of input buffer)
4702 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004703 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004704int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4705 unsigned char *buf,
4706 size_t buf_len,
4707 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004708{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004709 unsigned char *p = buf;
4710 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004711 size_t session_len;
4712 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004713
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004714 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004715 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4716 * this function's documentation.
4717 *
4718 * These are due to assumptions/limitations in the implementation. Some of
4719 * them are likely to stay (no handshake in progress) some might go away
4720 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004721 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004722 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4724 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4725 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004726 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 if (ssl->handshake != NULL) {
4728 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
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 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 if (ssl->transform == NULL || ssl->session == NULL) {
4733 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4734 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004735 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004736 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (mbedtls_ssl_check_pending(ssl) != 0) {
4738 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (ssl->out_left != 0) {
4742 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004744 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004745 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4747 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is 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 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4757 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004759 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004760 /* Renegotiation must not be enabled */
4761#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4763 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4764 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004765 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004766#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004767
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004768 /*
4769 * Version and format identifier
4770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004772
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 if (used <= buf_len) {
4774 memcpy(p, ssl_serialized_context_header,
4775 sizeof(ssl_serialized_context_header));
4776 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004777 }
4778
4779 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004780 * Session (length + data)
4781 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4783 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4784 return ret;
4785 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004786
4787 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004788 if (used <= buf_len) {
4789 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004790 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 ret = ssl_session_save(ssl->session, 1,
4793 p, session_len, &session_len);
4794 if (ret != 0) {
4795 return ret;
4796 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004797
4798 p += session_len;
4799 }
4800
4801 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004802 * Transform
4803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 used += sizeof(ssl->transform->randbytes);
4805 if (used <= buf_len) {
4806 memcpy(p, ssl->transform->randbytes,
4807 sizeof(ssl->transform->randbytes));
4808 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004809 }
4810
4811#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004812 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004814 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004816 p += ssl->transform->in_cid_len;
4817
4818 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004820 p += ssl->transform->out_cid_len;
4821 }
4822#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4823
4824 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004825 * Saved fields from top-level ssl_context structure
4826 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004827 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (used <= buf_len) {
4829 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004830 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004831 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004832
4833#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4834 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (used <= buf_len) {
4836 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004837 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004840 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004841 }
4842#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4843
4844#if defined(MBEDTLS_SSL_PROTO_DTLS)
4845 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004847 *p++ = ssl->disable_datagram_packing;
4848 }
4849#endif /* MBEDTLS_SSL_PROTO_DTLS */
4850
Jerry Yuae0b2e22021-10-08 15:21:19 +08004851 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (used <= buf_len) {
4853 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004854 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004855 }
4856
4857#if defined(MBEDTLS_SSL_PROTO_DTLS)
4858 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (used <= buf_len) {
4860 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004861 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004862 }
4863#endif /* MBEDTLS_SSL_PROTO_DTLS */
4864
4865#if defined(MBEDTLS_SSL_ALPN)
4866 {
4867 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004869 : 0;
4870
4871 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004873 *p++ = alpn_len;
4874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 if (ssl->alpn_chosen != NULL) {
4876 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004877 p += alpn_len;
4878 }
4879 }
4880 }
4881#endif /* MBEDTLS_SSL_ALPN */
4882
4883 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004884 * Done
4885 */
4886 *olen = used;
4887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (used > buf_len) {
4889 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4890 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004893
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004895}
4896
4897/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004898 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004899 *
4900 * This internal version is wrapped by a public function that cleans up in
4901 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004902 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004903MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004904static int ssl_context_load(mbedtls_ssl_context *ssl,
4905 const unsigned char *buf,
4906 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004907{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004908 const unsigned char *p = buf;
4909 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004910 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004912#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004913 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004914#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004915
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004916 /*
4917 * The context should have been freshly setup or reset.
4918 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004919 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004920 * renegotiating, or if the user mistakenly loaded a session first.)
4921 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4923 ssl->session != NULL) {
4924 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004925 }
4926
4927 /*
4928 * We can't check that the config matches the initial one, but we can at
4929 * least check it matches the requirements for serializing.
4930 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004931 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004932#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004933 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004934#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004935 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4936 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4937 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4938 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004940 }
4941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004943
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004944 /*
4945 * Check version identifier
4946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4948 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004949 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004950
4951 if (memcmp(p, ssl_serialized_context_header,
4952 sizeof(ssl_serialized_context_header)) != 0) {
4953 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4954 }
4955 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004956
4957 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004958 * Session
4959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if ((size_t) (end - p) < 4) {
4961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4962 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004963
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004964 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004965 p += 4;
4966
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004967 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004968 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004969 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004970 ssl->session_in = ssl->session;
4971 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004972 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004973
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if ((size_t) (end - p) < session_len) {
4975 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4976 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 ret = ssl_session_load(ssl->session, 1, p, session_len);
4979 if (ret != 0) {
4980 mbedtls_ssl_session_free(ssl->session);
4981 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004982 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004983
4984 p += session_len;
4985
4986 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004987 * Transform
4988 */
4989
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004990 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004991 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004992#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004993 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004994 ssl->transform_in = ssl->transform;
4995 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004996 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004997#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004998
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5001 if (prf_func == NULL) {
5002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5003 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005004
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005005 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5008 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 ret = ssl_tls12_populate_transform(ssl->transform,
5011 ssl->session->ciphersuite,
5012 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005013#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005015#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 prf_func,
5017 p, /* currently pointing to randbytes */
5018 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5019 ssl->conf->endpoint,
5020 ssl);
5021 if (ret != 0) {
5022 return ret;
5023 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005024#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005026
5027#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5028 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if ((size_t) (end - p) < 1) {
5030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5031 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005032
5033 ssl->transform->in_cid_len = *p++;
5034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5036 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5037 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005040 p += ssl->transform->in_cid_len;
5041
5042 ssl->transform->out_cid_len = *p++;
5043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5046 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005049 p += ssl->transform->out_cid_len;
5050#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5051
5052 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005053 * Saved fields from top-level ssl_context structure
5054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if ((size_t) (end - p) < 4) {
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5057 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005058
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005059 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005060 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005061
5062#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if ((size_t) (end - p) < 16) {
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5065 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005067 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005068 p += 8;
5069
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005070 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005071 p += 8;
5072#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5073
5074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 if ((size_t) (end - p) < 1) {
5076 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5077 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005078
5079 ssl->disable_datagram_packing = *p++;
5080#endif /* MBEDTLS_SSL_PROTO_DTLS */
5081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5084 }
5085 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5086 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005087
5088#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if ((size_t) (end - p) < 2) {
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5091 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005092
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005093 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005094 p += 2;
5095#endif /* MBEDTLS_SSL_PROTO_DTLS */
5096
5097#if defined(MBEDTLS_SSL_ALPN)
5098 {
5099 uint8_t alpn_len;
5100 const char **cur;
5101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if ((size_t) (end - p) < 1) {
5103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5104 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005105
5106 alpn_len = *p++;
5107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005109 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5111 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005112 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005113 ssl->alpn_chosen = *cur;
5114 break;
5115 }
5116 }
5117 }
5118
5119 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5122 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005123
5124 p += alpn_len;
5125 }
5126#endif /* MBEDTLS_SSL_ALPN */
5127
5128 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005129 * Forced fields from top-level ssl_context structure
5130 *
5131 * Most of them already set to the correct value by mbedtls_ssl_init() and
5132 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5133 */
5134 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005135 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005136
Hanno Becker361b10d2019-08-30 10:42:49 +01005137 /* Adjust pointers for header fields of outgoing records to
5138 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005140
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005141#if defined(MBEDTLS_SSL_PROTO_DTLS)
5142 ssl->in_epoch = 1;
5143#endif
5144
5145 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5146 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005147 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5148 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if (ssl->handshake != NULL) {
5150 mbedtls_ssl_handshake_free(ssl);
5151 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005152 ssl->handshake = NULL;
5153 }
5154
5155 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005156 * Done - should have consumed entire buffer
5157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 if (p != end) {
5159 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5160 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005163}
5164
5165/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005166 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005168int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5169 const unsigned char *buf,
5170 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005171{
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 if (ret != 0) {
5175 mbedtls_ssl_free(context);
5176 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005177
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005179}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005180#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005181
5182/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005183 * Free an SSL context
5184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005185void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005186{
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005188 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005194#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5195 size_t out_buf_len = ssl->out_buf_len;
5196#else
5197 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5198#endif
5199
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005200 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005201 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005202 }
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005205#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5206 size_t in_buf_len = ssl->in_buf_len;
5207#else
5208 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5209#endif
5210
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005211 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005212 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005213 }
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (ssl->transform) {
5216 mbedtls_ssl_transform_free(ssl->transform);
5217 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005218 }
5219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 if (ssl->handshake) {
5221 mbedtls_ssl_handshake_free(ssl);
5222 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005223
5224#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5226 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005227#endif
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 mbedtls_ssl_session_free(ssl->session_negotiate);
5230 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005231 }
5232
Ronald Cron6f135e12021-12-08 16:57:54 +01005233#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 mbedtls_ssl_transform_free(ssl->transform_application);
5235 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005236#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005237
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 if (ssl->session) {
5239 mbedtls_ssl_session_free(ssl->session);
5240 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005241 }
5242
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005243#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005245 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005246 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005247#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005248
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005249#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005251#endif
5252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005254
Paul Bakker86f04f42013-02-14 11:20:09 +01005255 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005257}
5258
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005259/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005260 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005262void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005263{
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005265}
5266
Gilles Peskineae270bf2021-06-02 00:05:29 +02005267/* The selection should be the same as mbedtls_x509_crt_profile_default in
5268 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005269 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005270 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005271 * about this list.
5272 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005273static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005274#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005275 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005276#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005277#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005278 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005279#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005280#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005281 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005282#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005283#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005284 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005285#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005286#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005287 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005288#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005289#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005290 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005291#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005292#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005293 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005294#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005295#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005296 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005297#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005298#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005299 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5300 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5301 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5302 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5303 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5304#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005305 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005306};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005307
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005308static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005309 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5310 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5311 0
5312};
5313
Ronald Crone68ab4f2022-10-05 12:46:29 +02005314#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005315
Jerry Yu909df7b2022-01-22 11:56:27 +08005316/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005317 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005318 * rules SHOULD be upheld.
5319 * - No duplicate entries.
5320 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005321 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005322 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005323 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005324static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005325
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005326#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005327 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005328 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005329 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005330 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5331#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005332
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005333#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005334 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005335 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005336 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005337 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5338#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005339
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005340#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005341 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005342 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005343 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005344 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5345#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005346
Gabor Mezeic15ef932024-06-13 12:53:54 +02005347#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005348 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005349#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005350
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005351#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005352 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005353#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005354
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005355#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005356 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005357#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005358
Gabor Mezeic15ef932024-06-13 12:53:54 +02005359#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005360 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005361#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005362
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005363#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005364 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005365#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005366
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005367#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005368 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005369#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005370
Gabor Mezei15b95a62022-05-09 16:37:58 +02005371 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005372};
5373
5374/* NOTICE: see above */
5375#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5376static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005377
Gabor Mezeic15ef932024-06-13 12:53:54 +02005378#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005379#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005381#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005382#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5383 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005384#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005385#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005387#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005388#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005389
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005390#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005391#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005393#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005394#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5395 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005396#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005397#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005399#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005400#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005401
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005402#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005403#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005405#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005406#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5407 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005408#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005409#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005411#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005412#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005413
Gabor Mezei15b95a62022-05-09 16:37:58 +02005414 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005415};
5416#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005417
Jerry Yu909df7b2022-01-22 11:56:27 +08005418/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005419static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005420
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005421#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005422 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005423 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005424 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005425 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5426#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005427
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005428#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005429 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005430 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005431 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005432 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5433#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005434
Gabor Mezei15b95a62022-05-09 16:37:58 +02005435 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005436};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005437
Jerry Yu909df7b2022-01-22 11:56:27 +08005438/* NOTICE: see above */
5439#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5440static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005441
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005442#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005443#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005445#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005446#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005447
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005448#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005449#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005451#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005452#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005453
Gabor Mezei15b95a62022-05-09 16:37:58 +02005454 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005455};
Jerry Yu909df7b2022-01-22 11:56:27 +08005456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5457
Ronald Crone68ab4f2022-10-05 12:46:29 +02005458#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005459
Chien Wong4e9683e2023-12-28 17:07:43 +08005460static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005461#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005462 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005463#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005464#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005465 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005466#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005467 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005468};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005469
Ronald Crone68ab4f2022-10-05 12:46:29 +02005470#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005471/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005472 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005473MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005474static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005475{
5476 size_t i, j;
5477 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5480 for (j = 0; j < i; j++) {
5481 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005482 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 }
5484 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5485 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5486 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005487 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005488 }
5489 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005491}
5492
Ronald Crone68ab4f2022-10-05 12:46:29 +02005493#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005494
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005495/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005496 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5499 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005500{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005501#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5503 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5504 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005505 }
5506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5508 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5509 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005510 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005511
5512#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5514 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5515 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005516 }
5517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5519 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5520 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005521 }
5522#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005523#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005524
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005525 /* Use the functions here so that they are covered in tests,
5526 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 mbedtls_ssl_conf_endpoint(conf, endpoint);
5528 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005529
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005530 /*
5531 * Things that are common to all presets
5532 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005533#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005535 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5536#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5537 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5538#endif
5539 }
5540#endif
5541
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005542#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5543 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5544#endif
5545
5546#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5547 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5548#endif
5549
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005550#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005551 conf->f_cookie_write = ssl_cookie_write_dummy;
5552 conf->f_cookie_check = ssl_cookie_check_dummy;
5553#endif
5554
5555#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5556 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5557#endif
5558
Janos Follath088ce432017-04-10 12:42:31 +01005559#if defined(MBEDTLS_SSL_SRV_C)
5560 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005561 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005562#endif
5563
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005564#if defined(MBEDTLS_SSL_PROTO_DTLS)
5565 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5566 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5567#endif
5568
5569#if defined(MBEDTLS_SSL_RENEGOTIATION)
5570 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 memset(conf->renego_period, 0x00, 2);
5572 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005573#endif
5574
Ronald Cron6f135e12021-12-08 16:57:54 +01005575#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005576
5577#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005578 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005579#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005580 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005581#endif
5582#endif /* MBEDTLS_SSL_EARLY_DATA */
5583
Jerry Yud0766ec2022-09-22 10:46:57 +08005584#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005585 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005586 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005587#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005588 /*
5589 * Allow all TLS 1.3 key exchange modes by default.
5590 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005591 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005592#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005593
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005595#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005596 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005597 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005598#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005602#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005603 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5604 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005605#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5606 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5607 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5608#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5609 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5610 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5611#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005613#endif
5614 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005615
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005616 /*
5617 * Preset-specific defaults
5618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005620 /*
5621 * NSA Suite B
5622 */
5623 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005624
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005625 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005626
5627#if defined(MBEDTLS_X509_CRT_PARSE_C)
5628 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005629#endif
5630
Ronald Crone68ab4f2022-10-05 12:46:29 +02005631#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005632#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005634 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005636#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005638#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005639
Brett Warrene0edc842021-08-17 09:53:13 +01005640 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005641 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005642
5643 /*
5644 * Default
5645 */
5646 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005647
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005648 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005649
5650#if defined(MBEDTLS_X509_CRT_PARSE_C)
5651 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5652#endif
5653
Ronald Crone68ab4f2022-10-05 12:46:29 +02005654#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005655#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005657 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005659#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005661#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005662
Brett Warrene0edc842021-08-17 09:53:13 +01005663 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005664 }
5665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005667}
5668
5669/*
5670 * Free mbedtls_ssl_config
5671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005673{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005674 if (conf == NULL) {
5675 return;
5676 }
5677
Ronald Cron73fe8df2022-10-05 14:31:43 +02005678#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005680 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5681 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005683 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005684 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005685 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005686 }
5687
Gilles Peskine449bd832023-01-11 14:50:10 +01005688 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005689 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005690 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005691 conf->psk_identity_len = 0;
5692 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005693#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005694
5695#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005697#endif
5698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005700}
5701
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005702#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005703 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005704/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005706 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005707unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005708{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005709#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5711 return MBEDTLS_SSL_SIG_RSA;
5712 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005713#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005714#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5716 return MBEDTLS_SSL_SIG_ECDSA;
5717 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005718#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005720}
5721
Gilles Peskine449bd832023-01-11 14:50:10 +01005722unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005723{
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005725 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005727 case MBEDTLS_PK_ECDSA:
5728 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005730 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005732 }
5733}
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005736{
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738#if defined(MBEDTLS_RSA_C)
5739 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005741#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005742#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005743 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005745#endif
5746 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005748 }
5749}
Valerio Settie9646ec2023-08-02 20:02:28 +02005750#endif /* MBEDTLS_PK_C &&
5751 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005752
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005753/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005754 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005756mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005757{
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005759#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005762#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005763#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005764 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005766#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005767#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005770#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005771#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005774#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005775#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005778#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005779#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005782#endif
5783 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005785 }
5786}
5787
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005788/*
5789 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005791unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005792{
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005794#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005795 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005797#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005798#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005799 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005801#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005802#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005805#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005806#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005807 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005809#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005810#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005811 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005813#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005814#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005815 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005817#endif
5818 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005820 }
5821}
5822
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005823/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005824 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005825 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005827int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005828{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005829 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005830
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 if (group_list == NULL) {
5832 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005833 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005834
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 for (; *group_list != 0; group_list++) {
5836 if (*group_list == tls_id) {
5837 return 0;
5838 }
5839 }
5840
5841 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005842}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005843
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005844#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005845/*
5846 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5847 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005848int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005849{
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005853 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005857}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005858#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005859
Valerio Setti18c9fed2022-12-30 17:44:24 +01005860static const struct {
5861 uint16_t tls_id;
5862 mbedtls_ecp_group_id ecp_group_id;
5863 psa_ecc_family_t psa_family;
5864 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005865} tls_id_match_table[] =
5866{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005867#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005868 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005869#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005870#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005871 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005872#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005873#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005874 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005875#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005876#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005877 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005878#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005879#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005880 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005881#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005882#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005883 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005884#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005885#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005886 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005887#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005888#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005889 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005890#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005891#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005892 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005893#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005894#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005895 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005896#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005897#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005898 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005899#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005900#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005901 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005902#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005903 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904};
5905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005907 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005909{
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5911 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005912 if (type != NULL) {
5913 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005914 }
5915 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005916 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005917 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005918 return PSA_SUCCESS;
5919 }
5920 }
5921
5922 return PSA_ERROR_NOT_SUPPORTED;
5923}
5924
Gilles Peskine449bd832023-01-11 14:50:10 +01005925mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005926{
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5928 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005929 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005930 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005931 }
5932
5933 return MBEDTLS_ECP_DP_NONE;
5934}
5935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005937{
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5939 i++) {
5940 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005941 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005943 }
5944
5945 return 0;
5946}
5947
Valerio Setti67419f02023-01-04 16:12:42 +01005948#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005949static const struct {
5950 uint16_t tls_id;
5951 const char *name;
5952} tls_id_curve_name_table[] =
5953{
Valerio Setti54e23792023-07-07 10:49:27 +02005954 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5955 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5956 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5957 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5958 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5959 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5960 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5961 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5962 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5963 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5964 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5965 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5966 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005967 { 0, NULL },
5968};
5969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005971{
Valerio Settiacd32c02023-06-29 18:06:29 +02005972 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5973 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5974 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005976 }
5977
5978 return NULL;
5979}
Valerio Setti67419f02023-01-04 16:12:42 +01005980#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5983 const mbedtls_md_type_t md,
5984 unsigned char *dst,
5985 size_t dst_len,
5986 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005987{
Ronald Cronf6893e12022-01-07 22:09:01 +01005988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5989 psa_hash_operation_t *hash_operation_to_clone;
5990 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5991
Jerry Yu148165c2021-09-24 23:20:59 +08005992 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005995#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 case MBEDTLS_MD_SHA384:
5997 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5998 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005999#endif
6000
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006001#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 case MBEDTLS_MD_SHA256:
6003 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6004 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006005#endif
6006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 default:
6008 goto exit;
6009 }
6010
6011 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6012 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006013 goto exit;
6014 }
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6017 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006020
6021exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006022#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006023 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006024 (void) ssl;
6025#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006026 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006027}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006028
Ronald Crone68ab4f2022-10-05 12:46:29 +02006029#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006030/* mbedtls_ssl_parse_sig_alg_ext()
6031 *
6032 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6033 * value (TLS 1.3 RFC8446):
6034 * enum {
6035 * ....
6036 * ecdsa_secp256r1_sha256( 0x0403 ),
6037 * ecdsa_secp384r1_sha384( 0x0503 ),
6038 * ecdsa_secp521r1_sha512( 0x0603 ),
6039 * ....
6040 * } SignatureScheme;
6041 *
6042 * struct {
6043 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6044 * } SignatureSchemeList;
6045 *
6046 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6047 * value (TLS 1.2 RFC5246):
6048 * enum {
6049 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6050 * sha512(6), (255)
6051 * } HashAlgorithm;
6052 *
6053 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6054 * SignatureAlgorithm;
6055 *
6056 * struct {
6057 * HashAlgorithm hash;
6058 * SignatureAlgorithm signature;
6059 * } SignatureAndHashAlgorithm;
6060 *
6061 * SignatureAndHashAlgorithm
6062 * supported_signature_algorithms<2..2^16-2>;
6063 *
6064 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6065 * generalization of the TLS 1.2 signature algorithm extension.
6066 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6067 * `SignatureScheme` field of TLS 1.3
6068 *
6069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006070int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6071 const unsigned char *buf,
6072 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006073{
6074 const unsigned char *p = buf;
6075 size_t supported_sig_algs_len = 0;
6076 const unsigned char *supported_sig_algs_end;
6077 uint16_t sig_alg;
6078 uint32_t common_idx = 0;
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6081 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006082 p += 2;
6083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 memset(ssl->handshake->received_sig_algs, 0,
6085 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006088 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 while (p < supported_sig_algs_end) {
6090 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6091 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006092 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6094 sig_alg,
6095 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006096#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6098 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6099 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006100 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006101 }
6102#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006103
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6105 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006108 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6109 common_idx += 1;
6110 }
6111 }
6112 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (p != end) {
6114 MBEDTLS_SSL_DEBUG_MSG(1,
6115 ("Signature algorithms extension length misaligned"));
6116 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6117 MBEDTLS_ERR_SSL_DECODE_ERROR);
6118 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006119 }
6120
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (common_idx == 0) {
6122 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6123 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6124 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6125 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006126 }
6127
Gabor Mezei15b95a62022-05-09 16:37:58 +02006128 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006130}
6131
Ronald Crone68ab4f2022-10-05 12:46:29 +02006132#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006133
Jerry Yudc7bd172022-02-17 13:44:15 +08006134#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6135
Jerry Yudc7bd172022-02-17 13:44:15 +08006136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6138 mbedtls_svc_key_id_t key,
6139 psa_algorithm_t alg,
6140 const unsigned char *raw_psk, size_t raw_psk_length,
6141 const unsigned char *seed, size_t seed_length,
6142 const unsigned char *label, size_t label_length,
6143 const unsigned char *other_secret,
6144 size_t other_secret_length,
6145 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006146{
6147 psa_status_t status;
6148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 status = psa_key_derivation_setup(derivation, alg);
6150 if (status != PSA_SUCCESS) {
6151 return status;
6152 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006153
Gilles Peskine449bd832023-01-11 14:50:10 +01006154 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6155 status = psa_key_derivation_input_bytes(derivation,
6156 PSA_KEY_DERIVATION_INPUT_SEED,
6157 seed, seed_length);
6158 if (status != PSA_SUCCESS) {
6159 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006160 }
6161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 if (other_secret != NULL) {
6163 status = psa_key_derivation_input_bytes(derivation,
6164 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6165 other_secret, other_secret_length);
6166 if (status != PSA_SUCCESS) {
6167 return status;
6168 }
6169 }
6170
6171 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006172 status = psa_key_derivation_input_bytes(
6173 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 raw_psk, raw_psk_length);
6175 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006176 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006178 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 if (status != PSA_SUCCESS) {
6180 return status;
6181 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 status = psa_key_derivation_input_bytes(derivation,
6184 PSA_KEY_DERIVATION_INPUT_LABEL,
6185 label, label_length);
6186 if (status != PSA_SUCCESS) {
6187 return status;
6188 }
6189 } else {
6190 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006191 }
6192
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 status = psa_key_derivation_set_capacity(derivation, capacity);
6194 if (status != PSA_SUCCESS) {
6195 return status;
6196 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006199}
6200
Andrzej Kurek57d10632022-10-24 10:32:01 -04006201#if defined(PSA_WANT_ALG_SHA_384) || \
6202 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006203MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006204static int tls_prf_generic(mbedtls_md_type_t md_type,
6205 const unsigned char *secret, size_t slen,
6206 const char *label,
6207 const unsigned char *random, size_t rlen,
6208 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006209{
6210 psa_status_t status;
6211 psa_algorithm_t alg;
6212 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6213 psa_key_derivation_operation_t derivation =
6214 PSA_KEY_DERIVATION_OPERATION_INIT;
6215
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006217 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006219 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006221
6222 /* Normally a "secret" should be long enough to be impossible to
6223 * find by brute force, and in particular should not be empty. But
6224 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6225 * and for this use case it makes sense to have a 0-length "secret".
6226 * Since the key API doesn't allow importing a key of length 0,
6227 * keep master_key=0, which setup_psa_key_derivation() understands
6228 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006230 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6232 psa_set_key_algorithm(&key_attributes, alg);
6233 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006234
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6236 if (status != PSA_SUCCESS) {
6237 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6238 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006239 }
6240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 status = setup_psa_key_derivation(&derivation,
6242 master_key, alg,
6243 NULL, 0,
6244 random, rlen,
6245 (unsigned char const *) label,
6246 (size_t) strlen(label),
6247 NULL, 0,
6248 dlen);
6249 if (status != PSA_SUCCESS) {
6250 psa_key_derivation_abort(&derivation);
6251 psa_destroy_key(master_key);
6252 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006253 }
6254
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6256 if (status != PSA_SUCCESS) {
6257 psa_key_derivation_abort(&derivation);
6258 psa_destroy_key(master_key);
6259 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006260 }
6261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 status = psa_key_derivation_abort(&derivation);
6263 if (status != PSA_SUCCESS) {
6264 psa_destroy_key(master_key);
6265 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006266 }
6267
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 if (!mbedtls_svc_key_id_is_null(master_key)) {
6269 status = psa_destroy_key(master_key);
6270 }
6271 if (status != PSA_SUCCESS) {
6272 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6273 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006276}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006277#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006278
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006279#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006281static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6282 const char *label,
6283 const unsigned char *random, size_t rlen,
6284 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006285{
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6287 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006288}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006289#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006291#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006293static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6294 const char *label,
6295 const unsigned char *random, size_t rlen,
6296 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006297{
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6299 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006300}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006301#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006302
Jerry Yuf009d862022-02-17 14:01:37 +08006303/*
6304 * Set appropriate PRF function and other SSL / TLS1.2 functions
6305 *
6306 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006307 * - hash associated with the ciphersuite (only used by TLS 1.2)
6308 *
6309 * Outputs:
6310 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6311 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006312MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006313static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6314 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006315{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006316#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006318 handshake->tls_prf = tls_prf_sha384;
6319 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6320 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006322#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006323#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006324 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006325 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006326 handshake->tls_prf = tls_prf_sha256;
6327 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6328 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6329 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006330#else
Jerry Yuf009d862022-02-17 14:01:37 +08006331 {
Jerry Yuf009d862022-02-17 14:01:37 +08006332 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006333 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006335 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006336#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006339}
Jerry Yud6ab2352022-02-17 14:03:43 +08006340
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006341/*
6342 * Compute master secret if needed
6343 *
6344 * Parameters:
6345 * [in/out] handshake
6346 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6347 * (PSA-PSK) ciphersuite_info, psk_opaque
6348 * [out] premaster (cleared)
6349 * [out] master
6350 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6351 * debug: conf->f_dbg, conf->p_dbg
6352 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006353 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006354 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006355MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006356static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6357 unsigned char *master,
6358 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006359{
6360 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6361
6362 /* cf. RFC 5246, Section 8.1:
6363 * "The master secret is always exactly 48 bytes in length." */
6364 size_t const master_secret_len = 48;
6365
6366#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6367 unsigned char session_hash[48];
6368#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6369
6370 /* The label for the KDF used for key expansion.
6371 * This is either "master secret" or "extended master secret"
6372 * depending on whether the Extended Master Secret extension
6373 * is used. */
6374 char const *lbl = "master secret";
6375
Przemek Stekielae4ed302022-04-05 17:15:55 +02006376 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006377 * - If the Extended Master Secret extension is not used,
6378 * this is ClientHello.Random + ServerHello.Random
6379 * (see Sect. 8.1 in RFC 5246).
6380 * - If the Extended Master Secret extension is used,
6381 * this is the transcript of the handshake so far.
6382 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006383 unsigned char const *seed = handshake->randbytes;
6384 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385
6386#if !defined(MBEDTLS_DEBUG_C) && \
6387 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006388 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006389 ssl = NULL; /* make sure we don't use it except for those cases */
6390 (void) ssl;
6391#endif
6392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if (handshake->resume != 0) {
6394 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6395 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396 }
6397
6398#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006401 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006402 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6403 if (ret != 0) {
6404 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6405 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006406
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6408 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006410#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006412#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414 /* Perform PSK-to-MS expansion in a single step. */
6415 psa_status_t status;
6416 psa_algorithm_t alg;
6417 mbedtls_svc_key_id_t psk;
6418 psa_key_derivation_operation_t derivation =
6419 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006420 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006432 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006436 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006437 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006438 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006439 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006440 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6441 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6442 other_secret = handshake->premaster + 2;
6443 break;
6444 default:
6445 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006446 }
6447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 status = setup_psa_key_derivation(&derivation, psk, alg,
6449 ssl->conf->psk, ssl->conf->psk_len,
6450 seed, seed_len,
6451 (unsigned char const *) lbl,
6452 (size_t) strlen(lbl),
6453 other_secret, other_secret_len,
6454 master_secret_len);
6455 if (status != PSA_SUCCESS) {
6456 psa_key_derivation_abort(&derivation);
6457 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006458 }
6459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 status = psa_key_derivation_output_bytes(&derivation,
6461 master,
6462 master_secret_len);
6463 if (status != PSA_SUCCESS) {
6464 psa_key_derivation_abort(&derivation);
6465 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466 }
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 status = psa_key_derivation_abort(&derivation);
6469 if (status != PSA_SUCCESS) {
6470 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6471 }
6472 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006473#endif
6474 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006475#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006477 psa_status_t status;
6478 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6479 psa_key_derivation_operation_t derivation =
6480 PSA_KEY_DERIVATION_OPERATION_INIT;
6481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006483
6484 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 status = psa_key_derivation_setup(&derivation, alg);
6487 if (status != PSA_SUCCESS) {
6488 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006489 }
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 status = psa_key_derivation_set_capacity(&derivation,
6492 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6493 if (status != PSA_SUCCESS) {
6494 psa_key_derivation_abort(&derivation);
6495 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006496 }
6497
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6499 &derivation);
6500 if (status != PSA_SUCCESS) {
6501 psa_key_derivation_abort(&derivation);
6502 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006503 }
6504
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 status = psa_key_derivation_output_bytes(&derivation,
6506 handshake->premaster,
6507 handshake->pmslen);
6508 if (status != PSA_SUCCESS) {
6509 psa_key_derivation_abort(&derivation);
6510 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6511 }
6512
6513 status = psa_key_derivation_abort(&derivation);
6514 if (status != PSA_SUCCESS) {
6515 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006516 }
6517 }
6518#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6520 lbl, seed, seed_len,
6521 master,
6522 master_secret_len);
6523 if (ret != 0) {
6524 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6525 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006526 }
6527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6529 handshake->premaster,
6530 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 mbedtls_platform_zeroize(handshake->premaster,
6533 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534 }
6535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006537}
6538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006540{
6541 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6542 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6543 ssl->handshake->ciphersuite_info;
6544
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006546
6547 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006549 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 if (ret != 0) {
6551 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6552 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006553 }
6554
6555 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 ret = ssl_compute_master(ssl->handshake,
6557 ssl->session_negotiate->master,
6558 ssl);
6559 if (ret != 0) {
6560 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6561 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006562 }
6563
6564 /* Swap the client and server random values:
6565 * - MS derivation wanted client+server (RFC 5246 8.1)
6566 * - key derivation wants server+client (RFC 5246 6.3) */
6567 {
6568 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 memcpy(tmp, ssl->handshake->randbytes, 64);
6570 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6571 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6572 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006573 }
6574
6575 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6577 ssl->session_negotiate->ciphersuite,
6578 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006579#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006581#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 ssl->handshake->tls_prf,
6583 ssl->handshake->randbytes,
6584 ssl->tls_version,
6585 ssl->conf->endpoint,
6586 ssl);
6587 if (ret != 0) {
6588 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6589 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006590 }
6591
6592 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6594 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006597
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006599}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006600
Gilles Peskine449bd832023-01-11 14:50:10 +01006601int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006602{
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006604#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006605 case MBEDTLS_SSL_HASH_SHA384:
6606 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6607 break;
6608#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006609#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006610 case MBEDTLS_SSL_HASH_SHA256:
6611 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6612 break;
6613#endif
6614 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006616 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006617#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006618 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006619 (void) ssl;
6620#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006622}
6623
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006624static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6625 const psa_hash_operation_t *hs_op,
6626 size_t buffer_size,
6627 unsigned char *hash,
6628 size_t *hlen)
6629{
6630 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006631 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006632
6633#if !defined(MBEDTLS_DEBUG_C)
6634 (void) ssl;
6635#endif
6636 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006637 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006638 if (status != PSA_SUCCESS) {
6639 goto exit;
6640 }
6641
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006642 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006643 if (status != PSA_SUCCESS) {
6644 goto exit;
6645 }
6646
6647 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6648 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6649
6650exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006651 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006652 return mbedtls_md_error_from_psa(status);
6653}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006654
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006655#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006656int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6657 unsigned char *hash,
6658 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006659{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006660 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6661 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006662}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006663#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006664
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006665#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006666int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6667 unsigned char *hash,
6668 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006669{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006670 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6671 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006672}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006673#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006674
Jerry Yuc2c673d2022-02-17 14:20:39 +08006675#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006676MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006677static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006678
6679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006680int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006681{
6682 /* If renegotiation is not enforced, retransmit until we would reach max
6683 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006685 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6686 unsigned char doublings = 1;
6687
Gilles Peskine449bd832023-01-11 14:50:10 +01006688 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006689 ++doublings;
6690 ratio >>= 1;
6691 }
6692
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 if (++ssl->renego_records_seen > doublings) {
6694 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6695 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006696 }
6697 }
6698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006700}
6701#endif
6702#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006703
Jerry Yud9526692022-02-17 14:23:47 +08006704/*
6705 * Handshake functions
6706 */
6707#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6708/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006709int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006710{
6711 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6712 ssl->handshake->ciphersuite_info;
6713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006715
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6717 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006718 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006720 }
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6723 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006724}
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006727{
6728 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6729 ssl->handshake->ciphersuite_info;
6730
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6734 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006735 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006737 }
6738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6740 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006741}
6742
6743#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6744/* Some certificate support -> implement write and parse */
6745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006747{
6748 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6749 size_t i, n;
6750 const mbedtls_x509_crt *crt;
6751 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6752 ssl->handshake->ciphersuite_info;
6753
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006755
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6757 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006758 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006760 }
6761
6762#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6764 if (ssl->handshake->client_auth == 0) {
6765 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006766 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006768 }
6769 }
6770#endif /* MBEDTLS_SSL_CLI_C */
6771#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6773 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006774 /* Should never happen because we shouldn't have picked the
6775 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006777 }
6778 }
6779#endif
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006782
6783 /*
6784 * 0 . 0 handshake type
6785 * 1 . 3 handshake length
6786 * 4 . 6 length of all certs
6787 * 7 . 9 length of cert. 1
6788 * 10 . n-1 peer certificate
6789 * n . n+2 length of cert. 2
6790 * n+3 . ... upper level cert, etc.
6791 */
6792 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006794
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006796 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6798 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6799 " > %" MBEDTLS_PRINTF_SIZET,
6800 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6801 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006802 }
6803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6805 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6806 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006809 i += n; crt = crt->next;
6810 }
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6813 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6814 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006815
6816 ssl->out_msglen = i;
6817 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6818 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6819
6820 ssl->state++;
6821
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6823 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6824 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006825 }
6826
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006830}
6831
6832#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6833
6834#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006836static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6837 unsigned char *crt_buf,
6838 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006839{
6840 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (peer_crt == NULL) {
6843 return -1;
6844 }
Jerry Yud9526692022-02-17 14:23:47 +08006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 if (peer_crt->raw.len != crt_buf_len) {
6847 return -1;
6848 }
Jerry Yud9526692022-02-17 14:23:47 +08006849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006851}
6852#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006853MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006854static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6855 unsigned char *crt_buf,
6856 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006857{
6858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6859 unsigned char const * const peer_cert_digest =
6860 ssl->session->peer_cert_digest;
6861 mbedtls_md_type_t const peer_cert_digest_type =
6862 ssl->session->peer_cert_digest_type;
6863 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006865 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6866 size_t digest_len;
6867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 if (peer_cert_digest == NULL || digest_info == NULL) {
6869 return -1;
6870 }
Jerry Yud9526692022-02-17 14:23:47 +08006871
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 digest_len = mbedtls_md_get_size(digest_info);
6873 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6874 return -1;
6875 }
Jerry Yud9526692022-02-17 14:23:47 +08006876
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6878 if (ret != 0) {
6879 return -1;
6880 }
Jerry Yud9526692022-02-17 14:23:47 +08006881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006883}
6884#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6885#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6886
6887/*
6888 * Once the certificate message is read, parse it into a cert chain and
6889 * perform basic checks, but leave actual verification to the caller
6890 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006891MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006892static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6893 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006894{
6895 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6896#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006897 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006898#endif
6899 size_t i, n;
6900 uint8_t alert;
6901
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6903 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6904 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6905 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6906 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006907 }
6908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6910 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6911 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6912 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006913 }
6914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6916 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6917 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6918 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6919 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006920 }
6921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006923
6924 /*
6925 * Same message structure as in mbedtls_ssl_write_certificate()
6926 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006927 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006928
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (ssl->in_msg[i] != 0 ||
6930 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6931 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6932 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6933 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6934 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006935 }
6936
6937 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6938 i += 3;
6939
6940 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006942 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 if (i + 3 > ssl->in_hslen) {
6944 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6945 mbedtls_ssl_send_alert_message(ssl,
6946 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6947 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6948 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006949 }
6950 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6951 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 if (ssl->in_msg[i] != 0) {
6953 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6954 mbedtls_ssl_send_alert_message(ssl,
6955 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6956 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6957 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006958 }
6959
6960 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006961 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006962 i += 3;
6963
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (n < 128 || i + n > ssl->in_hslen) {
6965 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6966 mbedtls_ssl_send_alert_message(ssl,
6967 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6968 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6969 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006970 }
6971
6972 /* Check if we're handling the first CRT in the chain. */
6973#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006975 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006977 /* During client-side renegotiation, check that the server's
6978 * end-CRTs hasn't changed compared to the initial handshake,
6979 * mitigating the triple handshake attack. On success, reuse
6980 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006981 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6982 if (ssl_check_peer_crt_unchanged(ssl,
6983 &ssl->in_msg[i],
6984 n) != 0) {
6985 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6986 mbedtls_ssl_send_alert_message(ssl,
6987 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6988 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6989 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006990 }
6991
6992 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006994 }
6995#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6996
6997 /* Parse the next certificate in the chain. */
6998#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007000#else
7001 /* If we don't need to store the CRT chain permanently, parse
7002 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007004#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007006 case 0: /*ok*/
Gilles Peskinea7e14dc2024-09-16 13:10:11 +02007007 case MBEDTLS_ERR_OID_NOT_FOUND:
Jerry Yud9526692022-02-17 14:23:47 +08007008 /* Ignore certificate with an unknown algorithm: maybe a
7009 prior certificate was already trusted. */
7010 break;
7011
7012 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7013 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7014 goto crt_parse_der_failed;
7015
7016 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7017 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7018 goto crt_parse_der_failed;
7019
7020 default:
7021 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007022crt_parse_der_failed:
7023 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7024 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7025 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007026 }
7027
7028 i += n;
7029 }
7030
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7032 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007033}
7034
7035#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007036MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007037static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007038{
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7040 return -1;
7041 }
Jerry Yud9526692022-02-17 14:23:47 +08007042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007044 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7045 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7047 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7048 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007049 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007051}
7052#endif /* MBEDTLS_SSL_SRV_C */
7053
7054/* Check if a certificate message is expected.
7055 * Return either
7056 * - SSL_CERTIFICATE_EXPECTED, or
7057 * - SSL_CERTIFICATE_SKIP
7058 * indicating whether a Certificate message is expected or not.
7059 */
7060#define SSL_CERTIFICATE_EXPECTED 0
7061#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007062MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007063static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7064 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007065{
7066 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7067 ssl->handshake->ciphersuite_info;
7068
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7070 return SSL_CERTIFICATE_SKIP;
7071 }
Jerry Yud9526692022-02-17 14:23:47 +08007072
7073#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007076 ssl->session_negotiate->verify_result =
7077 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007079 }
7080 }
7081#else
7082 ((void) authmode);
7083#endif /* MBEDTLS_SSL_SRV_C */
7084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007086}
7087
Jerry Yud9526692022-02-17 14:23:47 +08007088#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007089MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007090static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7091 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007092{
7093 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7094 /* Remember digest of the peer's end-CRT. */
7095 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7097 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7098 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7099 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7100 mbedtls_ssl_send_alert_message(ssl,
7101 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7102 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007103
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007105 }
7106
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 ret = mbedtls_md(mbedtls_md_info_from_type(
7108 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7109 start, len,
7110 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007111
7112 ssl->session_negotiate->peer_cert_digest_type =
7113 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7114 ssl->session_negotiate->peer_cert_digest_len =
7115 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007118}
7119
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007121static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7122 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007123{
7124 unsigned char *end = start + len;
7125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7126
7127 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7129 ret = mbedtls_pk_parse_subpubkey(&start, end,
7130 &ssl->handshake->peer_pubkey);
7131 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007132 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007134 }
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007137}
7138#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7139
Gilles Peskine449bd832023-01-11 14:50:10 +01007140int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007141{
7142 int ret = 0;
7143 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007144 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007145#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7146 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7147 ? ssl->handshake->sni_authmode
7148 : ssl->conf->authmode;
7149#else
7150 const int authmode = ssl->conf->authmode;
7151#endif
7152 void *rs_ctx = NULL;
7153 mbedtls_x509_crt *chain = NULL;
7154
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007156
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7158 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7159 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007160 goto exit;
7161 }
7162
7163#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007164 if (ssl->handshake->ecrs_enabled &&
7165 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007166 chain = ssl->handshake->ecrs_peer_cert;
7167 ssl->handshake->ecrs_peer_cert = NULL;
7168 goto crt_verify;
7169 }
7170#endif
7171
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007173 /* mbedtls_ssl_read_record may have sent an alert already. We
7174 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007176 goto exit;
7177 }
7178
7179#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007181 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007184 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 }
Jerry Yud9526692022-02-17 14:23:47 +08007186
7187 goto exit;
7188 }
7189#endif /* MBEDTLS_SSL_SRV_C */
7190
7191 /* Clear existing peer CRT structure in case we tried to
7192 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7196 if (chain == NULL) {
7197 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7198 sizeof(mbedtls_x509_crt)));
7199 mbedtls_ssl_send_alert_message(ssl,
7200 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7201 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007202
7203 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7204 goto exit;
7205 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 ret = ssl_parse_certificate_chain(ssl, chain);
7209 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 }
Jerry Yud9526692022-02-17 14:23:47 +08007212
7213#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007215 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 }
Jerry Yud9526692022-02-17 14:23:47 +08007217
7218crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007220 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007221 }
Jerry Yud9526692022-02-17 14:23:47 +08007222#endif
7223
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007224 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7225 ssl->handshake->ciphersuite_info,
7226 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 }
Jerry Yud9526692022-02-17 14:23:47 +08007230
7231#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7232 {
7233 unsigned char *crt_start, *pk_start;
7234 size_t crt_len, pk_len;
7235
7236 /* We parse the CRT chain without copying, so
7237 * these pointers point into the input buffer,
7238 * and are hence still valid after freeing the
7239 * CRT chain. */
7240
7241 crt_start = chain->raw.p;
7242 crt_len = chain->raw.len;
7243
7244 pk_start = chain->pk_raw.p;
7245 pk_len = chain->pk_raw.len;
7246
7247 /* Free the CRT structures before computing
7248 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 mbedtls_x509_crt_free(chain);
7250 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007251 chain = NULL;
7252
Gilles Peskine449bd832023-01-11 14:50:10 +01007253 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_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
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7259 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 }
Jerry Yud9526692022-02-17 14:23:47 +08007262 }
7263#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7264 /* Pass ownership to session structure. */
7265 ssl->session_negotiate->peer_cert = chain;
7266 chain = NULL;
7267#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007270
7271exit:
7272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007274 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 }
Jerry Yud9526692022-02-17 14:23:47 +08007276
7277#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007279 ssl->handshake->ecrs_peer_cert = chain;
7280 chain = NULL;
7281 }
7282#endif
7283
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (chain != NULL) {
7285 mbedtls_x509_crt_free(chain);
7286 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007287 }
7288
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007290}
7291#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7292
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007293static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7294 unsigned char *padbuf, size_t hlen,
7295 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007296{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007297 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007298 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007299 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007300 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007301 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007302 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007303
7304 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007306 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007310 ? "client finished"
7311 : "server finished";
7312
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007313 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007314
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007315 status = psa_hash_clone(hs_op, &cloned_op);
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 }
7319
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007320 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007322 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007323 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007324 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007325
7326 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7327
Jerry Yu615bd6f2022-02-17 14:25:15 +08007328 /*
7329 * TLSv1.2:
7330 * hash = PRF( master, finished_label,
7331 * Hash( handshake ) )[0.11]
7332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007334 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007335
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007337
Paul Elliottecb95be2023-08-11 16:41:04 +01007338 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007339
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007340 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007341
7342exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007343 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007344 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007345}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007346
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007347#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007348static int ssl_calc_finished_tls_sha256(
7349 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7350{
7351 unsigned char padbuf[32];
7352 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007353 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007354 padbuf, sizeof(padbuf),
7355 buf, from);
7356}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007357#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007358
Jerry Yub7ba49e2022-02-17 14:25:53 +08007359
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007360#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007361static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007363{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007364 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007365 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007366 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007367 padbuf, sizeof(padbuf),
7368 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007369}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007370#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007371
Gilles Peskine449bd832023-01-11 14:50:10 +01007372void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007373{
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007375
7376 /*
7377 * Free our handshake params
7378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 mbedtls_ssl_handshake_free(ssl);
7380 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007381 ssl->handshake = NULL;
7382
7383 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007384 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if (ssl->transform) {
7387 mbedtls_ssl_transform_free(ssl->transform);
7388 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007389 }
7390 ssl->transform = ssl->transform_negotiate;
7391 ssl->transform_negotiate = NULL;
7392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007394}
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007397{
7398 int resume = ssl->handshake->resume;
7399
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007401
7402#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007403 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007404 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7405 ssl->renego_records_seen = 0;
7406 }
7407#endif
7408
7409 /*
7410 * Free the previous session and switch in the current one
7411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007413#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7414 /* RFC 7366 3.1: keep the EtM state */
7415 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007417#endif
7418
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 mbedtls_ssl_session_free(ssl->session);
7420 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007421 }
7422 ssl->session = ssl->session_negotiate;
7423 ssl->session_negotiate = NULL;
7424
7425 /*
7426 * Add cache entry
7427 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007429 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 resume == 0) {
7431 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7432 ssl->session->id,
7433 ssl->session->id_len,
7434 ssl->session) != 0) {
7435 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7436 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007437 }
7438
7439#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7441 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007442 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007444
7445 /* Keep last flight around in case we need to resend it:
7446 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7448 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007449#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007451
Jerry Yu5ed73ff2022-10-27 13:08:42 +08007452 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007453
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007455}
7456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007458{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007459 int ret;
7460 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007465
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007466 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7467 if (ret != 0) {
7468 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7469 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007470
7471 /*
7472 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7473 * may define some other value. Currently (early 2016), no defined
7474 * ciphersuite does this (and this is unlikely to change as activity has
7475 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7476 */
7477 hash_len = 12;
7478
7479#if defined(MBEDTLS_SSL_RENEGOTIATION)
7480 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007482#endif
7483
7484 ssl->out_msglen = 4 + hash_len;
7485 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7486 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7487
7488 /*
7489 * In case of session resuming, invert the client and server
7490 * ChangeCipherSpec messages order.
7491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007493#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007495 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007497#endif
7498#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007500 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007502#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007504 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007506
7507 /*
7508 * Switch to our negotiated transform and session parameters for outbound
7509 * data.
7510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007512
7513#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007515 unsigned char i;
7516
7517 /* Remember current epoch settings for resending */
7518 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7520 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007521
7522 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007524
7525
7526 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 for (i = 2; i > 0; i--) {
7528 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007529 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 }
7531 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007532
7533 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 if (i == 0) {
7535 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7536 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007537 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007539#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007541
7542 ssl->transform_out = ssl->transform_negotiate;
7543 ssl->session_out = ssl->session_negotiate;
7544
7545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7547 mbedtls_ssl_send_flight_completed(ssl);
7548 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007549#endif
7550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7552 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7553 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007554 }
7555
7556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7558 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7559 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7560 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007561 }
7562#endif
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007567}
7568
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007569#define SSL_MAX_HASH_LEN 12
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007572{
7573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7574 unsigned int hash_len = 12;
7575 unsigned char buf[SSL_MAX_HASH_LEN];
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007578
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007579 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7580 if (ret != 0) {
7581 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
7582 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7585 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007586 goto exit;
7587 }
7588
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7590 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7591 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7592 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007593 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7594 goto exit;
7595 }
7596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7598 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7599 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007600 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7601 goto exit;
7602 }
7603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7605 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7606 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7607 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007608 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7609 goto exit;
7610 }
7611
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7613 buf, hash_len) != 0) {
7614 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7615 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7616 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007617 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7618 goto exit;
7619 }
7620
7621#if defined(MBEDTLS_SSL_RENEGOTIATION)
7622 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007624#endif
7625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007627#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007629 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007631#endif
7632#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007634 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007636#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007638 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007640
7641#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7643 mbedtls_ssl_recv_flight_completed(ssl);
7644 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007645#endif
7646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007648
7649exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 mbedtls_platform_zeroize(buf, hash_len);
7651 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007652}
7653
Jerry Yu392112c2022-02-17 14:34:10 +08007654#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7655/*
7656 * Helper to get TLS 1.2 PRF from ciphersuite
7657 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007659static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007660{
Jerry Yu392112c2022-02-17 14:34:10 +08007661 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007663#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7665 return tls_prf_sha384;
7666 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007667#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007668#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007669 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7671 return tls_prf_sha256;
7672 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007673 }
7674#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007675#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007676 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007677 (void) ciphersuite_info;
7678#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007681}
7682#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007683
Gilles Peskine449bd832023-01-11 14:50:10 +01007684static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007685{
7686 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007687#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007688 if (tls_prf == tls_prf_sha384) {
7689 return MBEDTLS_SSL_TLS_PRF_SHA384;
7690 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007691#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007692#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 if (tls_prf == tls_prf_sha256) {
7694 return MBEDTLS_SSL_TLS_PRF_SHA256;
7695 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007696#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007698}
7699
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007700/*
7701 * Populate a transform structure with session keys and all the other
7702 * necessary information.
7703 *
7704 * Parameters:
7705 * - [in/out]: transform: structure to populate
7706 * [in] must be just initialised with mbedtls_ssl_transform_init()
7707 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7708 * - [in] ciphersuite
7709 * - [in] master
7710 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007711 * - [in] tls_prf: pointer to PRF to use for key derivation
7712 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007713 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007714 * - [in] endpoint: client or server
7715 * - [in] ssl: used for:
7716 * - ssl->conf->{f,p}_export_keys
7717 * [in] optionally used for:
7718 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7719 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007720MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007721static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7722 int ciphersuite,
7723 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007724#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007726#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 ssl_tls_prf_t tls_prf,
7728 const unsigned char randbytes[64],
7729 mbedtls_ssl_protocol_version tls_version,
7730 unsigned endpoint,
7731 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007732{
7733 int ret = 0;
7734 unsigned char keyblk[256];
7735 unsigned char *key1;
7736 unsigned char *key2;
7737 unsigned char *mac_enc;
7738 unsigned char *mac_dec;
7739 size_t mac_key_len = 0;
7740 size_t iv_copy_len;
7741 size_t keylen;
7742 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007743 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007744
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007745 psa_key_type_t key_type;
7746 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7747 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007748 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007749 size_t key_bits;
7750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007751
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007752 /*
7753 * Some data just needs copying into the structure
7754 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007755#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007756 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007757#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007758 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007759
7760#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007762#endif
7763
7764#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007766 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7767 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007769 }
7770#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7771
7772 /*
7773 * Get various info structures
7774 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7776 if (ciphersuite_info == NULL) {
7777 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7778 ciphersuite));
7779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007780 }
7781
Neil Armstrongab555e02022-04-04 11:07:59 +02007782 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007783#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007785#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007787
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007789 transform->taglen =
7790 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007791 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007792
Dave Rodgman2eab4622023-10-05 13:30:37 +01007793 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 transform->taglen,
7795 &alg,
7796 &key_type,
7797 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007798 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007800 goto end;
7801 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007802
Dave Rodgman2eab4622023-10-05 13:30:37 +01007803 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007805 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 (unsigned) ciphersuite_info->mac));
7807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007808 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007809
7810#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7811 /* Copy own and peer's CID if the use of the CID
7812 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7814 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007815
7816 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7818 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7819 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007820
7821 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7823 ssl->handshake->peer_cid_len);
7824 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7825 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007826 }
7827#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7828
7829 /*
7830 * Compute key block using the PRF
7831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7833 if (ret != 0) {
7834 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7835 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007836 }
7837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7839 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7840 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7841 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7842 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007843
7844 /*
7845 * Determine the appropriate key, IV and MAC length.
7846 */
7847
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007848 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007849
Valerio Settie5707042023-10-11 11:54:42 +02007850#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007852 size_t explicit_ivlen;
7853
7854 transform->maclen = 0;
7855 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007856
7857 /* All modes haves 96-bit IVs, but the length of the static parts vary
7858 * with mode and version:
7859 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7860 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7861 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7862 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7863 * sequence number).
7864 */
7865 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007866
7867 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007869
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007871 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007873 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007875
7876 /* Minimum length of encrypted record */
7877 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7878 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 } else
Valerio Settie5707042023-10-11 11:54:42 +02007880#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007881#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007883 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007886
Neil Armstronge4512952022-03-08 09:08:22 +01007887 /* Get MAC length */
7888 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007889 transform->maclen = mac_key_len;
7890
7891 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007893
7894 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007896 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007898 /*
7899 * GenericBlockCipher:
7900 * 1. if EtM is in use: one block plus MAC
7901 * otherwise: * first multiple of blocklen greater than maclen
7902 * 2. IV
7903 */
7904#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007906 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 + block_size;
7908 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909#endif
7910 {
7911 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 + block_size
7913 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007914 }
7915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007917 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 } else {
7919 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007920 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7921 goto end;
7922 }
7923 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007925#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7926 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7928 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007929 }
7930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7932 (unsigned) keylen,
7933 (unsigned) transform->minlen,
7934 (unsigned) transform->ivlen,
7935 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007936
7937 /*
7938 * Finally setup the cipher contexts, IVs and MAC secrets.
7939 */
7940#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007942 key1 = keyblk + mac_key_len * 2;
7943 key2 = keyblk + mac_key_len * 2 + keylen;
7944
7945 mac_enc = keyblk;
7946 mac_dec = keyblk + mac_key_len;
7947
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 iv_copy_len = (transform->fixed_ivlen) ?
7949 transform->fixed_ivlen : transform->ivlen;
7950 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7951 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7952 iv_copy_len);
7953 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007954#endif /* MBEDTLS_SSL_CLI_C */
7955#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007957 key1 = keyblk + mac_key_len * 2 + keylen;
7958 key2 = keyblk + mac_key_len * 2;
7959
7960 mac_enc = keyblk + mac_key_len;
7961 mac_dec = keyblk;
7962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 iv_copy_len = (transform->fixed_ivlen) ?
7964 transform->fixed_ivlen : transform->ivlen;
7965 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7966 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7967 iv_copy_len);
7968 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007969#endif /* MBEDTLS_SSL_SRV_C */
7970 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007971 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007972 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7973 goto end;
7974 }
7975
Paul Elliott4fb19552023-10-18 12:15:30 +01007976 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 ssl->f_export_keys(ssl->p_export_keys,
7978 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7979 master, 48,
7980 randbytes + 32,
7981 randbytes,
7982 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007983 }
7984
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007985 transform->psa_alg = alg;
7986
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7988 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7989 psa_set_key_algorithm(&attributes, alg);
7990 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007991
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 if ((status = psa_import_key(&attributes,
7993 key1,
7994 PSA_BITS_TO_BYTES(key_bits),
7995 &transform->psa_key_enc)) != PSA_SUCCESS) {
7996 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007997 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007999 goto end;
8000 }
8001
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 if ((status = psa_import_key(&attributes,
8005 key2,
8006 PSA_BITS_TO_BYTES(key_bits),
8007 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008008 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008010 goto end;
8011 }
8012 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008013
Neil Armstrong29c0c042022-03-17 17:47:28 +01008014#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8015 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8016 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8021 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8022 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008023
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if ((status = psa_import_key(&attributes,
8025 mac_enc, mac_key_len,
8026 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008027 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008029 goto end;
8030 }
8031
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8033 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008034#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008036#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008038 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008039 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8040 PSA_KEY_USAGE_VERIFY_HASH);
8041 } else {
8042 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8043 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if ((status = psa_import_key(&attributes,
8046 mac_dec, mac_key_len,
8047 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008048 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008050 goto end;
8051 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008052 }
8053#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8054
8055 ((void) mac_dec);
8056 ((void) mac_enc);
8057
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008058end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8060 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008061}
8062
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008063#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008064int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 psa_pake_operation_t *pake_ctx,
8066 const unsigned char *buf,
8067 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008068{
8069 psa_status_t status;
8070 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008071 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008072 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8073 * At round two perform a single cycle
8074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008076
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 for (; remaining_steps > 0; remaining_steps--) {
8078 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008079 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008081 /* Length is stored at the first byte */
8082 size_t length = buf[input_offset];
8083 input_offset += 1;
8084
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008086 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8087 }
8088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 status = psa_pake_input(pake_ctx, step,
8090 buf + input_offset, length);
8091 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008092 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008093 }
8094
8095 input_offset += length;
8096 }
8097 }
8098
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008100 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008102
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008104}
8105
Valerio Setti6b3dab02022-11-17 17:14:54 +01008106int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 psa_pake_operation_t *pake_ctx,
8108 unsigned char *buf,
8109 size_t len, size_t *olen,
8110 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008111{
8112 psa_status_t status;
8113 size_t output_offset = 0;
8114 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008115 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008116 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8117 * At round two perform a single cycle
8118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008120
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 for (; remaining_steps > 0; remaining_steps--) {
8122 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8123 step <= PSA_PAKE_STEP_ZK_PROOF;
8124 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008125 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008126 * For each step, prepend 1 byte with the length of the data as
8127 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 status = psa_pake_output(pake_ctx, step,
8130 buf + output_offset + 1,
8131 len - output_offset - 1,
8132 &output_len);
8133 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008134 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008135 }
8136
Valerio Setti99d88c12022-11-22 16:03:43 +01008137 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008138
8139 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008140 }
8141 }
8142
8143 *olen = output_offset;
8144
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008146}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008147#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8150 unsigned char *hash, size_t *hashlen,
8151 unsigned char *data, size_t data_len,
8152 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008153{
8154 psa_status_t status;
8155 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008156 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 if ((status = psa_hash_setup(&hash_operation,
8161 hash_alg)) != PSA_SUCCESS) {
8162 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008163 goto exit;
8164 }
8165
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8167 64)) != PSA_SUCCESS) {
8168 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008169 goto exit;
8170 }
8171
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 if ((status = psa_hash_update(&hash_operation,
8173 data, data_len)) != PSA_SUCCESS) {
8174 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008175 goto exit;
8176 }
8177
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8179 hashlen)) != PSA_SUCCESS) {
8180 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8181 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008182 }
8183
8184exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 if (status != PSA_SUCCESS) {
8186 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8187 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8188 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008189 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008191 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8192 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008194 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008196 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008197 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008198 }
8199 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008201}
8202
Jerry Yuee40f9d2022-02-17 14:55:16 +08008203
Jerry Yud9d91da2022-02-17 14:57:06 +08008204#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8205
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008206/* Find the preferred hash for a given signature algorithm. */
8207unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 mbedtls_ssl_context *ssl,
8209 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008210{
Gabor Mezei078e8032022-04-27 21:17:56 +02008211 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008212 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008213
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8215 return MBEDTLS_SSL_HASH_NONE;
8216 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008217
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008219 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8221 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008222 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008223 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8224 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008225
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008226 mbedtls_md_type_t md_alg =
8227 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8228 if (md_alg == MBEDTLS_MD_NONE) {
8229 continue;
8230 }
8231
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008234 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008235 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008236
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8238 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8239 PSA_ALG_ECDSA(psa_hash_alg),
8240 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008241 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008243
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8245 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8246 PSA_ALG_RSA_PKCS1V15_SIGN(
8247 psa_hash_alg),
8248 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008249 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008251 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008252
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008254 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008255 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008256
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008258}
8259
8260#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8261
Jerry Yudc7bd172022-02-17 13:44:15 +08008262#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8263
XiaokangQian75d40ef2022-04-20 11:05:24 +00008264int mbedtls_ssl_validate_ciphersuite(
8265 const mbedtls_ssl_context *ssl,
8266 const mbedtls_ssl_ciphersuite_t *suite_info,
8267 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008268 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008269{
8270 (void) ssl;
8271
Gilles Peskine449bd832023-01-11 14:50:10 +01008272 if (suite_info == NULL) {
8273 return -1;
8274 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008275
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 if ((suite_info->min_tls_version > max_tls_version) ||
8277 (suite_info->max_tls_version < min_tls_version)) {
8278 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008279 }
8280
XiaokangQian060d8672022-04-21 09:24:56 +00008281#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008282#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008284 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008286 }
8287#endif
8288
8289 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8290#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008291 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8292 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8293 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008294 }
8295#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8296#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8297
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008299}
8300
Ronald Crone68ab4f2022-10-05 12:46:29 +02008301#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008302/*
8303 * Function for writing a signature algorithm extension.
8304 *
8305 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8306 * value (TLS 1.3 RFC8446):
8307 * enum {
8308 * ....
8309 * ecdsa_secp256r1_sha256( 0x0403 ),
8310 * ecdsa_secp384r1_sha384( 0x0503 ),
8311 * ecdsa_secp521r1_sha512( 0x0603 ),
8312 * ....
8313 * } SignatureScheme;
8314 *
8315 * struct {
8316 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8317 * } SignatureSchemeList;
8318 *
8319 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8320 * value (TLS 1.2 RFC5246):
8321 * enum {
8322 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8323 * sha512(6), (255)
8324 * } HashAlgorithm;
8325 *
8326 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8327 * SignatureAlgorithm;
8328 *
8329 * struct {
8330 * HashAlgorithm hash;
8331 * SignatureAlgorithm signature;
8332 * } SignatureAndHashAlgorithm;
8333 *
8334 * SignatureAndHashAlgorithm
8335 * supported_signature_algorithms<2..2^16-2>;
8336 *
8337 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8338 * generalization of the TLS 1.2 signature algorithm extension.
8339 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8340 * `SignatureScheme` field of TLS 1.3
8341 *
8342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008343int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8344 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008345{
8346 unsigned char *p = buf;
8347 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8348 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8349
8350 *out_len = 0;
8351
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008353
8354 /* Check if we have space for header and length field:
8355 * - extension_type (2 bytes)
8356 * - extension_data_length (2 bytes)
8357 * - supported_signature_algorithms_length (2 bytes)
8358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008360 p += 6;
8361
8362 /*
8363 * Write supported_signature_algorithms
8364 */
8365 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8367 if (sig_alg == NULL) {
8368 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8369 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008370
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8372 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8373 *sig_alg,
8374 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8375 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008376 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008377 }
8378 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8379 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008380 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8382 *sig_alg,
8383 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008384 }
8385
8386 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008387 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 if (supported_sig_alg_len == 0) {
8389 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8390 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008391 }
8392
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8394 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8395 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008396
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008397 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008398
8399#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008400 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008401#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008402
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008404}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008405#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008406
XiaokangQian40a35232022-05-07 09:02:40 +00008407#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008408/*
8409 * mbedtls_ssl_parse_server_name_ext
8410 *
8411 * Structure of server_name extension:
8412 *
8413 * enum {
8414 * host_name(0), (255)
8415 * } NameType;
8416 * opaque HostName<1..2^16-1>;
8417 *
8418 * struct {
8419 * NameType name_type;
8420 * select (name_type) {
8421 * case host_name: HostName;
8422 * } name;
8423 * } ServerName;
8424 * struct {
8425 * ServerName server_name_list<1..2^16-1>
8426 * } ServerNameList;
8427 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008429int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8430 const unsigned char *buf,
8431 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008432{
8433 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8434 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008435 size_t server_name_list_len, hostname_len;
8436 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008437
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8441 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008442 p += 2;
8443
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008445 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008446 while (p < server_name_list_end) {
8447 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8448 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8449 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8450 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008453 /* sni_name is intended to be used only during the parsing of the
8454 * ClientHello message (it is reset to NULL before the end of
8455 * the message parsing). Thus it is ok to just point to the
8456 * reception buffer and not make a copy of it.
8457 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008458 ssl->handshake->sni_name = p + 3;
8459 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 if (ssl->conf->f_sni == NULL) {
8461 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008462 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8464 ssl, p + 3, hostname_len);
8465 if (ret != 0) {
8466 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8467 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8468 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8469 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8470 }
8471 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008472 }
8473
8474 p += hostname_len + 3;
8475 }
8476
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008478}
8479#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8480
XiaokangQianacb39922022-06-17 10:18:48 +00008481#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008483int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8484 const unsigned char *buf,
8485 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008486{
8487 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008488 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008489 const unsigned char *protocol_name_list;
8490 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008491 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008492
8493 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if (ssl->conf->alpn_list == NULL) {
8495 return 0;
8496 }
XiaokangQianacb39922022-06-17 10:18:48 +00008497
8498 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008499 * RFC7301, section 3.1
8500 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008501 *
XiaokangQianc7403452022-06-23 03:24:12 +00008502 * struct {
8503 * ProtocolName protocol_name_list<2..2^16-1>
8504 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008505 */
8506
XiaokangQianc7403452022-06-23 03:24:12 +00008507 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008508 * protocol_name_list_len 2 bytes
8509 * protocol_name_len 1 bytes
8510 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008513
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008515 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008517 protocol_name_list = p;
8518 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008519
8520 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008522 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8524 protocol_name_len);
8525 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008526 MBEDTLS_SSL_PEND_FATAL_ALERT(
8527 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8529 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008530 }
8531
8532 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008533 }
8534
8535 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8537 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008538 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008540 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 if (protocol_name_len == alpn_len &&
8542 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008543 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008545 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008546
8547 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008548 }
8549 }
8550
XiaokangQian95d5f542022-06-24 02:29:26 +00008551 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008552 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8554 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8555 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008556}
8557
Gilles Peskine449bd832023-01-11 14:50:10 +01008558int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8559 unsigned char *buf,
8560 unsigned char *end,
8561 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008562{
8563 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008564 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008565 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008566
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 if (ssl->alpn_chosen == NULL) {
8568 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008569 }
8570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571 protocol_name_len = strlen(ssl->alpn_chosen);
8572 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008573
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008575 /*
8576 * 0 . 1 ext identifier
8577 * 2 . 3 ext length
8578 * 4 . 5 protocol list length
8579 * 6 . 6 protocol name length
8580 * 7 . 7+n protocol name
8581 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008582 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008583
XiaokangQian95d5f542022-06-24 02:29:26 +00008584 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008585
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8587 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008588 /* Note: the length of the chosen protocol has been checked to be less
8589 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008592
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008594
8595#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008597#endif
8598
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008600}
8601#endif /* MBEDTLS_SSL_ALPN */
8602
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008603#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008604 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008605 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008606 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008607int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8608 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008609{
8610 /* Initialize to suppress unnecessary compiler warning */
8611 size_t hostname_len = 0;
8612
8613 /* Check if new hostname is valid before
8614 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 if (hostname != NULL) {
8616 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008617
Gilles Peskine449bd832023-01-11 14:50:10 +01008618 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8620 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008621 }
8622
8623 /* Now it's clear that we will overwrite the old hostname,
8624 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008626 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008628 }
8629
8630 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008632 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 } else {
8634 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8635 if (session->hostname == NULL) {
8636 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8637 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008638
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008640 }
8641
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008643}
Xiaokang Qian03409292022-10-12 02:49:52 +00008644#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8645 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008646 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008647 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008648
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008649#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8650 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008651int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8652 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008653{
8654 size_t alpn_len = 0;
8655
8656 if (alpn != NULL) {
8657 alpn_len = strlen(alpn);
8658
8659 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8660 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8661 }
8662 }
8663
8664 if (session->ticket_alpn != NULL) {
8665 mbedtls_zeroize_and_free(session->ticket_alpn,
8666 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008667 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008668 }
8669
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008670 if (alpn != NULL) {
8671 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008672 if (session->ticket_alpn == NULL) {
8673 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8674 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008675 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008676 }
8677
8678 return 0;
8679}
8680#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008681
8682/*
8683 * The following functions are used by 1.2 and 1.3, client and server.
8684 */
8685#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8686int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8687 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8688 int recv_endpoint,
8689 mbedtls_ssl_protocol_version tls_version,
8690 uint32_t *flags)
8691{
8692 int ret = 0;
8693 unsigned int usage = 0;
8694 const char *ext_oid;
8695 size_t ext_len;
8696
8697 /*
8698 * keyUsage
8699 */
8700
8701 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8702 * to check what a compliant client will think while choosing which cert
8703 * to send to the client. */
8704#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8705 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8706 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8707 /* TLS 1.2 server part of the key exchange */
8708 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008709 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8710 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8711 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8712 break;
8713
8714 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8715 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8716 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8717 break;
8718
8719 /* Don't use default: we want warnings when adding new values */
8720 case MBEDTLS_KEY_EXCHANGE_NONE:
8721 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008722 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8723 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8724 usage = 0;
8725 }
8726 } else
8727#endif
8728 {
8729 /* This is either TLS 1.3 authentication, which always uses signatures,
8730 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8731 * options we implement, both using signatures. */
8732 (void) tls_version;
8733 (void) ciphersuite;
8734 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8735 }
8736
8737 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8738 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8739 ret = -1;
8740 }
8741
8742 /*
8743 * extKeyUsage
8744 */
8745
8746 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8747 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8748 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8749 } else {
8750 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8751 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8752 }
8753
8754 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8755 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8756 ret = -1;
8757 }
8758
8759 return ret;
8760}
8761
8762int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8763 int authmode,
8764 mbedtls_x509_crt *chain,
8765 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8766 void *rs_ctx)
8767{
8768 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8769 return 0;
8770 }
8771
8772 /*
8773 * Primary check: use the appropriate X.509 verification function
8774 */
8775 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8776 void *p_vrfy;
8777 if (ssl->f_vrfy != NULL) {
8778 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8779 f_vrfy = ssl->f_vrfy;
8780 p_vrfy = ssl->p_vrfy;
8781 } else {
8782 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8783 f_vrfy = ssl->conf->f_vrfy;
8784 p_vrfy = ssl->conf->p_vrfy;
8785 }
8786
8787 int ret = 0;
8788 int have_ca_chain_or_callback = 0;
8789#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8790 if (ssl->conf->f_ca_cb != NULL) {
8791 ((void) rs_ctx);
8792 have_ca_chain_or_callback = 1;
8793
8794 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8795 ret = mbedtls_x509_crt_verify_with_ca_cb(
8796 chain,
8797 ssl->conf->f_ca_cb,
8798 ssl->conf->p_ca_cb,
8799 ssl->conf->cert_profile,
8800 ssl->hostname,
8801 &ssl->session_negotiate->verify_result,
8802 f_vrfy, p_vrfy);
8803 } else
8804#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8805 {
8806 mbedtls_x509_crt *ca_chain;
8807 mbedtls_x509_crl *ca_crl;
8808#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8809 if (ssl->handshake->sni_ca_chain != NULL) {
8810 ca_chain = ssl->handshake->sni_ca_chain;
8811 ca_crl = ssl->handshake->sni_ca_crl;
8812 } else
8813#endif
8814 {
8815 ca_chain = ssl->conf->ca_chain;
8816 ca_crl = ssl->conf->ca_crl;
8817 }
8818
8819 if (ca_chain != NULL) {
8820 have_ca_chain_or_callback = 1;
8821 }
8822
8823 ret = mbedtls_x509_crt_verify_restartable(
8824 chain,
8825 ca_chain, ca_crl,
8826 ssl->conf->cert_profile,
8827 ssl->hostname,
8828 &ssl->session_negotiate->verify_result,
8829 f_vrfy, p_vrfy, rs_ctx);
8830 }
8831
8832 if (ret != 0) {
8833 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8834 }
8835
8836#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8837 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8838 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8839 }
8840#endif
8841
8842 /*
8843 * Secondary checks: always done, but change 'ret' only if it was 0
8844 */
8845
8846 /* With TLS 1.2 and ECC certs, check that the curve used by the
8847 * certificate is on our list of acceptable curves.
8848 *
8849 * With TLS 1.3 this is not needed because the curve is part of the
8850 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8851 * we validate the signature made with the key associated to this cert.
8852 */
8853#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8854 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8855 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8856 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8857 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8858 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8859 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8860 if (ret == 0) {
8861 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8862 }
8863 }
8864 }
8865#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8866
8867 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8868 if (mbedtls_ssl_check_cert_usage(chain,
8869 ciphersuite_info,
8870 ssl->conf->endpoint,
8871 ssl->tls_version,
8872 &ssl->session_negotiate->verify_result) != 0) {
8873 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8874 if (ret == 0) {
8875 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8876 }
8877 }
8878
8879 /* With authmode optional, we want to keep going if the certificate was
8880 * unacceptable, but still fail on other errors (out of memory etc),
8881 * including fatal errors from the f_vrfy callback.
8882 *
8883 * The only acceptable errors are:
8884 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8885 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8886 * Anything else is a fatal error. */
8887 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8888 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8889 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8890 ret = 0;
8891 }
8892
8893 /* Return a specific error as this is a user error: inconsistent
8894 * configuration - can't verify without trust anchors. */
8895 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8896 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8897 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8898 }
8899
8900 if (ret != 0) {
8901 uint8_t alert;
8902
8903 /* The certificate may have been rejected for several reasons.
8904 Pick one and send the corresponding alert. Which alert to send
8905 may be a subject of debate in some cases. */
8906 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8907 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8908 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8909 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8910 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8911 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8912 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8913 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8914 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8915 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8916 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8917 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8918 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8919 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8920 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8921 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8922 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8923 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8924 } else {
8925 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8926 }
8927 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8928 alert);
8929 }
8930
8931#if defined(MBEDTLS_DEBUG_C)
8932 if (ssl->session_negotiate->verify_result != 0) {
8933 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8934 (unsigned int) ssl->session_negotiate->verify_result));
8935 } else {
8936 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8937 }
8938#endif /* MBEDTLS_DEBUG_C */
8939
8940 return ret;
8941}
8942#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008944#endif /* MBEDTLS_SSL_TLS_C */